Skip to content

docs: correct four claims the README makes about the tool #90

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.

Sign up for GitHub

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

Merged
kmadan merged 1 commit into from
Aug 30, 2026
Merged

docs: correct four claims the README makes about the tool #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README-pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a href="https://pypi.org/project/aicertify/"><img src="https://img.shields.io/pypi/v/aicertify?style=flat-square&color=blue" alt="PyPI"></a>
<a href="https://github.com/Principled-Evolution/aicertify/actions/workflows/aicertify-ci.yaml"><img src="https://github.com/Principled-Evolution/aicertify/actions/workflows/aicertify-ci.yaml/badge.svg" alt="CI"></a>
<a href="https://github.com/Principled-Evolution/aicertify/stargazers"><img src="https://img.shields.io/github/stars/Principled-Evolution/aicertify?style=flat-square" alt="Stars"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg?style=flat-square" alt="Python 3.12+"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12-blue.svg?style=flat-square" alt="Python 3.12"></a>
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square" alt="Apache 2.0"></a>
<a href="https://www.openpolicyagent.org/ecosystem/entry/principled-evolution"><img src="https://img.shields.io/badge/built%20on-OPA-7D4698.svg?style=flat-square" alt="Built on OPA"></a>
<a href="https://github.com/Principled-Evolution/gopal"><img src="https://img.shields.io/badge/policies-92%20rego-2f9e44.svg?style=flat-square" alt="92 Rego Policies"></a>
Expand Down Expand Up @@ -148,7 +148,7 @@ Each example ships an `input_contract.json`, `policy_config.yaml`, `sample_inter
You don't have to install anything to see what AICertify produces. A sample pre-generated PDF is in the repo:

- **[demo-report-eu-ai-act.pdf](https://github.com/Principled-Evolution/aicertify/blob/main/docs/demo-report-eu-ai-act.pdf)**: a customer-support agent evaluated against the EU AI Act
- **[examples/outputs/](https://github.com/Principled-Evolution/aicertify/tree/main/examples/outputs)**: canonical full outputs for EU AI Act, loan evaluation, and medical diagnosis
- **[expected reports](https://github.com/Principled-Evolution/aicertify/tree/main/examples)**: committed Markdown reports for the customer-support, healthcare-triage and hiring-screening examples, and a retained fair-lending PDF under `examples/outputs/loan_evaluation/`

---

Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<a href="https://pypi.org/project/aicertify/"><img src="https://img.shields.io/pypi/v/aicertify?style=flat-square&color=blue" alt="PyPI"></a>
<a href="https://github.com/Principled-Evolution/aicertify/actions/workflows/aicertify-ci.yaml"><img src="https://github.com/Principled-Evolution/aicertify/actions/workflows/aicertify-ci.yaml/badge.svg" alt="CI"></a>
<a href="https://github.com/Principled-Evolution/aicertify/stargazers"><img src="https://img.shields.io/github/stars/Principled-Evolution/aicertify?style=flat-square" alt="Stars"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg?style=flat-square" alt="Python 3.12+"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12-blue.svg?style=flat-square" alt="Python 3.12"></a>
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square" alt="Apache 2.0"></a>
<a href="https://www.openpolicyagent.org/ecosystem/entry/principled-evolution"><img src="https://img.shields.io/badge/built%20on-OPA-7D4698.svg?style=flat-square" alt="Built on OPA"></a>
<a href="https://github.com/Principled-Evolution/gopal"><img src="https://img.shields.io/badge/policies-92%20rego-2f9e44.svg?style=flat-square" alt="92 Rego Policies"></a>
Expand Down Expand Up @@ -276,7 +276,6 @@ Useful flags:
| `--contract` | Path to the AI application contract JSON |
| `--policy` | Framework name or path to an OPA policy folder |
| `--report-format` | `pdf`, `markdown`, `json`, `html` (default: `pdf`) |
| `--evaluators` | Restrict to specific evaluators (e.g. `Fairness ContentSafety`) |
| `--output-dir` | Where reports land (default: `./reports`) |
| `--verbose` | Verbose logging |

Expand All @@ -289,9 +288,10 @@ See [`examples/quickstart.py`](examples/quickstart.py) for the full Python API.
You don't have to install anything to see what AICertify produces. Pre-generated reports are committed to the repo:

- **[demo-report-eu-ai-act.pdf](docs/demo-report-eu-ai-act.pdf)**: a customer-support agent evaluated against the EU AI Act
- [examples/outputs/eu_ai_act/](examples/outputs/eu_ai_act/): the canonical full output
- [examples/outputs/loan_evaluation/](examples/outputs/loan_evaluation/): a credit-scoring model evaluated for fair lending
- [examples/outputs/medical_diagnosis/](examples/outputs/medical_diagnosis/): a clinical-decision-support model evaluated for patient safety
- **[report_Loan_Application_20250226_212152.pdf](examples/outputs/loan_evaluation/report_Loan_Application_20250226_212152.pdf)**: a credit-scoring model evaluated for fair lending, with the [contract](examples/outputs/loan_evaluation/contract_2025-02-26_212149.json) that produced it
- **[healthcare-triage-bot/expected_report.md](examples/healthcare-triage-bot/expected_report.md)**: a clinical-decision-support model evaluated for patient safety
- **[hiring-screening-bot/expected_report.md](examples/hiring-screening-bot/expected_report.md)**: a hiring model evaluated for bias
- **[customer-support-bot/expected_report.md](examples/customer-support-bot/expected_report.md)**: the Markdown form of the demo report above

<p align="center">
<picture>
Expand Down Expand Up @@ -381,7 +381,7 @@ For security issues, please follow the [Security Policy](SECURITY.md): report pr

- **[gopal](https://github.com/Principled-Evolution/gopal)**: the OPA policy library AICertify uses under the hood. Use it standalone with the OPA CLI if you don't need the Python framework.
- **[Open Policy Agent](https://www.openpolicyagent.org/)**: the policy engine.
- **[Regal](https://github.com/StyraInc/regal)**: Rego linter used to keep policies clean.
- **[Regal](https://github.com/open-policy-agent/regal)**: Rego linter used to keep policies clean.

---

Expand Down
Loading