From 4bf84198491ae22fab053b88ad9157c4bb399428 Mon Sep 17 00:00:00 2001 From: Ravi Meijer Date: Mon, 23 Sep 2024 14:46:01 +0200 Subject: [PATCH] Rename Instrument Register to Task Registry --- docs/index.md | 2 +- docs/projects/amt/adrs/0006-extend-system-card-EU-AI-Act.md | 2 +- docs/projects/amt/reporting-standard/0.1a7.md | 4 ++-- docs/projects/amt/reporting-standard/0.1a8.md | 6 +++--- docs/projects/amt/reporting-standard/latest.md | 6 +++--- .../reporting-standard/schemas/assessmentcard_schema.json | 4 ++-- .../amt/reporting-standard/schemas/systemcard_schema.json | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index 75b2f3b7..1c27b96d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ graph TB ak[Algoritmekader] <--> amt subgraph amt[Algorithm Management Toolkit] - ir[Instrument Registry] --> amp[Algorithm Management Platform] + tr[Task Registry] --> amp[Algorithm Management Platform] st[Reporting Standard] --> amp amp <--> llm[LLM Benchmark Tooling] end diff --git a/docs/projects/amt/adrs/0006-extend-system-card-EU-AI-Act.md b/docs/projects/amt/adrs/0006-extend-system-card-EU-AI-Act.md index b3cf4c24..0a3b792d 100644 --- a/docs/projects/amt/adrs/0006-extend-system-card-EU-AI-Act.md +++ b/docs/projects/amt/adrs/0006-extend-system-card-EU-AI-Act.md @@ -27,7 +27,7 @@ because we use a modified model card setup, the performance may be less reliable ## Decision * We include the general description cases of the EU AI Act for high-risk systems into the system card directly. -* We create a separate instrument including the complete technical documentation into the instrument registry. +* We create a separate instrument including the complete technical documentation into the task registry. ## Risks diff --git a/docs/projects/amt/reporting-standard/0.1a7.md b/docs/projects/amt/reporting-standard/0.1a7.md index 6658e539..9826a347 100644 --- a/docs/projects/amt/reporting-standard/0.1a7.md +++ b/docs/projects/amt/reporting-standard/0.1a7.md @@ -300,13 +300,13 @@ An `assessment_card` contains the following information. 4. `author` (OPTIONAL, string). Name of person that initiated the transformations. 2. `name` (REQUIRED, string). The name of the assessment. -3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the instrument register. +3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the task registry. 4. `date` (REQUIRED, string). The date at which the assessment is completed. Date should be given in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, i.e. `YYYY-MM-DD`. 5. `contents` (REQUIRED, list). There can be multiple items in contents. For each item the following fields are present: 1. `question` (REQUIRED, string). A question. - 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the instrument register. + 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the task registry. 3. `answer` (REQUIRED, string). An answer. 4. `remarks` (OPTIONAL, string). A field to put relevant discussion remarks in. 5. `authors` (OPTIONAL, list). There can be multiple names. For each name the following field is present. diff --git a/docs/projects/amt/reporting-standard/0.1a8.md b/docs/projects/amt/reporting-standard/0.1a8.md index e72e6f6b..5719e30e 100644 --- a/docs/projects/amt/reporting-standard/0.1a8.md +++ b/docs/projects/amt/reporting-standard/0.1a8.md @@ -74,7 +74,7 @@ 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. +the [task registry](https://github.com/MinBZK/task-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 @@ -309,13 +309,13 @@ An `assessment_card` contains the following information. 4. `author` (OPTIONAL, string). Name of person that initiated the transformations. 2. `name` (REQUIRED, string). The name of the assessment. -3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the instrument register. +3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the task registry. 4. `date` (REQUIRED, string). The date at which the assessment is completed. Date should be given in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, i.e. `YYYY-MM-DD`. 5. `contents` (REQUIRED, list). There can be multiple items in contents. For each item the following fields are present: 1. `question` (REQUIRED, string). A question. - 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the instrument register. + 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the task registry. 3. `answer` (REQUIRED, string). An answer. 4. `remarks` (OPTIONAL, string). A field to put relevant discussion remarks in. 5. `authors` (OPTIONAL, list). There can be multiple names. For each name the following field is present. diff --git a/docs/projects/amt/reporting-standard/latest.md b/docs/projects/amt/reporting-standard/latest.md index f7aedc6a..0e5294b6 100644 --- a/docs/projects/amt/reporting-standard/latest.md +++ b/docs/projects/amt/reporting-standard/latest.md @@ -74,7 +74,7 @@ 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. +the [task registry](https://github.com/MinBZK/task-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 @@ -311,13 +311,13 @@ An `assessment_card` contains the following information. 4. `author` (OPTIONAL, string). Name of person that initiated the transformations. 2. `name` (REQUIRED, string). The name of the assessment. -3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the instrument register. +3. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the instrument in the task registry. 4. `date` (REQUIRED, string). The date at which the assessment is completed. Date should be given in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, i.e. `YYYY-MM-DD`. 5. `contents` (REQUIRED, list). There can be multiple items in contents. For each item the following fields are present: 1. `question` (REQUIRED, string). A question. - 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the instrument register. + 2. `urn` (OPTIONAL, string). A Uniform Resource Name (URN) of the corresponding task in the task registry. 3. `answer` (REQUIRED, string). An answer. 4. `remarks` (OPTIONAL, string). A field to put relevant discussion remarks in. 5. `authors` (OPTIONAL, list). There can be multiple names. For each name the following field is present. diff --git a/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json b/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json index 740cf32f..3e946eb8 100644 --- a/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json +++ b/docs/projects/amt/reporting-standard/schemas/assessmentcard_schema.json @@ -32,7 +32,7 @@ }, "urn":{ "type": "string", - "description": "A Uniform Resource Name (URN) of the instrument in the instrument register" + "description": "A Uniform Resource Name (URN) of the instrument in the task registry" }, "date":{ "type": "date", @@ -49,7 +49,7 @@ }, "urn":{ "type": "string", - "description": "A Uniform Resource Name (URN) of the corresponding task in the instrument register" + "description": "A Uniform Resource Name (URN) of the corresponding task in the task registry" }, "answer":{ "type": "string", diff --git a/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json b/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json index 7a27beed..aafade29 100644 --- a/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json +++ b/docs/projects/amt/reporting-standard/schemas/systemcard_schema.json @@ -36,7 +36,7 @@ }, "instruments":{ "type": "array", - "description": "List of instruments from the instrument register that must be executed to fill this system card", + "description": "List of instruments from the task registry that must be executed to fill this system card", "items": { "type": "object", "properties":{