New CLI command: search - #2576
Draft
shaahji wants to merge 1 commit into
Draft
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
lintrunner found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
shaahji
force-pushed
the
shaahji/clisearch
branch
from
July 17, 2026 20:12
0b1dc72 to
252a190
Compare
* A specialized implementation of "run" CLI command that can built the config from command line args and run it. * Also, updated base.py to support command line args with both underscores and hyphens (aliasing only, with full backward compatibility).
shaahji
force-pushed
the
shaahji/clisearch
branch
from
July 23, 2026 23:27
252a190 to
f135898
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new olive CLI subcommand (pass-search) that builds and/or amends workflow configs from command-line arguments to run a pass-level search workflow, and extends the CLI option surface to accept both underscore and hyphen variants for many existing flags.
Changes:
- Added new
pass-searchCLI command to generate run configs from args (or load an existing config) and run locally or submit remotely. - Changed
SearchStrategyConfig.include_pass_paramsdefault toFalseand updated docs accordingly. - Updated shared CLI argument definitions in
olive/cli/base.pyto accept both underscore and hyphen forms for many options.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/cli/test_pass_search.py | Adds unit tests for pass-search parsing, config generation, and remote submission behavior. |
| olive/search/search_strategy.py | Changes default include_pass_params to False. |
| olive/cli/pass_search.py | Implements the new pass-search command (arg parsing, config building, local run / remote submit). |
| olive/cli/launcher.py | Registers the new pass-search subcommand in the CLI entrypoint. |
| olive/cli/base.py | Adds hyphen aliases for many existing CLI options (and adjusts typing for logging default). |
| docs/source/reference/options.md | Updates documentation to reflect the new default for include_pass_params. |
Comment on lines
860
to
866
| dataset_group.add_argument( | ||
| "--add_special_tokens", | ||
| "--add-special-tokens", | ||
| type=bool, | ||
| default=False, | ||
| help="Whether to add special tokens during preprocessing.", | ||
| ) |
Comment on lines
+183
to
+192
| search_group.add_argument( | ||
| "--include-pass-params", | ||
| action="store_true", | ||
| default=None, | ||
| help=( | ||
| "Include individual pass parameters in the search space. WARNING: this expands the " | ||
| "search space combinatorially -- even a few passes can blow it up exponentially. " | ||
| "Check the engine log ('Search space contains N search points ...') before launching." | ||
| ), | ||
| ) |
| - `stop_when_goals_met: [Boolean]` This decides whether to stop the search when the metric goals, if any, are met. This is `false` by default. | ||
|
|
||
| - `include_pass_params: [Boolean]` Includes individual pass parameter to build the search space. Defaults to true. | ||
| - `include_pass_params: [Boolean]` Includes individual pass parameter to build the search space. Defaults to false. |
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.
New CLI command: search
Checklist before requesting a review
lintrunner -a(Optional) Issue link