README

indexing/README.md

@@ -0,0 +1,48 @@
+# indexing
+
+Local semantic search over a folder of text + images. Two FAISS indexes, queried per modality.
+
+## Install
+
+```bash
+pip install -r requirements.txt
+```
+
+## Build the index
+
+```bash
+python index.py /path/to/folder
+```
+
+Writes `index_data/text.faiss`, `index_data/image.faiss`, and matching `*_meta.json`.
+
+## Query (CLI)
+
+```bash
+python query.py "your query"              # all modalities
+python query.py "your query" 10           # top_k = 10
+python query.py "your query" -m text      # text only
+python query.py "your query" -m image     # image only
+python query.py "your query" -m text,image
+```
+
+## Query (Python)
+
+```python
+from searchers import SEARCHERS
+
+SEARCHERS["text"]("your query", top_k=5)   # -> [(score, path), ...]
+SEARCHERS["image"]("your query", top_k=5)
+```
+
+## Add a modality
+
+1. Create `searchers/<name>.py` exposing `search_<name>(query: str, top_k: int) -> list[tuple[float, str]]`.
+2. Register it in `searchers/__init__.py`:
+
+   ```python
+   from .audio import search_audio
+   SEARCHERS["audio"] = search_audio
+   ```
+
+It's then available in both the CLI (`-m audio`) and the `SEARCHERS` mapping.