DOC Correct scenario baseline parameter guidance - #2313
Merged
romanlutz merged 1 commit intoAug 3, 2026
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4b171813-5be5-487b-91c6-188b938319cd
hannahwestra25
approved these changes
Aug 3, 2026
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.
Description
The scenarios overview incorrectly described
include_baselineas an argument toinitialize_async, although that method takes no arguments and reads values from the resolved scenario parameter bag. This updates the guidance to explain that callers supply the parameter through the CLI, configuration, orset_params_from_argsbefore initialization.The paired Jupytext source and notebook are updated together so both documentation formats remain synchronized.
Tests and Documentation
uvx --from jupytext==1.19.4 jupytext --to ipynb --test-strict doc/code/scenarios/0_scenarios.pyuv run ruff check doc/code/scenarios/0_scenarios.pyuv run pytest tests/unit/datasets tests/unit/executor/attack/single_turn/test_many_shot_template.py tests/unit/executor/attack/single_turn/test_many_shot_jailbreak.py -q(4,666 passed)