hydrag-benchmark 0.5.0__tar.gz

hydrag_benchmark-0.5.0/.gitignore

@@ -0,0 +1,28 @@
+dist/
+build/
+.ruff_cache/
+*.egg-info/
+*.egg
+.eggs/
+*.so
+*.onnx
+.env
+.venv/
+*.whl
+__pycache__/
+*.pyc
+.mypy_cache/
+.pytest_cache/
+# Local benchmark results
+beir-results/
+# Dev scripts
+run_beir_save.py
+*.whl
+__pycache__/
+*.pyc
+.mypy_cache/
+.pytest_cache/
+# Scratch dev scripts
+test_pool.py
+test_profile.py
+test_profile4.py

hydrag_benchmark-0.5.0/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to `hydrag-benchmark` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2026-03-18
+
+### Changed
+
+- **Doc2Query & AugmentationCache re-exported from hydrag-core** (T-746): `doc2query.py` and `augmentation_cache.py` are now thin re-export wrappers; canonical implementation lives in `hydrag.doc2query` (hydrag-core v1.2.0+). All existing imports remain backward-compatible.
+- Package version bumped to `0.5.0`.
+
+## [0.4.0] - 2026-03-18
+
+### Changed
+
+- Minor version bump for hydrag-core v1.2.0 compatibility.
+
+## [0.3.0] - 2026-03-15
+
+### Added
+
+- `prefill` CLI command for Phase 1a Doc2Query cache population.
+- `multihead` CLI command for A/B/C configuration harness execution.
+- GPU optional extra (`hydrag-benchmark[gpu]`) for transformers-based embedding path.
+- New benchmark suites: `k8s-kep.yaml` and `cpython-stdlib.yaml`.
+
+### Changed
+
+- Package version bumped to `0.3.0`.
+- README updated for complete CLI argument, config, and artifact-path parity.
+
+## [0.2.0] - 2026-03-15
+
+### Added
+
+- Strategy-aware dispatch: `similarity`, `hybrid`, `crag`, `hydrag` each route
+  through appropriate hydrag-core retrieval heads.
+- `_ChromaDBAdapter` implementing `VectorStoreAdapter` protocol for hydrag-core
+  integration.
+- `SUPPORTED_STRATEGIES` and `_STRATEGY_HEADS` constants in `runner.py`.
+- 13 new strategy dispatch tests (`test_strategy.py`).
+- CI job with pytest + smoke benchmark + recall gate (`recall_at_k >= 0.5`).
+
+### Changed
+
+- `_search_fn` replaced with strategy-aware dispatch (was direct ChromaDB query).
+
+## [0.1.0] - 2026-03-14
+
+### Added
+
+- Initial release.
+- `hydrag-bench` CLI with `run` and `list-suites` subcommands.
+- Benchmark suite YAML format with versioned schema.
+- Frozen v0.1 metrics: `recall_at_1`, `recall_at_k`, `mrr`, `chunk_overlap`,
+  `latency_ms` (avg, p50, p95, p99).
+- Versioned JSON output schema (`schema_version: "0.1"`).
+- Synthetic smoke-test suite (`suites/synthetic-smoke.yaml`).
+- PEP 561 `py.typed` marker for type-checked consumers.
+- 30 unit tests covering runner, metrics, CLI, and suite parsing.

