Skip to content

docs: define configurable, offline-first model information architecture - #10041

Merged
lpcox merged 8 commits into
mainfrom
pelikhan-model-architecture-review
Oct 16, 2026
Merged

lpcox merged 8 commits into
mainfrom
pelikhan-model-architecture-review

Conversation

@pelikhan

Copy link
Copy Markdown
Collaborator

AWF needs consistent model facts without requiring access to a public pricing endpoint or a new release for every model update. This proposal consolidates model identity, pricing, capabilities, and compatibility while preserving existing behavior through a parity-gated migration.

Architecture

  • Define provider-qualified canonical records, field-level provenance and freshness, deterministic generated projections, and versioned exports.
  • Allow users to define model entries in gh-aw workflow frontmatter and pass validated, run-scoped overlays through AWF config.
  • Support configurable central pricing updates and user-replaceable sources, including internal mirrors and local snapshots. Assume the default feed is blocked; do not relax egress policy or silently contact the default endpoint after source replacement.
  • Enforce model-specific harness version requirements against the actual executing harness, including routing and fallback eligibility.
  • Require compatible tariff scopes before merging pricing components and declare feature compatibility for directed protocol pairs.

Scope and migration

Documentation only: this PR defines the target contracts, validation requirements, and staged rollout, not runtime implementation. It carries forward ADR 0004 from #10033; the two requirement-update commits in this session were also pushed to that existing PR.

Validation

  • Markdown lint passed for the ADR.
  • git diff --check passed.

lpcox and others added 7 commits October 8, 2026 16:08
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
# Conflicts:
#	scripts/ci/smoke-claude-workflow.test.ts
#	scripts/ci/smoke-cloud-hypervisor-workflow.test.ts
#	scripts/ci/smoke-codex-workflow.test.ts
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 05030fb2-8413-41a3-9790-349049a61b19
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 05030fb2-8413-41a3-9790-349049a61b19
Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
Define workflow-configured model overlays, configurable central pricing refresh, and model-to-harness version constraints. Clarify tariff component scope and directed protocol compatibility, and wire the requirements into rollout and validation gates.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Assume the default pricing feed is blocked. Define workflow and AWF config source replacement, internal mirrors and local snapshots, no implicit network access, and approved fallback behavior. Extend validation and rollout requirements.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Documentation Preview

Documentation has been built for this PR.

Download preview artifact

To view locally:

  1. Download the docs-preview-pr-10041 artifact from the workflow run
  2. Unzip and open index.html in your browser

Built from commit 915c022

Use governed provider-qualified models.dev snapshots for inference providers without native AWF pricing support. Preserve precedence, provenance, and offline operation, and cover the fallback in validation and rollout requirements.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@lpcox
lpcox marked this pull request as ready for review October 16, 2026 04:29
Copilot AI max review requested due to automatic review settings October 16, 2026 04:29
@lpcox
lpcox merged commit 048af90 into main Oct 16, 2026
39 checks passed
@lpcox
lpcox deleted the pelikhan-model-architecture-review branch October 16, 2026 04:32

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.

🟡 Changes recommended

Source-trust and compatibility gaps need resolution before the proposal guides implementation.

6 open findings
What changed in this PR

Defines an offline-first model-information architecture for AWF, with a staged migration that preserves existing behavior.

Changes:

  • Consolidates model identity, pricing, capabilities, provenance, and harness constraints.
  • Specifies workflow overlays, replaceable pricing sources, and offline fallbacks.
  • Defines generated exports, validation requirements, and migration gates.
File Description
docs/​adr/​0004-model-information-management.md Adds ADR 0004 covering the architecture, contracts, and rollout.

🧠 Review effort: Max


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +522 to +526
authentication is a separate requirement; a content digest alone does not
authenticate the publisher. Malformed, unsupported, or inconsistent updates
are rejected atomically with an explicit diagnostic, never partially applied.
The shared cache is partitioned by configured source and schema version so
changing pricing sources cannot reuse an unrelated source's last-known-good
Comment on lines +726 to +729
reconstruct those labels from a summary. The version field identifies the
`/reflect/v2` schema; clients first try v2 and fall back to `/reflect` when the
endpoint is unavailable on an older pinned AWF version. AWF retains the v1
contract during consumer migration.
Comment on lines +254 to +260
Explicit incompatible model requests fail with the model, harness, required
version, detected version or detection failure, and upgrade guidance. Routing,
dynamic selectors, and fallback selection exclude incompatible candidates
before dispatch and fail explicitly when no eligible candidate remains.
Runtime catalogue refreshes re-evaluate eligibility before subsequent dispatch;
they do not upgrade the harness or silently substitute a different model for an
explicit request.
Comment on lines +486 to +489
The compiler and AWF must agree on the overlay schema version. Workflows that
use this feature with an older pinned AWF version fail with an explicit
unsupported-config error rather than silently losing model entries. Existing
workflows without model entries retain their current behavior.
Comment on lines +569 to +570
Runtime provider facts have highest authority for current availability and
provider-published values when complete and fresh. A later incomplete response
Comment on lines +905 to +908
Add the issue 10032 characterization and drift coverage. If the immediate fixes
from issues 10029 and 10030 land first, the tests characterize the corrected
baseline. Otherwise the tests mark those cases as known gaps to close through
the catalogue.
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.

4 participants