Skip to content

Commit 4ddd032

Browse files
authored
Update README.md
fix errors and links clarify overview
1 parent eaa3ca0 commit 4ddd032

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,25 @@ A framework for implementing Continuous Alignment Testing (CAT) for LLM-based ap
44

55
## Overview
66

7-
CAT provides the infrastructure needed to:
7+
CAT provides the infrastructure to:
88

9-
- Run and track CATs against LLM outputs
10-
- Store and analyze test results over time
11-
- Monitor changes in LLM behavior as prompts/models/data evolve
12-
- Integrate validation into CI/CD pipelines
9+
- Run and track automated tests against an AI application.
10+
- Store and analyze AI test results over iterations.
11+
- Monitor reliability changes in an AI application as prompts, models, code, and data evolve.
12+
- Integrate AI tests into the CI pipeline.
13+
- Build the AI application as an API service.
14+
- Ensure AI applications are reliable while maintaining creativity.
15+
- Iterate on prompts and code while measuring improvements.
1316

1417
## Example Apps
1518

1619
- [team_recommender - Team Recommender](examples/team_recommender/readme.md)
1720

1821

19-
## Run Tests
22+
## Documentation
2023

21-
```bash
22-
uv run pytest
23-
```
24+
Github Pages: https://thisisartium.github.io/continuous-alignment-testing/
2425

25-
## Code Quality
26+
## Wiki
2627

27-
```bash
28-
uv run mypy -p src
29-
```
30-
31-
## [Publishing Documentation](https://thisisartium.github.io/continuous-alignment-testing)
32-
33-
The Sphinx based documentation is available at [https://thisisartium.github.io/cat-ai](https://thisisartium.github.io/cat-ai)
34-
35-
## [Wiki](wiki)
36-
37-
[wiki](https://github.com/thisisartium/continuous-alignment-testing/wiki)
28+
https://github.com/thisisartium/continuous-alignment-testing/wiki

0 commit comments

Comments
 (0)