Skip to content

Commit

Permalink
update TEA documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdburr committed Feb 12, 2025
1 parent 36d8715 commit 6b6831a
Show file tree
Hide file tree
Showing 30 changed files with 872 additions and 294 deletions.
62 changes: 12 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

![An illustration representing the collaborative development of a structured assurance case. The image shows various groups of people working together across different workstations linked by different paths.](site/docs/assets/images/hero.gif)

[![All Contributors](https://img.shields.io/github/all-contributors/alan-turing-institute/AssurancePlatform?color=ee8449&style=flat-square)](#contributors)
[![Go to the TEA Platform](https://img.shields.io/badge/Go%20to%20the%20TEA%20Platform-0F76B8?style=flat&link=https://assuranceplatform.azurewebsites.net/)](https://assuranceplatform.azurewebsites.net/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8198986.svg)](https://doi.org/10.5281/zenodo.8198986)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/alan-turing-institute/AssurancePlatform/main.svg)](https://results.pre-commit.ci/latest/github/alan-turing-institute/AssurancePlatform/main)
Expand All @@ -19,53 +18,27 @@ and [University of York](https://www.york.ac.uk/assuring-autonomy/).

The UK's Responsible Technology Adoption Unit (Department of Science, Innovation, and Technology) is also a project partner.

To use the TEA platform, please go to [https://assuranceplatform.azurewebsites.net/](https://assuranceplatform.azurewebsites.net/).
## Usage and Deployment Instructions 💻

> [!WARNING]
> The TEA platform is made available as a research preview, and should not be used for any business critical tasks. Future breaking changes should be expected.
To view the documentation site, please go to
[https://alan-turing-institute.github.io/AssurancePlatform](https://alan-turing-institute.github.io/AssurancePlatform).
### 1 Use the TEA Platorm

## What is Trustworthy and Ethical Assurance? 🤝
If you'd like to just use the TEA platform, and have some familiarity with building assurance cases already, please go to [https://assuranceplatform.azurewebsites.net/](https://assuranceplatform.azurewebsites.net/).

> Trustworthy and ethical assurance is a methodology and procedure for
> developing a structured argument, which provides reviewable (and contestable)
> assurance that a set of claims about a normative goal of a data-driven
> technology are warranted given the available evidence.
The following elements are central to this methodology and procedure:

- **The SAFE-D Principles**: a set of five operationalisable
principles—Sustainability, Accountability, Fairness, Explainability, Data
Stewardship—that have been carefully designed and refined to address
real-world challenges associated with the design, development, and deployment
of data-driven technologies.
- **Assurance Cases**: the documented argument that communicates the basis for
how and why a goal has been achieved.
- **Argument Patterns**: starting templates for building assurance cases. They
identify the types of claims (or, the sets of reasons) that need to be
established to justify the associated top-level normative goal.
> [!WARNING]
> The TEA platform is made available as a **research preview**, and should not be used for any business critical tasks. Future breaking changes should be expected.
The Trustworthy and Ethical Assurance platform brings these elements together in
a usable and accessible manner, and helps project teams to provide trustworthy
and justifiable assurance about the processes they undertook when designing,
developing, and deploying their technology or system.
### 2 Learn About TEA

## Installation Instructions 💻
If you are not sure what an assurance case is, or need some help using the platform, please view our documentation site at
[https://alan-turing-institute.github.io/AssurancePlatform](https://alan-turing-institute.github.io/AssurancePlatform).

To get started quickly with installing this platform visit the [backend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/backend/installation/) and [frontend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/frontend/installation/) installation instructions.
### 3 Run Locally

The Trustworthy and Ethical Assurance application can be run locally or deployed
on your own server or a cloud-based service (e.g. Azure). To view the different
installation instructions, please visit our documentation site for the
[backend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/backend/installation/)
and [frontend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/frontend/installation/).
The TEA application can be run locally or deployed on your own server or a cloud-based service (e.g. Azure). You can find the instructions on how to do this here: [https://alan-turing-institute.github.io/AssurancePlatform/technical-documentation/local-quickstart/](https://alan-turing-institute.github.io/AssurancePlatform/technical-documentation/local-quickstart/)

## Further Resources 📚

The following resources provide additional information about the Trustworthy and
Ethical Assurance framework and methodology:
The following resources provide additional information about the Trustworthy and Ethical Assurance framework and methodology:

- Burr, C., Arana, S., Gould Van Praag, C., Habli, I., Kaas, M., Katell, M., Laher, S., Leslie, D., Niederer, S., Ozturk, B., Polo, N., Porter, Z., Ryan, P., Sharan, M., Solis Lemus, J. A., Strocchi, M., Westerling, K., (2024) Trustworthy and Ethical Assurance of Digital Health and Healthcare. [https://doi.org/10.5281/zenodo.10532573](https://doi.org/10.5281/zenodo.10532573)
- Porter, Z., Habli, I., McDermid, J. et al. A principles-based ethics assurance argument pattern for AI and autonomous systems. AI Ethics 4, 593–616 (2024). [https://doi.org/10.1007/s43681-023-00297-2](https://doi.org/10.1007/s43681-023-00297-2)
Expand All @@ -79,15 +52,4 @@ From March 2024 until September 2024, the project is funded by UKRI's [BRAID pro
Between April 2023 and December 2023, this project received funding from the Assuring Autonomy International Programme, a partnership between Lloyd’s Register Foundation and the University of York, which was awarded to Dr Christopher Burr.

Between July 2021 and June 2022 this project received funding from the UKRI’s Trustworthy Autonomous Hub, which was awarded to Dr Christopher Burr
(Grant number: TAS_PP_00040).

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
(Grant number: TAS_PP_00040).
9 changes: 9 additions & 0 deletions next_frontend/tea-docs/blog/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,12 @@ chris:
socials:
github: chrisdburr
linkedin: christopherdburr
shakir:
name: Shakir Laher
title: Research Application Manager
url: https://github.com/S-Laher
image_url: https://github.com/S-Laher.png
page: true
socials:
github: S-Laher
linkedin: shakir-laher-a2b300141
79 changes: 0 additions & 79 deletions next_frontend/tea-docs/docs/docs/about.md

This file was deleted.

Loading

0 comments on commit 6b6831a

Please sign in to comment.