Skip to content

Support 'recommended' fields on a model card schema #2422

@GCHQDeveloper36

Description

@GCHQDeveloper36

Is your feature request related to a problem? Please describe.

Model card schemas define the fields an organisation would like the owners/developers to consider, but there isn't any way to enforce/require/suggest which fields are 'required' vs 'optional'. Therefore when a release is created, and a reviewer considers the card, there might be some key information missing that's needed to make an informed decision.

Describe the solution you would like

Some sort of modification to the schema definitions to allow for annotating fields if they're "required"/"recommended" (wording TBD). I'd imagine that from an end-user perspective, we could highlight "recommended" fields during an edit session, and allow the list of (missing) fields to be seen in a simple list when a collaborator views a model card.

Describe alternatives you have considered

I think jsonschema supports 'required' fields, however when a card is strictly validated, these would get flagged and defeat the point of the living, editable card. Extending the support for jsonschema, or ignoring 'required' fields in a validation response, might be needed.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions