Skip to content

Commit

Permalink
Rename Instrument Register to Task Registry (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
laurensWe authored Sep 26, 2024
2 parents c8099f1 + 4bf8419 commit 9aa4c1f
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ graph TB
ak[<a href='https://minbzk.github.io/Algoritmekader/'>Algoritmekader</a>] <--> amt
subgraph amt[Algorithm Management Toolkit]
ir[<a href='https://minbzk.github.io/instrument-registry'>Instrument Registry</a>] --> amp[<a href='https://github.com/MinBZK/amt/'>Algorithm Management Platform</a>]
tr[<a href='https://minbzk.github.io/task-registry'>Task Registry</a>] --> amp[<a href='https://github.com/MinBZK/amt/'>Algorithm Management Platform</a>]
st[<a href='/ai-validation/projects/amt/reporting-standard/'>Reporting Standard</a>] --> amp
amp <--> llm[<a href='/ai-validation/projects/llm-benchmarks/'>LLM Benchmark Tooling</a>]
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/projects/amt/reporting-standard/0.1a7.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/projects/amt/reporting-standard/0.1a8.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/projects/amt/reporting-standard/latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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":{
Expand Down

0 comments on commit 9aa4c1f

Please sign in to comment.