Skip to content

docs: add "What is ordinal retrieval" framing to README#245

Merged
project-navi-bot merged 2 commits into
mainfrom
docs/readme-ordinal-retrieval
Jun 16, 2026
Merged

docs: add "What is ordinal retrieval" framing to README#245
project-navi-bot merged 2 commits into
mainfrom
docs/readme-ordinal-retrieval

Conversation

@Fieldnote-Echo

Copy link
Copy Markdown
Owner

What

Adds a ## What is ordinal retrieval section near the top of the README, above ## Benchmark at a glance.

The README previously jumped straight from what the crate is to the benchmark without ever stating the underlying idea. This supplies that frame, so the top now reads tagline → what the crate is → what the idea is → proof.

Content

Ordinal retrieval is a retrieval family where the index operates on order/sign quotients of embedding coordinates rather than metric magnitudes, with training-free compression, quotient-aware candidate generation, and asymmetric reranking against the original query signal.

Dense retrieval assumes magnitude geometry is the primitive. Ordinal retrieval asks what survives when embeddings are quotiented down to coordinate order, signs, and relative salience. Surprisingly, enough retrieval signal survives to match dense qrel quality at much smaller storage, and those quotients support quotient-aware candidate-generation rules that are training-free, append-friendly, and graph-optional.

Notes

  • Adopts the "ordinal retrieval is a retrieval family" framing (contrasted with dense) as the public positioning.
  • The "matches dense qrel quality at much smaller storage" line restates the existing in-repo BEIR result — it sits right above the hero blockquote that quantifies it (within BEIR qrel noise at 8–16× smaller) — not a paper number.
  • Candidate-generation rules described as "quotient-aware" (not "new") to stay consistent with the README's existing FastScan / binary-quantization-lineage humility.

Test plan

  • Prose-only change; the new section adds no code fences, so no doctests are introduced. CI markdown/link checks should pass.

Add a top-level conceptual frame above "## Benchmark at a glance" so the
README reads define-the-idea -> prove-it. It previously jumped straight
from "what the crate is" to the benchmark without ever stating the idea;
this states what ordinal retrieval is (the index operates on order/sign
quotients of embedding coordinates rather than metric magnitudes;
training-free compression, quotient-aware candidate generation, asymmetric
rerank) right before the benchmark evidence.

The "matches dense qrel quality at much smaller storage" line restates the
existing in-repo BEIR result (the hero claim immediately below it), not a
new or paper number.

Signed-off-by: Nelson Spence <nelson@projectnavi.ai>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Docs: add "What is ordinal retrieval" framing near top of README
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description

• Add a high-level "What is ordinal retrieval" section before the benchmark
• Explain ordinal vs dense retrieval in terms of order/sign quotients and reranking
• Clarify that the quality/storage claim restates the existing BEIR result
High-Level Assessment

Adding a short conceptual framing section immediately before the benchmark is the most effective approach for onboarding and avoids introducing new technical surfaces (e.g., diagrams or additional docs pages). Alternatives like a separate docs page or a longer tutorial would add navigation/maintenance overhead without improving the README’s above-the-fold clarity.

Files changed (1) +14 / -0

Documentation (1) +14 / -0
README.mdIntroduce an ordinal-retrieval conceptual framing section +14/-0

Introduce an ordinal-retrieval conceptual framing section

• Adds a new top-level section ("What is ordinal retrieval") above the benchmark to define ordinal retrieval, contrast it with dense retrieval, and summarize key properties (training-free compression, quotient-aware candidate generation, asymmetric reranking). Keeps the existing benchmark claim as the supporting evidence immediately below.

README.md

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Qodo Logo

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to include a new section explaining the concept of ordinal retrieval. The review feedback suggests minor improvements to this section, specifically adding a question mark to the new heading for grammatical completeness and replacing 'order/sign' with 'ordinal and sign' to maintain consistency with the rest of the document.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md Outdated
Comment thread README.md
gemini review nit (PR #245): the heading is phrased as a question, so the
trailing ? is grammatically correct.

Signed-off-by: Nelson Spence <nelson@projectnavi.ai>
@project-navi-bot project-navi-bot self-requested a review June 16, 2026 20:14
@project-navi-bot project-navi-bot merged commit 809a328 into main Jun 16, 2026
30 checks passed
@project-navi-bot project-navi-bot deleted the docs/readme-ordinal-retrieval branch June 16, 2026 20:18
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