Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename TAD references to AMT #174

Merged
merged 2 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,13 @@ build
site
.idea/
.cache


# MacOS
*.DS_Store

# Python
.python-version

# logs
*log.txt
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ 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/tad/'>Algorithm Management Platform</a>]
st[<a href='/ai-validation/projects/tad/reporting-standard/'>Reporting Standard</a>] --> amp
ir[<a href='https://minbzk.github.io/instrument-registry'>Instrument 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
@@ -1,4 +1,4 @@
# TAD-0001 ADRs
# AMT-0001 ADRs

## Context

Expand All @@ -23,7 +23,7 @@ will publish these ADRs publicly to promote transparency and facilitate collabor
Use the template below to add an ADR:

```markdown
# TAD-XXXX Title
# AMT-XXXX Title

## Context

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# TAD-0002 TAD Reporting Standard
# AMT-0002 AMT Reporting Standard

## Context

The TAD Reporting Standard proposes a standardized way of capturing information of ML-models and systems.
The AMT Reporting Standard proposes a standardized way of capturing information of ML-models and systems.

## Assumptions

Expand All @@ -21,7 +21,7 @@ We decided to implement a custom reporting standard. Our reporting standard can
into three elements.

1. System Card, containing information about a group of ML-models which accomplish a specific task.
A System Card can refer to multiple Model Cards, either a Model Card specified by the TAD Reporting
A System Card can refer to multiple Model Cards, either a Model Card specified by the AMT Reporting
Standard, or any other model card. A System Card can refer to multiple Assessment Cards.
2. Model Card, containing information about a specific ML-model.
3. Assessment Card, containing information about a regulatory assessment.
Expand All @@ -33,18 +33,18 @@ extended to allow for:
2. Capturing additional measurements on fairness and bias.
3. Capturing regulatory assessments.

The extension is not strict, meaning that there the TAD Reporting Standard is not a valid Hugging Face
The extension is not strict, meaning that there the AMT Reporting Standard is not a valid Hugging Face
metadata specification. The reason for this is that some fields in the Hugging Face standard are too much
intertwined with the Hugging Face ecosystem and it would not be logical for us to couple our implementation
this tightly to Hugging Face.

## Risks

The TAD Reporting Standard is not fully backwards compatible with the Hugging Face Model Card
The AMT Reporting Standard is not fully backwards compatible with the Hugging Face Model Card
metadata specification. If in the future the Hugging Face Model Card metadata specification becomes
a standard, we might need to revise the TAD standard.
a standard, we might need to revise the AMT standard.

## Consequences

The TAD Reporting Standard allows us to capture relevant information on model performance, bias and fairness
The AMT Reporting Standard allows us to capture relevant information on model performance, bias and fairness
and regulatory assessments in a standardized way.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TAD-0003 Tool for Transparency of Algorithmic Decision making
# AMT-0003 Tool for Managing Algorithms

## Context

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# TAD-0004 Software Stack for TAD
# AMT-0004 Software Stack for AMT

## Context

For building our own TAD solution, we need to choose a software stack. During our earlier
For building our own AMT solution, we need to choose a software stack. During our earlier
POCs and market research, we gathered insight and information on technologies to use
and which not to use.

Expand All @@ -23,10 +23,10 @@ some key requirements are:
We stick to suitable programming languages. As most AI related
tooling is written in Python, this language is the logical choice for our development as well.

Currently we do not see the need for a separate web GUI framework.
Currently, we do not see the need for a separate web GUI framework.
it is preferred to bundle backend and frontend in one solution.

As part of a Dutch government organization, we need to adhere to all dutch laws and standards, like:
As part of a Dutch government organization, we need to adhere to all Dutch laws and standards, like:

* [Digitoegankelijk](https://www.digitoegankelijk.nl/)
* [WCAG Guidelines](https://wcag.nl/kennis/richtlijnen/wcag-2-1-richtlijnen/)
Expand Down Expand Up @@ -74,4 +74,4 @@ did not anticipate.

## Consequences

We have clarity about the tools to use and develop our TAD tool.
We have clarity about the tools to use and develop our AMT tool.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TAD-0005 Add support to run technical tests via AI Verify
# AMT-0005 Add support to run technical tests via AI Verify

## Context

Expand Down Expand Up @@ -36,8 +36,8 @@ which can be processed in any way we please, like writing it to a file or System
* We can wrap the API and other AI Verify requirements in a Docker image.
* We can run the Docker image independently where we only have to provide the model, datasets and other
required configuration to run a test.
* We can monitor the progress of a test in our TAD tool.
* We can process the results of a test in our TAD tool.
* We can monitor the progress of a test in our AMT tool.
* We can process the results of a test in our AMT tool.

## Decision

Expand All @@ -51,4 +51,4 @@ be done in the AI Verify core.

## Consequences

We have a set of technical tests we can integrate in the TAD tool.
We have a set of technical tests we can integrate in the AMT tool.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TAD-0006 Include EU AI Act into System Card
# AMT-0006 Include EU AI Act into System Card

## Context

Expand Down Expand Up @@ -38,4 +38,4 @@ itself and in the assessment card.
## Consequences

The extended system card and proposed instrument will facilitate the documentation of information in accordance
with the EU AI Act using the TAD tool.
with the EU AI Act using the AMT tool.
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/projects/tad/index.md → docs/projects/amt/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# TAD
# AMT

TAD is the acronym for Transparency of Algorithmic Decision making. TAD has the goal to make algorithmic
AMT is the acronym for Algorithm Management Toolkit. AMT has the goal to make algorithmic
systems more transparent; it achieves this by generating standardized reports on the algorithmic system which
encompasses both technical aspects in addition to descriptive information about the system and regulatory assessments.
For both the system and the model the lifecycle is important and this needs to be taken into account. The definition
for an algorithm is derived from the [Algoritmeregister](https://algoritmes.overheid.nl/nl/footer/over-algoritmes).

One of the goals of the TAD project is providing a standardized format of reporting on a algorithmic
One of the goals of the TAD project is providing a standardized format of reporting on an algorithmic
system by developing a [Reporting Standard](reporting-standard/index.md). This Reporting Standard consists out of a
[System Card](reporting-standard/index.md#system_card) which contains
[Model Cards](reporting-standard/index.md#model_card) and
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a1

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a
reporting standard so that information about an algorithmic system can be shared. This reporting standard
Expand All @@ -10,7 +10,7 @@ tests and assessments applied.

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal
and will change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a2

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a
reporting standard so that information about an algorithmic system can be shared. This reporting standard
Expand All @@ -10,7 +10,7 @@ tests and assessments applied.

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal
and will change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a3

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a
reporting standard so that information about an algorithmic system can be shared. This reporting standard
Expand All @@ -10,7 +10,7 @@ tests and assessments applied.

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal
and will change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a4

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a
reporting standard so that information about an algorithmic system can be shared. This reporting standard
Expand All @@ -10,7 +10,7 @@ tests and assessments applied.

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal
and will change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a5

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a
reporting standard so that information about an algorithmic system can be shared. This reporting standard
Expand All @@ -10,7 +10,7 @@ tests and assessments applied.

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal
and will change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a6

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a reporting
standard so that information about an algorithmic system can be shared. This reporting standard describes how
Expand All @@ -9,7 +9,7 @@ descriptive information combined with information about the technical tests and

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal and will
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal and will
change significantly in future versions.

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :label: 0.1a7 (Latest)

This document describes the Transparency of Algorithmic Decision making (TAD) Reporting Standard.
This document describes the Algorithm Management Toolkit (AMT) Reporting Standard.

For reproducibility, governance, auditing and sharing of algorithmic systems it is essential to have a reporting
standard so that information about an algorithmic system can be shared. This reporting standard describes how
Expand All @@ -9,7 +9,7 @@ descriptive information combined with information about the technical tests and

!!! warning "Disclaimer"

The TAD Reporting Standard is work in progress. This means that the current standard is probably suboptimal and will
The AMT Reporting Standard is work in progress. This means that the current standard is probably suboptimal and will
change significantly in future versions.

## Introduction
Expand Down
30 changes: 15 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,24 +80,24 @@ plugins:
nav:
- Home: index.md
- Projects:
- TAD:
- projects/tad/index.md
- AMT:
- projects/amt/index.md
- Reporting Standard:
- projects/tad/reporting-standard/index.md
- projects/tad/reporting-standard/latest.md
- projects/tad/reporting-standard/0.1a6.md
- projects/tad/reporting-standard/0.1a5.md
- projects/tad/reporting-standard/0.1a4.md
- projects/tad/reporting-standard/0.1a3.md
- projects/tad/reporting-standard/0.1a2.md
- projects/tad/reporting-standard/0.1a1.md
- projects/tad/comparison.md
- ADRs for TAD:
- ... | flat | projects/tad/adrs/*
- projects/amt/reporting-standard/index.md
- projects/amt/reporting-standard/latest.md
- projects/amt/reporting-standard/0.1a6.md
- projects/amt/reporting-standard/0.1a5.md
- projects/amt/reporting-standard/0.1a4.md
- projects/amt/reporting-standard/0.1a3.md
- projects/amt/reporting-standard/0.1a2.md
- projects/amt/reporting-standard/0.1a1.md
- projects/amt/comparison.md
- ADRs for AMT:
- ... | flat | projects/amt/adrs/*
- Existing tools:
- ... | flat | projects/tad/existing-tools/comparison/*
- ... | flat | projects/amt/existing-tools/comparison/*
- Checklist:
- ... | flat | projects/tad/existing-tools/checklists/*
- ... | flat | projects/amt/existing-tools/checklists/*
- LLM Benchmarks:
- projects/llm-benchmarks/index.md
- Way of Working:
Expand Down