The GOOD Model Checklist

What makes a good model? In general, good Models should be:

  • Generalized

  • Short

  • Legible

  • Strict

These checks either ARE or WILL be added as automated Checks on PRs.

Here’s a passing test on github: ✅

Here’s a failing test on github: ❌

The GOOD Model Checklist

Check your model.describe() decorator:

Check the model’s content:

Check the code:

Check the legibility:

Check for repetition:

Check that your actions are allowed on your model type:

Last updated