Skip to content

Update architecture doc for the current Pass API - #2741

Open
Oke Iyanuoluwa Enoch (Iyanuoluwa007) wants to merge 1 commit into
microsoft:mainfrom
Iyanuoluwa007:update-architecture-doc
Open

Oke Iyanuoluwa Enoch (Iyanuoluwa007) wants to merge 1 commit into
microsoft:mainfrom
Iyanuoluwa007:update-architecture-doc

Conversation

@Iyanuoluwa007

Copy link
Copy Markdown

Describe your changes

From the docs items in the codebase review (#2516): docs/architecture.md still described an older Pass API, so a contributor following it would implement the wrong methods.

  • Pass base class: show the current signatures. The abstract methods are _default_config and _run_for_config, get_config_class takes accelerator_spec, and configs are BasePassConfig models. The default_config section now explains that the public default_config wraps _default_config.
  • Removed internals: _fixed_params and config_at_search_point no longer exist. The text now refers to get_config_params and generate_config, which do that work today.
  • Implemented passes: replace the stale list of nine passes with a link to the pass reference.
  • CLI: python –m olive.workflows.run (which also contained a non-ASCII dash) is now olive run --config.
  • Table of contents: fix two broken anchors (#search-strategy, #oliveolive).

Docs only, no code changes.

Checklist before requesting a review

  • Add unit tests for this change.
  • Make sure all tests can pass.
  • Update documents if necessary.
  • Lint and apply fixes to your code by running lintrunner -a
  • Is this a user-facing change? If yes, give a description of this change to be included in the release notes.

(Optional) Issue link

Part of #2516

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
Copilot AI balanced review requested due to automatic review settings October 17, 2026 09:25
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants