Add decision tree field to system card

MinBZK · Sep 25, 2024 · af3592d · af3592d
1 parent c8099f1
commit af3592d
Show file tree

Hide file tree

Showing 7 changed files with 687 additions and 20 deletions.
diff --git a/aivalidation_dictionary.txt b/aivalidation_dictionary.txt
@@ -1,11 +1,13 @@
 # keep this file sorted: sort -u --ignore-case -o aivalidation_dictionary.txt aivalidation_dictionary.txt
 Aanbestedingswet
+aanbieder
 Aangifte
 Aansluitpunt
 adrs
 Aequitas
 aivalidation
 Algemene
+algoritme
 Algoritmekader
 Algoritmeregister
 Anch
@@ -31,6 +33,7 @@ devcontainer
 DICTU
 Digilab
 Digitoegankelijk
+doeleinden
 Drempelvrij
 dtype
 Explainability
@@ -39,19 +42,23 @@ FOIA
 fontawesome
 Forgejo
 Friese
+geen
 gettext
+gebruiksverantwoordelijke
 glightbox
 Granian
 GUI
 Guusje
 Haitsma
 Hanze
 Hartog
+hoog
 HTMX
 HUIDERIA
 IAMA
 ICTU
 identificatienummer
+impactvol
 interpretability
 ITerm
 jsonschema
@@ -70,8 +77,10 @@ mmmd
 modelcard
 multiclass
 nargs
+niet
 NL
 nldesignsystem
+niet
 Noord
 onnx
 Opensource
@@ -93,6 +102,7 @@ Renate
 Rijk
 Rijkshuisstijl
 rijksoverheid
+risico
 Robbert
 robbertbos
 Rouwhof
@@ -110,24 +120,32 @@ Styleguides
 sublicensable
 superfences
 System
+systeem
+systeemrisico
 tabbyml
 Tadema
 tasklist
 templating
 ticketnumber
 Tijd
+toepassing
 toolkits
 TPRM
 traineeship
+transparantieverplichtingen
 twemoji
 Uittenbroek
 uittenbroekrobbert
+uitzonderingsgrond
 unmanaged
 Unported
 VCRPY
+verboden
 VerifyML
+verordening
 Vertrek
 virtualenv
+voor
 WCAG
 webex
 webserver

diff --git a/docs/projects/amt/reporting-standard/0.1a9.md b/docs/projects/amt/reporting-standard/0.1a9.md
diff --git a/docs/projects/amt/reporting-standard/latest.md b/docs/projects/amt/reporting-standard/latest.md
@@ -1,4 +1,4 @@
-# :label: 0.1a9 (Latest)
+# :label: 0.1a10 (Latest)
 
 This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.
 
@@ -74,11 +74,11 @@ A `system_card` contains the following information.
 
 3. `name` (OPTIONAL, string). Name used to describe the system.
 4. `instruments` (OPTIONAL, list). List of instruments from
-the [instrument register](https://github.com/MinBZK/instrument-registry) that must be executed to fill this system card.
-There can be multiple instruments. For each instrument the following fields are present.
+    the [instrument register](https://github.com/MinBZK/instrument-registry) that must be executed to fill this system card.
+    There can be multiple instruments. For each instrument the following fields are present.
 
     1. `urn` (REQUIRED, string). Uniform Resource Names of the instrument. It is required if an instrument object
-    is added.
+        is added.
     2. `version` (OPTIONAL, string). The version of the instrument.
     3. `required` (OPTIONAL, boolean). Specifies whether the instrument is required to be executed or not.
 
@@ -97,15 +97,36 @@ There can be multiple instruments. For each instrument the following fields are
        set.
 
 7. `description` (OPTIONAL, string). A short description of the system.
-8. `labels` (OPTIONAL, list). This fields allows to store meta information about a system. There can be multiple labels.
+8. `ai_act_profile` (OPTIONAL). Information about the system in relation to the EU AI Act.
+    The contents of this field can be retrieved by traversing the AI Act decision tree or can be specified by the user.
+
+    1. `type` (OPTIONAL, enum[string]). The type of the system should be chosen from:
+    `["AI-systeem", "AI-systeem voor algemene doeleinden", "AI-model voor algemene doeleinden", "algoritme", "geen algoritme"]`.
+    2. `open_source` (OPTIONAL, enum[string]). Whether the system is open source or not.
+    Options are `["open-source", "geen open-source"]`.
+    3. `publication_category` (OPTIONAL, enum[string]). The publication category of the system should be chosen from:
+    `["impactvol algoritme", "niet-impactvol algoritme",  "hoog-risico AI",
+    "geen hoog-risico AI", "verboden AI", "uitzonderingsgrond: AI-verordening niet van toepassing"]`.
+    4. `systemic_risk` (OPTIONAL, enum[string]). Whether the AI model is classified as having systemic risk.
+    Options are `["systeemrisico", "geen systeemrisico"]`.
+    5. `transparency_obligations` (OPTIONAL, enum[string]). Whether the system faces transparency obligations.
+    Options are `["transparantieverplichtingen", "geen transparantieverplichtingen"]`.
+    6. `role` (OPTIONAL, enum[string]). The organization’s role in relation to the system.
+    Options are `["aanbieder", "gebruiksverantwoordelijke", "aanbieder + gebruiksverantwoordelijke"]`
+    7. `decision_tree` (OPTIONAL). This field is REQUIRED if the above fields are retrieved by traversing the decision tree.
+
+        1. `version` (REQUIRED, string). The version of the decision tree.
+        2. `path` (REQUIRED). The traversed path through the decision tree.
+            1. `question` (REQUIRED, string). The question id of the question.
+            2. `answer` (REQUIRED, enum[string]). The answer to the question. The only valid values are `yes` or `no`.
+
+9. `labels` (OPTIONAL, list). This field allows to store meta information about a system. There can be multiple labels.
    For each label the following fields are present.
 
     1. `name` (OPTIONAL, string). Name of the label.
     2. `value` (OPTIONAL, string). Value of the label.
 
-9. `status` (OPTIONAL, string). The status of the system. For example the status can be "production".
-10. `publication_category` (OPTIONAL, enum[string]). The publication category of the algorithm should be chosen from
-   `["high_risk", other"]`.
+10. `status` (OPTIONAL, string). The status of the system. For example the status can be "production".
 11. `begin_date` (OPTIONAL, string). The first date the system was used. Date should be given in
     [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, i.e. `YYYY-MM-DD`.
 12. `end_date` (OPTIONAL, string). The last date the system was used. Date should be given in
@@ -352,11 +373,23 @@ owners:
     email: {owner_email}
     role: {owner_role}
 description: {system_description}
+ai_act_profile:
+    type: {system_type}
+    open_source: {open_source}
+    exception_category: {exception_category}
+    publication_category: {publication_category}
+    systemic_risk: {systemic_risk}
+    transparency_obligations: {transparency_obligations}
+    role: {role}
+    decision_tree:
+        version: {decision_tree_version}
+        path:
+         - question: {question_id}
+           answer: {answer}
 labels:
   - name: {label_name}
     value: {label_value}
 status: {system_status}
-publication_category: {system_publication_cat}
 begin_date: {system_begin_date}
 end_date: {system_end_date}
 goal_and_impact: {system_goal_and_impact}
@@ -499,6 +532,7 @@ JSON schemas of the system card, model card and assessment card can be found on
 
 ## Changelog
 
+- 0.1a10: adds ai act profile field to system card
 - 0.1a9: adds name to model card
 - 0.1a8: adds selected instrument urns to system card
 - 0.1a7: adds urn to assessment card

diff --git a/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json b/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json
@@ -13,7 +13,8 @@
                     "description": "Git commit hash of the commit which contains the transformation file used to create this card"
                 },
                 "timestamp":{
-                    "type": "date-time",
+                    "type": "string",
+                    "format": "date-time",
                     "description": "A timestamp of the date, time and timezone of generation of this Assessment Card in ISO 8601 format"
                 },
                 "uri": {

diff --git a/docs/projects/amt/reporting-standard/schemas/modelcard_schema.json b/docs/projects/amt/reporting-standard/schemas/modelcard_schema.json
@@ -27,6 +27,10 @@
                 }
             }
         },
