docs: document the API-key-free RuleBasedJudge smoke path in the Quickstart - #46
Merged
bamdadd merged 1 commit intoJul 22, 2026
Merged
Conversation
…kstart The Quickstart only showed AnthropicJudge (needs an API key), but the package already ships a key-free RuleBasedJudge and a --allow-rule-based-judge runner flag for smoke runs / CI. Add a short note showing the swap, labelled plainly as a NON-FAITHFUL keyword heuristic that must not be used for reported results (mirrors the class docstring). Docs only. Closes bamdadd#22
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
3 participants
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.
Closes #22.
The Quickstart only showed
AnthropicJudge()(needsANTHROPIC_API_KEY), so a newcomer without a key couldn't tell they can still run the pipeline end-to-end on CPU. The package already shipsRuleBasedJudge(exported) and the runner's--allow-rule-based-judgeflag.Change: a short Quickstart note showing
RuleBasedJudge()in place ofAnthropicJudge()(and--allow-rule-based-judgefor the runner), stated plainly as a NON-FAITHFUL keyword heuristic that must not be used for reported results — mirroring the wording already in the class docstring. No code change; docs only.