Changes

.github/workflows/modelcard.yml

@@ -1,12 +1,9 @@
 name: modelcard-test
 
 on:
-  push:
-    branches:
-      - demos/*
   pull_request:
     branches:
-      - main
+      - master
   workflow_dispatch:
 
 jobs:
@@ -19,6 +16,7 @@ jobs:
       - name: Check for model card file
         uses: CompliancePal/modelcard-action@main
         env:
-          MLFLOW_TRACKING_URI: ${{ secrets.MLFLOW_TRACKING_URI }}
+          MLFLOW_TRACKING_URI: ${{secrets.MLFLOW_TRACKING_URI}}
         with:
           modelcard: modelcard.yaml
+          rules: .rules

.rules/functions/semver.js

@@ -0,0 +1,12 @@
+export default (input) => {
+  const versionParts = input.split('.');
+
+  if (versionParts.length != 3 || versionParts.some((part) => isNaN(part))) {
+    return [
+      {
+        message:
+          'Version name must be in format MAJOR.MINOR.PATCH, see semantic versioning (https://semver.org/)',
+      },
+    ];
+  }
+};

.rules/rules.yaml

@@ -0,0 +1,8 @@
+functions: [semver]
+rules:
+  legal-version-name:
+    message: '{{error}}'
+    severity: error
+    given: '$.model_details.version.name'
+    then:
+      function: semver

modelcard.yaml

@@ -1,5 +1,14 @@
 model_details:
   name: Wine prediction
   version:
-    name: 1.0.0
+    name: 0.0.1
     date: 2022-11-03
+  run:
+    type: mlflow
+    id: 35c174ef99c04747b0467aaeabf70773
+  description: |
+    <!-- markdown description of model -->
+    ## Wine quality prediction
+    This model predicts the quality of wine batches based on physicochemical inputs and sensory outputs.
+  references:
+    - reference: http://made-up-exam.ple/