+        "name":{
+            "type": "string",
+            "description": "Name of the model"
+        },
         "language": {
             "type": "array",
             "description": "The natural languages the model supports in ISO 639",

diff --git a/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json b/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json
@@ -17,7 +17,8 @@
                     "description": "Git commit hash of the commit which contains the transformation file used to create this card"
                 },
                 "timestamp":{
-                    "type": "date-time",
+                    "type": "string",
+                    "format": "date-time",
                     "description": "A timestamp of the date, time and timezone of generation of this System Card in ISO 8601 format"
                 },
                 "uri": {
@@ -93,6 +94,96 @@
             "type": "string",
             "description": "A short description of the system"
             },
+        "ai_act_profile": {
+            "type": "object",
+            "properties":{
+                "type":{
+                    "type": "string",
+                    "description": "System type",
+                    "enum": [
+                        "AI-systeem",
+                        "AI-systeem voor algemene doeleinden",
+                        "AI-model voor algemene doeleinden",
+                        "algoritme",
+                        "geen algoritme"
+                    ]
+                },
+                "open_source":{
+                    "type": "string",
+                    "description": "Whether the system is open source or not",
+                    "enum": [
+                        "open-source",
+                        "geen open-source"
+                    ]
+                },
+                "publication_category":{
+                    "type": "string",
+                    "description": "Publication category of the system",
+                    "enum": [
+                        "impactvol algoritme",
+                        "niet-impactvol algoritme",
+                        "hoog-risico AI",
+                        "geen hoog-risico AI",
+                        "verboden AI"
+                    ]
+                },
+                "systemic_risk":{
+                    "type": "string",
+                    "description": "Whether the system is classified as having a systemic risk",
+                    "enum": [
+                        "systeemrisico",
+                        "geen systeemrisico"
+                    ]
+                },
+                "transparency_obligations":{
+                    "type": "string",
+                    "description": "Whether the system faces transparency obligations.",
+                    "enum": [
+                        "transparantieverplichtingen",
+                        "geen transparantieverplichtingen"
+                    ]
+                },
+                "role":{
+                    "type": "string",
+                    "description": "The organizations role in relation to the system.",
+                    "enum": [
+                        "aanbieder",
+                        "gebruiksverantwoordelijke",
+                        "aanbieder + gebruiksverantwoordelijke"
+                    ]
+                },
+                "decision_tree": {
+                    "type": "object",
+                    "properties": {
+                        "version": {
+                            "type": "string",
+                            "description": "The version of the decision tree"
+                            }
+                        },
+                        "path": {
+                            "type": "array",
+                            "description": "The traversed path in the decision tree",
+                            "items": {
+                                "type": "object",
+                                "properties":{
+                                    "question": {
+                                        "type": "string",
+                                        "description": "Question ID"
+                                    },
+                                    "answer":{
+                                        "type": "string",
+                                        "description": "Answer to the question",
+                                        "enum": [
+                                            "Ja",
+                                            "Nee"
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            },
         "labels": {
             "type": "array",
             "description": "Labels to store meta information about the system",
@@ -108,20 +199,11 @@
                   "description": "Value of the label"
                 }
               }
-            }
           },
         "status":{
             "type": "string",
             "description": "Status of the system"
         },
-        "publication_category":{
-            "type": "string",
-            "description": "Publication category of the algorithm",
-            "enum": [
-                "high_risk",
-                "other"
-            ]
-        },
         "begin_date": {
             "type": "date",
             "description": "The first date the system was used, in ISO 8601 format, i.e. YYYY-MM-DD. Left out if not yet in use."
@@ -268,3 +350,4 @@
     },
     "required": ["version"]
 }
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -85,6 +85,7 @@ nav:
       - Reporting Standard:
         - projects/amt/reporting-standard/index.md
         - projects/amt/reporting-standard/latest.md
+        - projects/amt/reporting-standard/0.1a9.md
         - projects/amt/reporting-standard/0.1a8.md
         - projects/amt/reporting-standard/0.1a7.md
         - projects/amt/reporting-standard/0.1a6.md