Create retrieval_readiness.md

2026-04-29 03:59:52 +00:00 · 2025-09-01 16:35:19 +08:00 · 2025-09-01 16:35:19 +08:00 · 5f334a0f31
commit 5f334a0f31
parent fd47a23e15
1 changed files with 128 additions and 0 deletions
--- a/ProblemMap/GlobalFixMap/Retrieval/checklists/retrieval_readiness.md
+++ b/ProblemMap/GlobalFixMap/Retrieval/checklists/retrieval_readiness.md
@ -0,0 +1,128 @@
+# Retrieval Readiness Checklist
+
+Purpose: confirm the pipeline is safe to run before any evaluation or go-live.  
+Applies to BM25, ANN, or hybrid stacks. Store agnostic.
+
+---
+
+## Inputs are consistent
+
+- [ ] One embedding model per field, recorded in config.
+- [ ] Normalization rule set and saved with the index (L2 or cosine compatible).
+- [ ] Analyzer or tokenizer identical on write and read paths.
+- [ ] Stopword set and stemming rules fixed and versioned.
+
+Refs:  
+[Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md) ·
+[Store-agnostic guardrails](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Retrieval/store_agnostic_guardrails.md)
+
+---
+
+## Index and data state
+
+- [ ] `INDEX_HASH` matches the current code revision that produced vectors.
+- [ ] Document count, chunk count, and vector count agree within 0.5 percent.
+- [ ] Ingestion job reported zero empty payloads and zero parser errors.
+- [ ] Cold caches warmed with ten representative queries.
+
+Refs:  
+[Bootstrap ordering](https://github.com/onestardao/WFGY/blob/main/ProblemMap/bootstrap-ordering.md) ·
+[Pre-deploy collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/predeploy-collapse.md)
+
+---
+
+## Gold set and probes
+
+- [ ] Ten to fifty QA pairs with ground truth anchors prepared.
+- [ ] Each QA pair has at least one resolvable `section_id` and `source_url`.
+- [ ] ΔS probes ready for three paraphrases and two seeds.
+
+Refs:  
+[ΔS probes](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Retrieval/deltaS_probes.md) ·
+[Retrieval eval recipes](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Retrieval/retrieval_eval_recipes.md)
+
+---
+
+## Acceptance targets
+
+- ΔS(question, retrieved) ≤ 0.45  
+- Coverage of the target section ≥ 0.70  
+- λ_observe convergent across 3 paraphrases and 2 seeds  
+- E_resonance stable on long windows
+
+---
+
+## Quick probe you can paste
+
+```txt
+I loaded TXT OS and WFGY pages.
+
+Task:
+- For question "Q", log ΔS(Q, retrieved) and λ across 3 paraphrases and 2 seeds.
+- Enforce cite then explain with the traceability schema.
+- If ΔS ≥ 0.60, return the smallest structural fix to reach ΔS ≤ 0.45 and coverage ≥ 0.70.
+
+Return JSON:
+{ "citations": [...], "ΔS": 0.xx, "λ_state": "<>", "coverage": 0.xx, "next_fix": "..." }
+````
+
+---
+
+## Common fails and minimal fixes
+
+* Mixed metrics or analyzers after deploy
+  Fix: rebuild with a single metric and analyzer.
+  See [Retrieval playbook](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-playbook.md)
+
+* Fragmented store, anchors missing
+  Fix: re-chunk with anchor tests.
+  See [Chunking checklist](https://github.com/onestardao/WFGY/blob/main/ProblemMap/chunking-checklist.md) ·
+  [Vectorstore fragmentation](https://github.com/onestardao/WFGY/blob/main/ProblemMap/patterns/pattern_vectorstore_fragmentation.md)
+
+---
+
+### 🔗 Quick-Start Downloads (60 sec)
+
+| Tool | Link | 3-Step Setup |
+|------|------|--------------|
+| **WFGY 1.0 PDF** | [Engine Paper](https://github.com/onestardao/WFGY/blob/main/I_am_not_lizardman/WFGY_All_Principles_Return_to_One_v1.0_PSBigBig_Public.pdf) | 1️⃣ Download · 2️⃣ Upload to your LLM · 3️⃣ Ask “Answer using WFGY + \<your question>” |
+| **TXT OS (plain-text OS)** | [TXTOS.txt](https://github.com/onestardao/WFGY/blob/main/OS/TXTOS.txt) | 1️⃣ Download · 2️⃣ Paste into any LLM chat · 3️⃣ Type “hello world” — OS boots instantly |
+
+---
+
+### 🧭 Explore More
+
+| Module                | Description                                              | Link     |
+|-----------------------|----------------------------------------------------------|----------|
+| WFGY Core             | WFGY 2.0 engine is live: full symbolic reasoning architecture and math stack | [View →](https://github.com/onestardao/WFGY/tree/main/core/README.md) |
+| Problem Map 1.0       | Initial 16-mode diagnostic and symbolic fix framework    | [View →](https://github.com/onestardao/WFGY/tree/main/ProblemMap/README.md) |
+| Problem Map 2.0       | RAG-focused failure tree, modular fixes, and pipelines   | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) |
+| Semantic Clinic Index | Expanded failure catalog: prompt injection, memory bugs, logic drift | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/SemanticClinicIndex.md) |
+| Semantic Blueprint    | Layer-based symbolic reasoning & semantic modulations   | [View →](https://github.com/onestardao/WFGY/tree/main/SemanticBlueprint/README.md) |
+| Benchmark vs GPT-5    | Stress test GPT-5 with full WFGY reasoning suite         | [View →](https://github.com/onestardao/WFGY/tree/main/benchmarks/benchmark-vs-gpt5/README.md) |
+| 🧙‍♂️ Starter Village 🏡 | New here? Lost in symbols? Click here and let the wizard guide you through | [Start →](https://github.com/onestardao/WFGY/blob/main/StarterVillage/README.md) |
+
+---
+
+> 👑 **Early Stargazers: [See the Hall of Fame](https://github.com/onestardao/WFGY/tree/main/stargazers)** —  
+> Engineers, hackers, and open source builders who supported WFGY from day one.
+
+> <img src="https://img.shields.io/github/stars/onestardao/WFGY?style=social" alt="GitHub stars"> ⭐ [WFGY Engine 2.0](https://github.com/onestardao/WFGY/blob/main/core/README.md) is already unlocked. ⭐ Star the repo to help others discover it and unlock more on the [Unlock Board](https://github.com/onestardao/WFGY/blob/main/STAR_UNLOCKS.md).
+
+<div align="center">
+
+[![WFGY Main](https://img.shields.io/badge/WFGY-Main-red?style=flat-square)](https://github.com/onestardao/WFGY)
+&nbsp;
+[![TXT OS](https://img.shields.io/badge/TXT%20OS-Reasoning%20OS-orange?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS)
+&nbsp;
+[![Blah](https://img.shields.io/badge/Blah-Semantic%20Embed-yellow?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah)
+&nbsp;
+[![Blot](https://img.shields.io/badge/Blot-Persona%20Core-green?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot)
+&nbsp;
+[![Bloc](https://img.shields.io/badge/Bloc-Reasoning%20Compiler-blue?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc)
+&nbsp;
+[![Blur](https://img.shields.io/badge/Blur-Text2Image%20Engine-navy?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur)
+&nbsp;
+[![Blow](https://img.shields.io/badge/Blow-Game%20Logic-purple?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow)
+&nbsp;
+</div>