Custom rules

The action performs the model card validation wing a set of rules that follows the Spectral's rulesets conventions. Besides the Spectral core functions, modelcard-action provides a set of functions that simplify most common model card validation tasks.

YAML

Model card validations can be achieved using the YAML ruleset configuration.

rules.yaml

rules:
  legal-version-name:
    message: '{{error}}'
    given: '$.model_details.version.name'
    then:
      function: truthy