hydrag_benchmark-0.5.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided alongside the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Studio Playbook Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hydrag_benchmark-0.5.0/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: hydrag-benchmark
+Version: 0.5.0
+Summary: Local-only RAG benchmarking CLI — measures recall, MRR, chunk overlap, latency, and BEIR IR metrics
+Project-URL: Homepage, https://github.com/studio-playbook/hydrag-benchmark
+Project-URL: Documentation, https://github.com/studio-playbook/hydrag-benchmark#readme
+Project-URL: Repository, https://github.com/studio-playbook/hydrag-benchmark
+Project-URL: Changelog, https://github.com/studio-playbook/hydrag-benchmark/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/studio-playbook/hydrag-benchmark/issues
+Author: Studio Playbook Contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,hydrag,mrr,rag,recall,retrieval
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: hydrag-core[chromadb]
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: gpu
+Requires-Dist: torch>=2.0; extra == 'gpu'
+Requires-Dist: transformers>=4.40; extra == 'gpu'
+Description-Content-Type: text/markdown
+
+# hydrag-benchmark
+
+Local-only RAG benchmarking CLI for retrieval quality and latency analysis.
+
+## Installation
+
+```bash
+pip install hydrag-benchmark
+```
+
+Optional GPU path for multi-head dense embeddings:
+
+```bash
+pip install "hydrag-benchmark[gpu]"
+```
+
+## Included Suites
+
+- `suites/synthetic-smoke.yaml`
+- `suites/k8s-kep.yaml`
+- `suites/cpython-stdlib.yaml`
+
+## Quickstart
+
+```bash
+# List shipped suites
+hydrag-bench list-suites --suite-dir ./suites
+
+# Run classic strategy benchmark
+hydrag-bench run suites/synthetic-smoke.yaml \
+  --strategy hydrag \
+  --corpus-dir ./my-codebase/src \
+  --output-dir ./results
+
+# Inspect output
+python -m json.tool ./results/synthetic-smoke_hydrag.json
+```
+
+## Commands
+
+```bash
+hydrag-bench --help
+hydrag-bench --version
+
+# 1) Classic single-strategy benchmark
+hydrag-bench run <suite.yaml> --strategy <similarity|hybrid|crag|hydrag> --corpus-dir <path> [options]
+
+# 2) List suites
+hydrag-bench list-suites --suite-dir <path>
+
+# 3) Prefill Doc2Query cache (Phase 1a)
+hydrag-bench prefill --corpus-dir <path> [options]
+
+# 4) Multi-head harness benchmark (Heads A/B/C)
+hydrag-bench multihead <suite.yaml> --corpus-dir <path> [options]
+```
+
+### `run` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `suite` | yes | - | Path to benchmark suite YAML |
+| `--strategy` | yes | - | One of `similarity`, `hybrid`, `crag`, `hydrag` |
+| `--corpus-dir` | yes | - | Root directory of files to index |
+| `--output-dir` | no | stdout | Directory to write `<suite>_<strategy>.json` |
+| `--suite-dir` | no | - | Base dir for resolving relative `suite` path |
+| `--n-results` | no | `5` | Top-k retrieval depth |
+| `--seed` | no | `42` | Seed override |
+| `--embedding-model` | no | `Alibaba-NLP/gte-Qwen2-7B-instruct` | Embedding model label passed to runner |
+| `--db-path` | no | temp dir | ChromaDB persistence path |
+
+### `list-suites` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `--suite-dir` | yes | - | Directory containing `.yaml` / `.yml` suites |
+
+### `prefill` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `--corpus-dir` | yes | - | Root directory to chunk and process |
+| `--doc2query-model` | no | `qwen3:4b` | Doc2Query model name |
+| `--doc2query-api-url` | no | `http://localhost:11434` | Doc2Query API base URL |
+| `--doc2query-timeout-s` | no | `30.0` | Request timeout seconds |
+| `--doc2query-max-retries` | no | `2` | Retry attempts after first failure |
+| `--doc2query-n-questions` | no | `3` | Synthetic questions per chunk |
+| `--cache-dir` | no | in-memory only | Directory containing `augmentation_cache.json` |
+
+### `multihead` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `suite` | yes | - | Path to benchmark suite YAML |
+| `--corpus-dir` | yes | - | Root directory of files to index |
+| `--output-dir` | no | stdout | Directory to write `<suite>_multihead.json` and sidecar |
+| `--suite-dir` | no | - | Base dir for resolving relative `suite` path |
+| `--n-results` | no | `5` | Top-k retrieval depth |
+| `--seed` | no | `42` | Seed override |
+| `--use-gpu` | no | `false` | Use transformers embedder (requires `[gpu]`) |
+| `--doc2query-model` | no | `qwen3:4b` | Doc2Query model name |
+| `--doc2query-api-url` | no | `http://localhost:11434` | Doc2Query API base URL |
+| `--doc2query-timeout-s` | no | `30.0` | Request timeout seconds |
+| `--doc2query-max-retries` | no | `2` | Retry attempts after first failure |
+| `--doc2query-n-questions` | no | `3` | Synthetic questions per chunk |
+| `--embedding-model` | no | `Alibaba-NLP/gte-Qwen2-7B-instruct` | Dense embedding model name |
+| `--alpha` | no | `0.5` | Head C rerank interpolation weight |
+| `--cache-dir` | no | none | Directory for `augmentation_cache.json` persistence |
+
+## Config Variables and Runtime Inputs
+
+- `hydrag-benchmark` does not read `HYDRAG_BENCHMARK_*` environment variables.
+- Operator-facing runtime configuration is via CLI flags and suite YAML fields.
+- Suite-level fields consumed by code:
+  - top-level: `name`, `version`, `seed`, `description`, `cases`
+  - `environment`: `strategy`, `n_results`
+
+## File Paths and Artifacts
+
+| Path / Pattern | Producer | Meaning |
+|----------------|----------|---------|
+| `<output-dir>/<suite>_<strategy>.json` | `run` | Single-strategy result JSON (`schema_version: 0.1`) |
+| `<output-dir>/<suite>_multihead.json` | `multihead` | Multi-head comparison matrix (`schema_version: 0.2`) |
+| `<output-dir>/questions_sidecar.json` | `multihead` | Head B generated questions sidecar |
+| `<cache-dir>/augmentation_cache.json` | `prefill` / `multihead` | 3-state Doc2Query cache shared across phases |
+| `<db-path>` | `run` | ChromaDB persistent store location |
+
+## Output Schemas
+
+- `run` emits schema `0.1` with per-case and aggregate metrics.
+- `multihead` emits schema `0.2` with 5 config groups:
+  - `A-only`
+  - `B-only`
+  - `C-only`
+  - `A+B`
+  - `A+B+C`
+
+## Frozen 0.1 Metrics
+
+| Metric | Description |
+|--------|-------------|
+| `recall_at_1` | 1.0 when top result includes a relevant phrase |
+| `recall_at_k` | Fraction of relevant phrases found in top-k |
+| `mrr` | Mean Reciprocal Rank of first relevant result |
+| `chunk_overlap` | Token overlap between retrieved chunks and relevant phrases |
+| `latency_ms.avg` | Mean latency in milliseconds |
+| `latency_ms.p50` | 50th percentile latency |
+| `latency_ms.p95` | 95th percentile latency |
+| `latency_ms.p99` | 99th percentile latency |
+
+## Suite YAML Format
+
+```yaml
+name: my-benchmark
+version: "1.0"
+seed: 42
+description: Description of the benchmark suite.
+
+environment:
+  strategy: hydrag
+  n_results: 5
+
+cases:
+  - id: case-001
+    query: "search query text"
+    relevant_phrases:
+      - "expected phrase in results"
+      - "another expected phrase"
+    tags: [optional, tags]
+```
+
+## Development
+
+```bash
+cd packages/hydrag-benchmark
+pip install -e ".[dev]"
+python -m pytest tests/ -v
+```
+
+## License
+
+Apache-2.0

