Skip to content

docs: align #509/#511/#573 docs with the decided vocabulary and Pass 1 candidates - #663

Merged
zzylol merged 4 commits into
mainfrom
docs/align-509-511-573
Oct 12, 2026
Merged

zzylol merged 4 commits into
mainfrom
docs/align-509-511-573

Conversation

@zzylol

@zzylol zzylol commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Why

The #509 / #511 / #573 design docs lagged behind decisions already made in code review: the vocabulary is "evaluation", not "readout"; Pass 1's targets were never defined; and Pass 1's exact accumulator option, which #561 generates, was missing from #509, so Example 1's candidate counts were wrong.

What

Documentation only.

How

Minimal edits; no other wording changed. The coverage cache in #573 (§4.2.3, §6.1) is left as is: it is the decided design, not yet implemented (#651).

Before this PR

The docs said ReadPopulation / readout, used "eligible sub-DAG" without a definition, and counted Example 1 with one option for Q1 and no nested targets.

After this PR

The docs use the code's names, define Pass 1's targets, and Example 1's counts match what Pass 1 enumerates.

Evidence

The Example 1 targets were checked by running #561's enumerate_local_logical_candidates on Example 1's two queries with the doc's accuracy targets: it finds the same 4 targets. #561 is being updated to offer one exact option per target, which gives 1, 1, 1 and 3 options. (The code offers Count-Sketch + heap where the doc lists Hydra for top-k; TopK Hydra is being added in #605. That does not change the count.) Screenshots and measurements: not applicable.

Verification

  • Documentation only; no code change. The edited mermaid diagram was not rendered locally.

Architectural decisions

Limitations and follow-up

  • Multi-measure aggregates are not described yet.

Human review — do not complete with an agent

  • The MVP boundary is correct.
  • New conceptual layers or public interfaces are necessary.
  • The before/after description matches the intended product behavior.
  • Human reviewer:
  • Decision and rationale:

🤖 Generated with Claude Code

https://claude.ai/code/session_01W7qG9aFyPij5uWsyAJCxDW

…1 candidates

- operator-sharing.md: ReadPopulation { readout } -> EvaluatePopulation
  { evaluation } (matches crates/types/src/ir/asap.rs); "readout" ->
  "evaluation" where it names reading summary state; add the missing
  `filter` field to the SummaryAgg sketch.
- asap-primitive-schema.md: "readout" -> "evaluation" where it names the
  operation (intent table header, §6.5 heading and its anchor/table row,
  top-k evaluation, guarantee of an evaluation). Verb "read out" kept, as
  in the code comments. Coverage cache text unchanged.
- planner-layering.md: define an eligible sub-DAG at its first use; add
  the exact accumulator state candidate to the Pass 1 table and text;
  recompute Example 1 (Pass 1: 2 x 2 x 2 x 3 = 24, Pass 2:
  24 x 2 x 3 x 3 = 432, Stage 2: 24 x 52 = 1,248).
- planner-layering.md: every aggregation is its own Pass 1 target,
  including nested ones (Q1's per-series rate and per-job sum, Q2's
  per-series sum_over_time and per-job top-k), as in #561's
  enumerate_local_logical_candidates; the Algorithm 1 example and diagram
  show the four sub-DAGs, and Example 1 lists options per target.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W7qG9aFyPij5uWsyAJCxDW
Comment thread docs/design_docs/proposals/planner-layering.md Outdated
Comment thread docs/design_docs/proposals/planner-layering.md Outdated
Comment thread docs/design_docs/proposals/planner-layering.md Outdated
@zzylol
zzylol force-pushed the docs/align-509-511-573 branch from 13ad438 to 72fa555 Compare October 12, 2026 20:05
zzylol and others added 2 commits October 12, 2026 20:08
Each Pass 1 target gets a single exact option: exact accumulator state
when the intent has a buildable mergeable exact accumulator, otherwise
the plain exact computation. Example 1 returns to 3 / 54 / 156 with
four targets.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W7qG9aFyPij5uWsyAJCxDW
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W7qG9aFyPij5uWsyAJCxDW
@zzylol
zzylol merged commit 7723223 into main Oct 12, 2026
2 checks passed
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.

1 participant