Repository navigation
Update architecture doc for the current Pass API - #2741
Open
Oke Iyanuoluwa Enoch (Iyanuoluwa007) wants to merge 1 commit into
Open
Oke Iyanuoluwa Enoch (Iyanuoluwa007) wants to merge 1 commit into
Oke Iyanuoluwa Enoch (Iyanuoluwa007) wants to merge 1 commit into
Conversation
From the codebase review: the Pass section still described the old API. - Show the current Pass signatures: the abstract `_default_config` and `_run_for_config` methods, `get_config_class(accelerator_spec, ...)` and `BasePassConfig`. - Replace references to removed internals (`_fixed_params`, `config_at_search_point`) with `get_config_params` and `generate_config`. - Link to the pass reference instead of a stale list of nine passes. - Use `olive run --config` instead of `python –m olive.workflows.run`, which also contained a non-ASCII dash. - Fix two broken table-of-contents anchors. Part of microsoft#2516
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the current implementation, with no unresolved findings.
No open issues 🎉
What changed in this PR
Updates Olive’s architecture documentation to reflect the current Pass API, addressing stale contributor guidance identified in #2516. No runtime code changes.
Changes:
- Documents current Pass signatures, configuration models, and helper methods.
- Replaces the outdated pass list with the pass reference.
- Updates the CLI example and fixes navigation anchors.
| File | Description |
|---|---|
| docs/architecture.md | Refreshes Pass API guidance, reference links, CLI usage, and anchors. |
Review effort: Balanced
This branch has not been deployed
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.
Describe your changes
From the docs items in the codebase review (#2516):
docs/architecture.mdstill described an olderPassAPI, so a contributor following it would implement the wrong methods._default_configand_run_for_config,get_config_classtakesaccelerator_spec, and configs areBasePassConfigmodels. Thedefault_configsection now explains that the publicdefault_configwraps_default_config._fixed_paramsandconfig_at_search_pointno longer exist. The text now refers toget_config_paramsandgenerate_config, which do that work today.python –m olive.workflows.run(which also contained a non-ASCII dash) is nowolive run --config.#search-strategy,#oliveolive).Docs only, no code changes.
Checklist before requesting a review
lintrunner -a(Optional) Issue link
Part of #2516