Skip to content

mnelo v0.1.1 — Documentation update

Choose a tag to compare

@chinesewebman chinesewebman released this 18 Jul 14:52

"# mnelo v0.1.1 — Documentation update\n\nDocs-only patch bump. No code or API changes — this release makes mnelo easier to discover and to install.\n\n## What changed\n\n### Top-of-README blurb\n- New "Why 4-way recall wins" paragraph on the README landing — explains in one read what each lane catches (vector misses literals like stock codes, meta misses semantic paraphrases, graph misses orphaned chunks, entity misses long-form prose), why RRF fuses them without score normalization, and links down to the math + latency numbers.\n- GitHub repo description rewritten from a flat tech-stack list to a hook that names real use cases: "The memory layer that remembers your stock picks, your wife's birthday, AND where you left your keys."\n\n### RRF finally explained\n- New "🔀 What is RRF?" section after At a glance. Cormack et al. 2009 paper link, a worked 3-lane example with hand-computed scores, and a side-by-side comparison table vs weighted-score fusion (normalization cost, robustness, extensibility, LOC). Closes the "RRF mentioned 5 times, defined 0 times" gap in v0.1.\n\n### Install fixed\n- Quick start now runs cd mnelo after git clone (v0.1 silently piped pip install into system Python) and adds a venv step.\n- New "🤖 One-line agent install" subsection — a copy-paste prompt for Hermes / Claude / Cursor / Codex that handles venv + plist + health probe. Typical install: ~90s (bge-small-zh model download is the slow part, ~95 MB).\n\n### Embedding model links\n- BAAI/bge-small-en-v1.5 now linked in both Acknowledgements and Known limitations (was bare text in v0.1). Swap target is now discoverable from the README without opening HuggingFace.\n\n### Bilingual parity\n- Every change above is mirrored in README.zh.md. No drift.\n\n## Diff\n\n\nREADME.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++--------\nREADME.zh.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++-----\n2 files changed, 103 insertions(+), 13 deletions(-)\n\n\n## Upgrade notes\n\nNo action required. Re-pull, re-read the README, profit.\n\n## Languages / 语言\n\n- English: see README.md\n- 中文: see README.zh.md\n\n## Install (unchanged from v0.1)\n\nbash\ngit clone https://github.com/chinesewebman/mnelo.git\ncd mnelo\npip install \"mcp[cli]>=1.26.0\" \"sqlite-vec>=0.1.9\" \"fastembed>=0.8.0\"\npython scripts/init_db.py\n\n\n## License\n\nMIT"