Re-ranking lab
Ship and explain the reversible re-ranker rollout
Page 8 advances one concrete hybrid retrieve-and-rerank pipeline: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.
Before you start
Why this matters
Predict the rollback switch for the hybrid retrieve-and-rerank pipeline and what would make that rollback incomplete even if the process restarts cleanly.
1Learn the idea
Read
Build focus
The final artifact is cross-encoder re-ranker with canary traffic and RERANK_ENABLED kill switch. A reviewer should be able to reproduce the demo from one command, see the expected result, run the checks, and find the known limitations. Shipping means the intended case is measurable, failures are legible, and the previous working artifact remains recoverable.
Pin the model revision, warm it at startup, canary a percentage of traffic, watch fallback rate, and disable with RERANK_ENABLED=false while hybrid retrieval continues.
The artifact's user-facing goal is specific: put the most query-relevant evidence first for mixed exact-ID and paraphrase questions. Its accepted input is a query string plus lexical and vector candidate lists with stable chunk IDs. Those statements are intentionally narrower than “build an AI system.” Narrow scope lets us inspect every input and expected result, and it prevents a toy result from being presented as a production claim. System shape for this chapter: a lexical retriever preserves exact identifiers such as ERR-502, a vector retriever catches paraphrases, reciprocal-rank fusion creates twenty unique candidates, and a cross-encoder jointly reads each query-chunk pair before the prompt receives the best five. Keep model calls behind adapters, keep authorization and validation in deterministic code, and carry stable IDs and versions through every response. That separation lets you decide whether a bad result came from input handling, retrieval, inference, validation, or deployment. This page's job is the mastery and shipping step: the final artifact is cross-encoder re-ranker with canary traffic and rerank_enabled kill switch. Setup baseline for the chapter (run once per machine, not secrets in git):
python -m venv .venv && source .venv/bin/activate
pip install sentence-transformers rank-bm25 numpy
If hardware or a hosted provider differs, preserve the interface and expected behavior. Do not present provider syntax as universal—when a vendor adapter is unavoidable, keep it behind a thin boundary and test with a fake first. The deliverable is not “it ran once”; it is a reproducible artifact another developer can inspect, including expected output and one deliberate failure related to exact SKU miss or silent duplicate candidates. Operationally, write down the owner of this stage, the command you ran, the observed output, and the next page's dependency on that output. If you cannot point to a file, fixture, metric, or config key, the stage is not done. Prefer small, reviewable increments: one contract, one path, one metric, one failure, one gate. When tradeoffs appear—latency versus quality, hit rate versus false hits, local privacy versus cloud quality—record both numbers instead of moving the threshold until the report looks green. The chapter ships only when evidence for nDCG@5 improves by at least 0.05 versus vector-only while added p95 latency stays under 120 ms and a rehearsed recovery path exist beside cross-encoder re-ranker with canary traffic and RERANK_ENABLED kill switch.
Read
Run the example
Save this as lesson.py and run python3 lesson.py. Prefer the standard library or the pinned packages from the setup block so the example stays reproducible.
release={"RERANK_ENABLED":True,"model":"cross-encoder/ms-marco-MiniLM-L-6-v2","ndcg_delta":0.07,"rollback":"RERANK_ENABLED=false"}
assert release["ndcg_delta"]>=0.05
print(release)
Expected output: release record with kill switch. Exact floating-point formatting may vary slightly, but the asserted behavior must not. Read the output as evidence about this stage, not merely proof that the interpreter started.
Read
Debug the stage
Rehearse rollback and readiness. If app code rolls back but model/index/adapter pins do not, the release unit was incomplete. At the mastery and shipping stage, save the smallest failing fixture beside the expected result. Change one cause at a time and rerun the exact command printed above; that makes the repair reviewable and keeps this chapter's progressive artifact reproducible.
Read
Evaluate before continuing
Ship only when checks, evidence, and rollback rehearsal are green on the same pins. For this mastery and shipping page, preserve the fixture and result as evidence for the next page. Label observations separately from conclusions: a passing assertion establishes the behavior it names, while broader usefulness requires the chapter's full evaluation set and stated operating limits. Primary metrics for the chapter remain nDCG@5 improves by at least 0.05 versus vector-only while added p95 latency stays under 120 ms.
Continue learning · glossary & guides
- [ ] Can a second person run the demo without coaching?
- [ ] Are expected output, evaluation evidence, and limitations visible?
- [ ] Has the failure and recovery path been rehearsed?
- [ ] Is the shipped unit exactly: cross-encoder re-ranker with canary traffic and RERANK_ENABLED kill switch?
Glossary: re-ranking · Glossary: cross-encoder · Cheatsheet: rerank patterns