docs: correct four claims the README makes about the tool - #90
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🚀 Overview
Corrects four claims
README.mdandREADME-pypi.mdmake about the tool thatdo not match the repository or the code. Companion to #89, which carries the
same pass into the 19 files #88 did not touch. Documentation only.
📜 Changes Made
1. Python badge overstated the supported range
pyproject.tomldeclaresrequires-python = ">=3.12,<3.13"— 3.12 alone. Thebadge read "Python 3.12+", advertising every later release as supported.
Now reads 3.12. The four translated READMEs carry the same fix in #89.
2.
--evaluatorswas documented but has no effectThe options table listed it as a way to restrict the evaluator set.
_run_evaluateaccepts the argument and never forwards it:A value supplied there has no effect on the run. The row is removed.
3. Two of three linked output directories were empty
examples/outputs/eu_ai_act/examples/outputs/medical_diagnosis/.gitkeep— renders emptyexamples/outputs/loan_evaluation/Now links artefacts that are actually committed: the retained fair-lending PDF
and its contract, plus the three
expected_report.mdfiles underexamples/.The EU AI Act demo report was already linked directly above and is unchanged.
4. Regal link pointed at the old organisation
Regal moved from
StyraInctoopen-policy-agent. The link now points at thecurrent location (
open-policy-agent/regal, 401 stars, active) rather thanrelying on GitHub's redirect.
✅ Already fixed by #88 — not repeated here
85/91→92aicertify evaluate --policy uk(console script andframework name) rather than
python -m aicertify.cliwith a full policy path🎯 How to Test
Verified locally: every relative link in
README.mdresolves to a trackedpath, and none of
3.12+,--evaluatorsorStyraIncremains on eithersurface.
📚 Documentation
README.md,README-pypi.md