hydrag_benchmark-0.5.0/README.md

@@ -0,0 +1,182 @@
+# hydrag-benchmark
+
+Local-only RAG benchmarking CLI for retrieval quality and latency analysis.
+
+## Installation
+
+```bash
+pip install hydrag-benchmark
+```
+
+Optional GPU path for multi-head dense embeddings:
+
+```bash
+pip install "hydrag-benchmark[gpu]"
+```
+
+## Included Suites
+
+- `suites/synthetic-smoke.yaml`
+- `suites/k8s-kep.yaml`
+- `suites/cpython-stdlib.yaml`
+
+## Quickstart
+
+```bash
+# List shipped suites
+hydrag-bench list-suites --suite-dir ./suites
+
+# Run classic strategy benchmark
+hydrag-bench run suites/synthetic-smoke.yaml \
+  --strategy hydrag \
+  --corpus-dir ./my-codebase/src \
+  --output-dir ./results
+
+# Inspect output
+python -m json.tool ./results/synthetic-smoke_hydrag.json
+```
+
+## Commands
+
+```bash
+hydrag-bench --help
+hydrag-bench --version
+
+# 1) Classic single-strategy benchmark
+hydrag-bench run <suite.yaml> --strategy <similarity|hybrid|crag|hydrag> --corpus-dir <path> [options]
+
+# 2) List suites
+hydrag-bench list-suites --suite-dir <path>
+
+# 3) Prefill Doc2Query cache (Phase 1a)
+hydrag-bench prefill --corpus-dir <path> [options]
+
+# 4) Multi-head harness benchmark (Heads A/B/C)
+hydrag-bench multihead <suite.yaml> --corpus-dir <path> [options]
+```
+
+### `run` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `suite` | yes | - | Path to benchmark suite YAML |
+| `--strategy` | yes | - | One of `similarity`, `hybrid`, `crag`, `hydrag` |
+| `--corpus-dir` | yes | - | Root directory of files to index |
+| `--output-dir` | no | stdout | Directory to write `<suite>_<strategy>.json` |
+| `--suite-dir` | no | - | Base dir for resolving relative `suite` path |
+| `--n-results` | no | `5` | Top-k retrieval depth |
+| `--seed` | no | `42` | Seed override |
+| `--embedding-model` | no | `Alibaba-NLP/gte-Qwen2-7B-instruct` | Embedding model label passed to runner |
+| `--db-path` | no | temp dir | ChromaDB persistence path |
+
+### `list-suites` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `--suite-dir` | yes | - | Directory containing `.yaml` / `.yml` suites |
+
+### `prefill` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `--corpus-dir` | yes | - | Root directory to chunk and process |
+| `--doc2query-model` | no | `qwen3:4b` | Doc2Query model name |
+| `--doc2query-api-url` | no | `http://localhost:11434` | Doc2Query API base URL |
+| `--doc2query-timeout-s` | no | `30.0` | Request timeout seconds |
+| `--doc2query-max-retries` | no | `2` | Retry attempts after first failure |
+| `--doc2query-n-questions` | no | `3` | Synthetic questions per chunk |
+| `--cache-dir` | no | in-memory only | Directory containing `augmentation_cache.json` |
+
+### `multihead` Arguments
+
+| Flag | Required | Default | Description |
+|------|----------|---------|-------------|
+| `suite` | yes | - | Path to benchmark suite YAML |
+| `--corpus-dir` | yes | - | Root directory of files to index |
+| `--output-dir` | no | stdout | Directory to write `<suite>_multihead.json` and sidecar |
+| `--suite-dir` | no | - | Base dir for resolving relative `suite` path |
+| `--n-results` | no | `5` | Top-k retrieval depth |
+| `--seed` | no | `42` | Seed override |
+| `--use-gpu` | no | `false` | Use transformers embedder (requires `[gpu]`) |
+| `--doc2query-model` | no | `qwen3:4b` | Doc2Query model name |
+| `--doc2query-api-url` | no | `http://localhost:11434` | Doc2Query API base URL |
+| `--doc2query-timeout-s` | no | `30.0` | Request timeout seconds |
+| `--doc2query-max-retries` | no | `2` | Retry attempts after first failure |
+| `--doc2query-n-questions` | no | `3` | Synthetic questions per chunk |
+| `--embedding-model` | no | `Alibaba-NLP/gte-Qwen2-7B-instruct` | Dense embedding model name |
+| `--alpha` | no | `0.5` | Head C rerank interpolation weight |
+| `--cache-dir` | no | none | Directory for `augmentation_cache.json` persistence |
+
+## Config Variables and Runtime Inputs
+
+- `hydrag-benchmark` does not read `HYDRAG_BENCHMARK_*` environment variables.
+- Operator-facing runtime configuration is via CLI flags and suite YAML fields.
+- Suite-level fields consumed by code:
+  - top-level: `name`, `version`, `seed`, `description`, `cases`
+  - `environment`: `strategy`, `n_results`
+
+## File Paths and Artifacts
+
+| Path / Pattern | Producer | Meaning |
+|----------------|----------|---------|
+| `<output-dir>/<suite>_<strategy>.json` | `run` | Single-strategy result JSON (`schema_version: 0.1`) |
+| `<output-dir>/<suite>_multihead.json` | `multihead` | Multi-head comparison matrix (`schema_version: 0.2`) |
+| `<output-dir>/questions_sidecar.json` | `multihead` | Head B generated questions sidecar |
+| `<cache-dir>/augmentation_cache.json` | `prefill` / `multihead` | 3-state Doc2Query cache shared across phases |
+| `<db-path>` | `run` | ChromaDB persistent store location |
+
+## Output Schemas
+
+- `run` emits schema `0.1` with per-case and aggregate metrics.
+- `multihead` emits schema `0.2` with 5 config groups:
+  - `A-only`
+  - `B-only`
+  - `C-only`
+  - `A+B`
+  - `A+B+C`
+
+## Frozen 0.1 Metrics
+
+| Metric | Description |
+|--------|-------------|
+| `recall_at_1` | 1.0 when top result includes a relevant phrase |
+| `recall_at_k` | Fraction of relevant phrases found in top-k |
+| `mrr` | Mean Reciprocal Rank of first relevant result |
+| `chunk_overlap` | Token overlap between retrieved chunks and relevant phrases |
+| `latency_ms.avg` | Mean latency in milliseconds |
+| `latency_ms.p50` | 50th percentile latency |
+| `latency_ms.p95` | 95th percentile latency |
+| `latency_ms.p99` | 99th percentile latency |
+
+## Suite YAML Format
+
+```yaml
+name: my-benchmark
+version: "1.0"
+seed: 42
+description: Description of the benchmark suite.
+
+environment:
+  strategy: hydrag
+  n_results: 5
+
+cases:
+  - id: case-001
+    query: "search query text"
+    relevant_phrases:
+      - "expected phrase in results"
+      - "another expected phrase"
+    tags: [optional, tags]
+```
+
+## Development
+
+```bash
+cd packages/hydrag-benchmark
+pip install -e ".[dev]"
+python -m pytest tests/ -v
+```
+
+## License
+
+Apache-2.0