From 88651a42d20bf5f2d99a60532c107308bff5375b Mon Sep 17 00:00:00 2001 From: Yiorgis Gozadinos Date: Tue, 28 Jul 2026 17:54:13 +0300 Subject: [PATCH] Fix packaging and settings facts in the docs `docs/installation.md` claimed the full package contained every extra. It pulls `docling`, `voyageai`, `cohere`, `zeroentropy`, `cross-encoder` and `tui`, so `jina`, `s3` and `ingester` need installing separately. Without `jina`, `provider: jina-local` falls back to no reranking. Anthropic is not built in, and only the slim Docker image is published. `docs/tuning.md` pointed at `claim_timeout_s`, which `WorkerConfig` now rejects. --- CHANGELOG.md | 2 ++ docs/installation.md | 25 +++++++++++++++++++------ docs/tuning.md | 2 +- 3 files changed, 22 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 70ecb1d7..1c0d0637 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ - `Store.set_haiku_version` stamps the store's own config into a recreated settings row instead of the process-global `Config`. - `check_source_accessible` returns `False` for a URI it cannot resolve (unparseable host, unreadable path) instead of raising and aborting a full rebuild. - `evaluations run` opens the database read-only outside the population phase, so an embedder identity differing from the stored one warns instead of aborting the run. +- `docs/installation.md` documents the `jina`, `s3` and `ingester` extras, names the extras the full package actually pulls, drops the removed MixedBread AI reranker, and no longer lists Anthropic as a built-in provider. +- `docs/tuning.md` no longer points at the removed `claim_timeout_s` setting. ### Removed diff --git a/docs/installation.md b/docs/installation.md index 9553622e..5645eee5 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -10,10 +10,17 @@ uv pip install haiku.rag ``` -The full package includes **all features and extras**: +The full package pulls the `docling`, `voyageai`, `cohere`, `zeroentropy`, `cross-encoder` and `tui` extras: - **Document processing** (Docling) - PDF, DOCX, PPTX, images, and 40+ file formats -- **All embedding providers** - VoyageAI -- **All rerankers** - MixedBread AI, Cohere, Zero Entropy +- **Embedding providers** - VoyageAI and Cohere +- **Rerankers** - local cross-encoders, local Jina, Cohere, Zero Entropy + +It does not include the `s3` or `ingester` extras: + +```bash +uv pip install 'haiku.rag[ingester]' # the haiku-ingester service +uv pip install 'haiku.rag[s3]' # S3 and object storage +``` ### Slim Package (Minimal Dependencies) @@ -33,14 +40,20 @@ The slim package has minimal dependencies and lets you install only what you nee - `docling` - PDF, DOCX, PPTX, images, and other document formats - `voyageai` - VoyageAI embeddings - `cross-encoder` - Local reranking via sentence-transformers -- `cohere` - Cohere reranking +- `jina` - Local Jina reranking (`provider: jina-local`). Needs transformers and torch, which `cross-encoder` also pulls +- `cohere` - Cohere embeddings and reranking - `zeroentropy` - Zero Entropy reranking +- `s3` - S3 and object-storage access +- `ingester` - The `haiku-ingester` service (also pulls `s3`) - `tui` - Terminal UI for `chat` and `inspect` commands **Built-in providers** (no extras needed): - **Ollama** (default embedding provider) - **OpenAI** (GPT models for QA and embeddings) -- **Anthropic** (Claude models for QA) +- **vLLM** and other OpenAI-compatible endpoints (embeddings, QA, reranking) +- **Jina** reranking via `provider: jina`, which calls the Jina HTTP API + +Other Pydantic AI providers need their own Pydantic AI extra. For Claude models, install `pydantic-ai-slim[anthropic]`. See [Configuration](configuration/index.md) for configuring providers including advanced options like vLLM. @@ -74,7 +87,7 @@ See [Remote processing](remote-processing.md) for setup instructions and [Docume ## Docker -Two Docker images are available: +Only the slim image is published. Build the full image yourself: ### Slim Image (Minimal) diff --git a/docs/tuning.md b/docs/tuning.md index 1843dfa9..b4160d7b 100644 --- a/docs/tuning.md +++ b/docs/tuning.md @@ -2,7 +2,7 @@ How to adjust haiku.rag's pipeline for better retrieval and answer quality. For individual setting definitions and defaults, see [Configuration](configuration/index.md). -For ingester-side tuning (worker count, claim timeout, retry policy, backpressure, circuit breakers), see [Ingester → Workers and retry](ingester.md#workers-and-retry). +For ingester-side tuning (worker count, lease TTL and heartbeat, retry policy, backpressure, circuit breakers), see [Ingester → Workers and retry](ingester.md#workers-and-retry). ## Pipeline Overview