Generated by Code IQ · v1.0

qmd
Knowledge Tutorial

QMD is an on-device search engine designed to index and retrieve knowledge from markdown notes, documentation, and transcripts using a hybrid approach. It combines keyword search (BM25), vector semantic search, and LLM-based re-ranking into a unified pipeline that runs locally. The project includes a fine-tuning workflow to train custom query expansion models and exposes its capabilities to external AI agents via the Model Context Protocol (MCP).

6
Chapters
-
Subsystems
Rabbit Holes
▶ Start Reading ⎇ View on GitHub
System Architecture

How the pieces fit

qmd is organized as connected concepts and components. Start broad, then drill down chapter by chapter.

⚙️
Hybrid Search Orchestrator
Hybrid Search Orchestrator
⚙️
Local AI Service
Local AI Service
⚙️
Cross-Runtime Persistence
Cross-Runtime Persistence
🔌
Model Context Protocol (MCP) Server
Model Context Protocol (MCP) Server
⚙️
Reward & Evaluation Logic
Reward & Evaluation Logic
⚙️
Fine-Tuning Pipeline
Fine-Tuning Pipeline
qmd — bash
open tutorial
◆ Scanning numbered chapters
◆ Building navigation and Mermaid diagrams
◆ Generating chapter and subsystem pages
✓ 6 chapter pages built
✓ Theme toggle enabled
Repository Overview

Intro and Architecture Diagram

QMD is an on-device search engine designed to index and retrieve knowledge from markdown notes, documentation, and transcripts using a hybrid approach. It combines keyword search (BM25), vector semantic search, and LLM-based re-ranking into a unified pipeline that runs locally. The project includes a fine-tuning workflow to train custom query expansion models and exposes its capabilities to external AI agents via the Model Context Protocol (MCP).

Source Repository: https://github.com/tobi/qmd

flowchart TD A0["Hybrid Search Orchestrator"] A1["Local AI Service"] A2["Model Context Protocol (MCP) Server"] A3["Fine-Tuning Pipeline"] A4["Reward & Evaluation Logic"] A5["Cross-Runtime Persistence"] A0 -->|"Delegates inference tasks"| A1 A0 -->|"Persists index data"| A5 A2 -->|"Exposes search tools"| A0 A3 -->|"Optimizes via reward"| A4 A3 -->|"Exports models for"| A1 A4 -->|"Benchmarks performance"| A0
Tutorial Chapters

All 6 chapters

Follow sequentially or jump to any topic. Start with Hybrid Search Orchestrator.

About This Project

Generated by Code IQ

This tutorial was automatically generated by Code IQ and rendered with the shared tutorial site builder. It can be produced for any repository tutorial folder that follows the numbered markdown chapter layout.

View Code IQ ↗
python build_site.py '/home/runner/work/Code-IQ/Code-IQ/output/qmd'

// → 6 chapters
// → source: tobi/qmd