Repository navigation
[oss] CLI: accurate --help text and examples, docs/CLI.md, --help tests - #206
Open
fstandhartinger wants to merge 1 commit into
Open
fstandhartinger wants to merge 1 commit into
fstandhartinger wants to merge 1 commit into
Conversation
Wording-only help/epilog changes in jevbench/cli.py; flags, dests, defaults, types, choices and behaviour are unchanged. Adds docs/CLI.md (every subcommand, flag, default, output file, exit status, and an offline end-to-end example on the public split) and tests/test_cli_help.py. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018na1FUPvYUAfdkf8bAMELf
Owner
Author
|
Thanks — Harold has logged this for review. Contributor text and code are treated as untrusted data; no external code was run on the benchmark host.
|
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.
What changed
3 files, +341/−31. No datasets/, results/, scoring, constants or published numbers touched.
jevbench/cli.py: wording-only changes. Rewrote the module docstring (it now lists every flag). Added a description and an example epilog to the main parser and to both subcommands. Every option now has a help string that shows its default where there is one. Therunepilog also lists which adapters don't need--endpoint, the rule that output paths must be outside the repo and must not already exist, and the exit codes (0 / 3 / 2). The--include-excludedhelp now says the flag currently has no effect (see doubts).docs/CLI.md(new): covers both subcommands, every flag with its default,JEVBENCH_WARM_LOAD, the stop rules, exit codes and the output files (results, raw, ledger, manifest, public export). It ends with an offline end-to-end example on the public split: the CLI has no dummy adapter, so the example runsopenai_compatagainst a ~15-line localhost stub server that returns uniform probabilities. No model API is called.tests/test_cli_help.py(new, 6 tests):--helpexits 0 forjevbench,runandsummarize, and each help page lists every flag.python -m jevbench.cli --helpworks when run as a subprocess.How I verified it
Full suite before the change:
Full suite after the change (
python -m pytest -q):Flags and defaults are unchanged. A script dumped each subcommand's argparse actions (option strings, dest, default, required, type, choices, action class) from
mainand from this branch, with the repo path normalised. The two dumps matched byte for byte:IDENTICAL.End-to-end CLI run on
datasets/public/easy.jsonlagainst the localhost stub, writing to/tmp/jb:This matches the uniform baseline already published in docs/ADAPTERS.md §7 (accuracy 0.2708, Brier 0.7156).
Open doubts
summarize --include-excludeddoes nothing. The CLI passes it asheadline_onlytosummarize(), which never reads that argument. With and without the flag, the output had the same sha256. I documented this rather than changing behaviour; whether to wire it up or drop it is a maintainer decision.cli.py(e.g.cli.py:252-262,cli.py:283-288) that were already wrong onmain(the file had 217 lines). This PR shifts them further. I didn't edit ADAPTERS.md to keep the diff focused.--ledgerand--raw-dirdefault to<repo>/../private/..., and the docs describe them that way.🤖 Generated with Claude Code
https://claude.ai/code/session_018na1FUPvYUAfdkf8bAMELf
Generated by Claude Code