From c24b33b56adf0b0b7ed2f2660de3d32ace49edb4 Mon Sep 17 00:00:00 2001 From: "kapil.madan" Date: Sun, 30 Aug 2026 10:27:29 +0530 Subject: [PATCH] docs: correct four claims the README makes about the tool Four statements on the two English acquisition surfaces do not match the repository or the code they describe. pyproject declares requires-python = ">=3.12,<3.13", which admits 3.12 alone. The badge read "Python 3.12+", which advertises every later release as supported. It now reads 3.12. The four translated READMEs carry the same correction in #89. The options table listed --evaluators as a way to restrict the evaluator set. _run_evaluate accepts the argument and does not forward it to aicertify_app_for_policy, so a value supplied there has no effect on the run. The row is removed. Whether the flag should be wired through or rejected is a behaviour question and is left to a separate change. Two of the three linked output directories hold no committed report. examples/outputs/eu_ai_act/ has no tracked file at all, and examples/outputs/medical_diagnosis/ holds only a .gitkeep, so both rendered as empty on GitHub. The section now links the artefacts that are committed: the retained fair-lending PDF and the contract that produced it, and the three expected_report.md files under examples/. The EU AI Act demo report was already linked directly above and is unchanged. Regal moved from StyraInc to the open-policy-agent organisation. The link now points at the current location rather than relying on the redirect. Verified: every relative link in README.md resolves to a tracked path, and no occurrence of "3.12+", "--evaluators" or "StyraInc" remains on either surface. --- README-pypi.md | 4 ++-- README.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README-pypi.md b/README-pypi.md index 4c76e33..90d21eb 100644 --- a/README-pypi.md +++ b/README-pypi.md @@ -13,7 +13,7 @@ PyPI CI Stars - Python 3.12+ + Python 3.12 Apache 2.0 Built on OPA 92 Rego Policies @@ -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/` --- diff --git a/README.md b/README.md index 5113a0d..6f68fa2 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ PyPI CI Stars - Python 3.12+ + Python 3.12 Apache 2.0 Built on OPA 92 Rego Policies @@ -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 | @@ -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

@@ -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. ---