docs: sweep stale Default-OFF claims for already-flipped retrieval flags - #770
Merged
Merged
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…l-clustering Two flag block-comments in retrieval.py still claimed Default-OFF for flags that have since flipped: - BM25F_FLAG (line 132-135): The #154 composition-tracker bench cleared at +0.6650 NDCG@k on the v0.1 retrieve_uplift fixture in v1.7.0; resolve_use_bm25f_anchors() has resolved to True since. - INTENTIONAL_CLUSTERING_FLAG (line 154-161): The #436 R6 A4 latency gate cleared 60/60 PASS at p99 0.328ms on the multi-store production sweep in v3.0; resolve_use_intentional_clustering() has resolved to True since. Update both block-comments to state Default-ON, cite the cleared bench, and list the opt-out paths. No behavior change.
The HRR-integration spec doc was written pre-v2.1 to motivate the persistence substrate as a precondition for the default-ON ship. v2.1 shipped both pieces — persistence + the #154 / #437 default-flip clearance — but the doc retained pre-flip wording in three spots: - "Problem" section lede claimed v1.7+ ships HRR default-OFF: reframe as historical context for the v2.1 work. - `hrr_index.py` bullet claimed Default-OFF behind use_hrr_structural: update to Default-ON since v2.1 with gate citation. - "Default-flip flag" section claimed the flag still ships default-OFF until the bench clears: update to the post-flip state with opt-out paths documented. No behavior change. No new claims — just align the spec doc with the shipped state.
…ing.md The intentional-clustering spec doc still framed the flag as default-OFF awaiting bench evidence. The #436 R6 A4 latency gate cleared 60/60 PASS at p99 0.328ms on the multi-store production sweep and the flag flipped to default-ON in v3.0 (see CHANGELOG). - "Status" header: drop "default-OFF at v2.0.0" framing; cite the cleared gate. - "Configuration" precedence list item #4: replace the "Default OFF at v2.0.0 until bench-gate clears" stub with the post-flip state, citing the gate and listing the opt-out paths. No behavior change.
robotrocketscience
force-pushed
the
docs/sweep-stale-default-off-claims
branch
from
May 14, 2026 03:03
993541b to
301a411
Compare
robotrocketscience
added
the
ready-to-merge
github-actions
Bot
removed
the
ready-to-merge
|
merge-train: merged 301a411 → |
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
1 participant
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.
Summary
Three retrieval flags flipped from default-OFF to default-ON in past minors but stale Default-OFF wording lingered in source comments and feature docs. Companion to #768 (which fixed the same drift inside
retrieve_v2's docstring).use_bm25f_anchorsuse_hrr_structuraluse_intentional_clusteringChanges (3 atomic commits)
src/aelfrice/retrieval.py—BM25F_FLAGandINTENTIONAL_CLUSTERING_FLAGblock-comments updated. Cite the cleared gate, list opt-out paths.docs/feature-hrr-integration.md— three spots reframed: "Problem" lede (now historical),hrr_index.pybullet, and "Default-flip flag" §. The doc was a v2.1 spec proposal; its pre-flip framing is now historical.docs/feature-intentional-clustering.md— Status header + Configuration §4 precedence-list item updated to cite the cleared gate.Out of scope (intentionally not touched):
bfs_enabled— still default-OFF, gated on Flip default: bfs_enabled (L2 graph-walk lane) on by default — gated on v3.0 latency bench re-run #739.use_type_aware_compression— still default-OFF, gated on Flip default: use_type_aware_compression on by default — gated on A2 + A4 bench run #769.Test plan
git diffshows comment- and prose-only changes; no logic touched.Refs
retrieve_v2.benchmarks/results/v2.0.0.jsonis canonical,uv sync && aelf bench all#437 — reproducibility harness.