Repository navigation
docs: document faircode benchmark --root and --no-plots (#1040) - #1054
Merged
Merged
Conversation
Signed-off-by: minutechreview <141821420+minutechreview@users.noreply.github.com>
minutechreview
requested review from
Shreyash0712,
ahmdkaml and
yakew7
as code owners
October 17, 2026 13:37
Contributor
|
@minutechreview is attempting to deploy a commit to the yashkewlani2020-gmailcom's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@yakew7 @Shreyash0712 @ahmdkaml - new PR touching a path you own, please review. |
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.
Summary
faircode benchmark --root PATHand--no-plotsonly appeared in--help. This adds both to the README benchmark examples, with a short explanation under them:--root PATHis the directory searched for*/audit.yaml(one level down, default the current directory). It is ignored when manifest paths are passed, which matchesrun_benchmarkinfaircode/benchmark.py.--no-plotsskipsfigures/*.png, so matplotlib is not needed. The three CSV files are still written.I also added the check the issue suggests, in
tests/test_cli.py: every long option of every subcommand has to appear in the README orfaircode/SPEC.md. It fails on the old README (benchmark --root,benchmark --no-plots) and passes now.I put the text in the README only. SPEC.md has no benchmark command section today, and the new test accepts either file. Say so if you want a SPEC paragraph as well.
Type
Linked issue
Closes #1040
Checks:
pytest tests --ignore=tests/browsergives 817 passed, 21 skipped.ruff check faircode tests scripts,scripts/check_em_dash.pyandscripts/check_broken_links.pypass. I did not runfaircode benchmarkitself (scikit-learn is not installed here); the descriptions come from the argument parser andrun_benchmark,discover_manifestsandwrite_reportin the code.