Filling In the Model Card

The model card is the structured documentation that describes your model. It captures information like intended use, training methodology, performance metrics, and known limitations. The questions you see come from the schema you selected when creating the model.

Common questions this page answers:

• How do I fill in a model card?
• How do I add collaborators to a model?
• How do I assign review roles?
• What is the model card version history?
• What are required model status fields?

What is a model card?

A model card serves as the authoritative documentation for a machine learning model. It helps:

• Reviewers evaluate whether the model is fit for purpose
• Consumers understand what the model does and its limitations
• Auditors verify compliance with organisational policies

Filling in the form

The model card form is divided into sections displayed as tabs, where you answer questions defined by the selected schema.

• Required fields are marked and must be completed
• Your progress is saved only when you click Save
• You can return and edit the model card at any time

Each edit creates a new version of the model card. You can view previous versions in the model's version history.

Required by model status fields

Some model cards will require you to fill in specific fields for different points in that model's lifecycle. This helps ensure the structured document is up to date and accurate, for consumers.

To update to a new lifecycle status, select an option in status chips. This will highlight fields required by that status. Fill in all these fields on all pages.

The screenshot above shows the model summary on the model card being updated, as a required field for production.

You can now save the model card and update the state on the model details tab.

Configuring model access

After documenting your model, configure who can access the model and who will review releases and access requests.

1. Open the model and navigate to the Settings tab
2. Select Access from the side menu
3. Use the Add a user or group to the Model access list dropdown to add collaborators
4. Use the Select roles dropdown to choose the roles responsible for reviewing and approving the model
5. Save your changes

The screenshot above shows the model Settings tab with the Access section, where users and groups can be added as collaborators and assigned system roles and review roles.

The selected roles will be notified when the model or its releases require review.

System roles

When adding collaborators, assign one of:

• Owner - Full control over the model
• Contributor - Edit model card, upload files, create releases
• Consumer - Download files and pull images (with approved access request)

Review roles

Assign specific people to each review role required by the schema (e.g. Model Technical Reviewer, Model Senior Responsible Officer). These people will review releases and access requests.

Version history

Every edit to the model card creates a new version that is preserved in the model's history:

1. Open the model page
2. Navigate to the version history
3. Select a previous version to see the model card at that point in time

Related pages

• Creating a Model - Setting up a new model
• Creating a Release - Versioning your model
• Understanding Reviews - The review process
• Roles & Permissions - Detailed role reference