hydrag-core 1.0.5__tar.gz

hydrag_core-1.0.5/.gitignore

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

hydrag_core-1.0.5/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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 along with 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 G.Romanchenko <goshka@gmail.com>
+
+   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_core-1.0.5/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: hydrag-core
+Version: 1.0.5
+Summary: HydRAG — Multi-Headed Retrieval-Augmented Generation with CRAG supervision
+Project-URL: Homepage, https://github.com/studio-playbook/hydrag-core
+Project-URL: Documentation, https://github.com/studio-playbook/hydrag-core#readme
+Project-URL: Repository, https://github.com/studio-playbook/hydrag-core
+Project-URL: Changelog, https://github.com/studio-playbook/hydrag-core/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/studio-playbook/hydrag-core/issues
+Author: Studio Playbook Contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: crag,hydrag,llm,multi-headed,rag,reciprocal-rank-fusion,retrieval,search
+Classifier: Development Status :: 5 - Production/Stable
+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: Topic :: Text Processing :: Indexing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: chromadb
+Requires-Dist: chromadb>=0.4; extra == 'chromadb'
+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: firecrawl
+Requires-Dist: firecrawl-py>=1.0; extra == 'firecrawl'
+Provides-Extra: tune
+Requires-Dist: numpy>=1.24; extra == 'tune'
+Requires-Dist: onnxruntime>=1.17; extra == 'tune'
+Requires-Dist: torch>=2.0; extra == 'tune'
+Requires-Dist: transformers>=4.40; extra == 'tune'
+Description-Content-Type: text/markdown
+
+# hydrag-core
+
+[![PyPI version](https://img.shields.io/pypi/v/hydrag-core.svg)](https://pypi.org/project/hydrag-core/)
+[![Python](https://img.shields.io/pypi/pyversions/hydrag-core.svg)](https://pypi.org/project/hydrag-core/)
+[![License](https://img.shields.io/pypi/l/hydrag-core.svg)](https://github.com/studio-playbook/hydrag-core/blob/main/LICENSE)
+
+**HydRAG** — Multi-Headed Retrieval-Augmented Generation with CRAG supervision.
+
+A standalone, domain-agnostic retrieval pipeline that fuses multiple retrieval
+heads via Reciprocal Rank Fusion (RRF) and uses a Corrective RAG (CRAG)
+supervisor to judge context sufficiency before triggering fallback strategies.
+
+## Features
+
+- **Multi-headed retrieval** — Five pipeline heads: BM25 fast-path → Primary (hybrid / code-aware) → CRAG supervisor → Semantic fallback → Web fallback
+- **Per-head control** — Enable or disable individual heads at runtime via config or environment variables
+- **Domain-agnostic by default** — `prose` profile works with any corpus (documentation, legal, medical, etc.)
+- **Code-aware opt-in** — `code` profile detects symbols (CamelCase, snake_case, dotted paths) and routes to code-aware search
+- **CRAG supervisor** — LLM-graded context sufficiency with streaming verdict parsing and confidence-gated fast-path skip
+- **CRAG classifier** — Optional distilled DistilBERT binary classifier (<15 ms inference) replaces LLM-based CRAG via teacher-student training pipeline
+- **Pluggable adapters** — Implement the `VectorStoreAdapter` protocol to connect any vector store
+- **Pluggable LLM** — Implement `LLMProvider` protocol or use the built-in `OllamaProvider`
+- **Zero required dependencies** — stdlib-only core; optional extras for ChromaDB, Firecrawl, fine-tuning, and dev tools
+- **Fully typed** — PEP 561 compatible with `py.typed` marker; strict mypy passes
+
+## Installation
+
+```bash
+pip install hydrag-core
+```
+
+With optional extras:
+
+```bash
+pip install hydrag-core[chromadb]     # ChromaDB adapter support
+pip install hydrag-core[firecrawl]    # Web fallback via Firecrawl
+pip install hydrag-core[tune]         # CRAG classifier fine-tuning (transformers, torch, onnxruntime)
+pip install hydrag-core[dev]          # Development tools (pytest, ruff, mypy)
+```
+
+## Quick Start
+
+```python
+from hydrag import HydRAG, HydRAGConfig
+
+# 1. Implement the VectorStoreAdapter protocol for your store
+class MyAdapter:
+    def semantic_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def keyword_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def hybrid_search(self, query: str, n_results: int = 5) -> list[str]: ...
+
+# 2. Create engine and search
+adapter = MyAdapter()
+engine = HydRAG(adapter)
+results = engine.search("How do I configure logging?")
+
+for r in results:
+    print(f"[{r.head_origin}] score={r.score:.4f}: {r.text[:80]}")
+```
+
+### Code Profile
+
+```python
+config = HydRAGConfig(profile="code")
+engine = HydRAG(adapter, config=config)
+# Queries with symbols (e.g. "HttpRequest class") trigger code-aware retrieval
+results = engine.search("How does `HttpRequest` handle timeouts?")
+```
+
+### Custom LLM Provider
+
+```python
+from hydrag import LLMProvider
+
+class MyLLM:
+    def generate(self, prompt: str, model: str = "", timeout: int = 30) -> str | None:
+        # Your LLM inference here
+        ...
+
+engine = HydRAG(adapter, llm=MyLLM())
+```
+
+### Streaming CRAG Provider
+
+For lower-latency CRAG verdict parsing, implement `StreamingLLMProvider`:
+
+```python
+from hydrag import StreamingLLMProvider
+
+class MyStreamingLLM:
+    def generate(self, prompt: str, model: str = "", timeout: int = 30) -> str | None: ...
+    def generate_stream(self, prompt: str, model: str = "", timeout: int = 30) -> str | None:
+        # Return full response; first token is parsed for early verdict
+        ...
+
+engine = HydRAG(adapter, llm=MyStreamingLLM())
+```
+
+### Per-Head Control
+
+```python
+# Run only BM25 fast-path + primary retrieval (skip CRAG, semantic, web)
+config = HydRAGConfig(
+    enable_head_0=True,
+    enable_head_1=True,
+    enable_head_2_crag=False,
+    enable_head_3a_semantic=False,
+    enable_head_3b_web=False,
+)
+engine = HydRAG(adapter, config=config)
+results = engine.search("quick keyword lookup")
+```
+
+### CRAG Classifier (Optional)
+
+```python
+from hydrag import tune, CRAGClassifier
+
+# Fine-tune a fast classifier from your corpus
+tune(
+    adapter=adapter,
+    llm=llm,
+    output_dir="models/crag_classifier",
+    n_samples=500,
+)
+
+# Use it — auto-detected when crag_mode="auto" and path is set
+config = HydRAGConfig(
+    crag_mode="auto",
+    crag_classifier_path="models/crag_classifier",
+)
+engine = HydRAG(adapter, config=config)
+```
+
+## Configuration
+
+All settings can be set via environment variables (`HYDRAG_` prefix) or passed directly:
+
+| Setting | Env Var | Default | Description |
+|---------|---------|---------|-------------|
+| `profile` | `HYDRAG_PROFILE` | `"prose"` | `"prose"` or `"code"` |
+| `embedding_model` | `HYDRAG_EMBEDDING_MODEL` | `"qwen3-embedding-0.6b"` | Embedding model name |
+| `crag_model` | `CRAG_MODEL` | `"qwen3.5-4B"` | Model for CRAG supervisor |
+| `crag_timeout` | `CRAG_TIMEOUT` | `30` | Timeout (seconds) for CRAG calls |
+| `ollama_host` | `OLLAMA_HOST` | `"http://localhost:11434"` | Ollama API endpoint |
+| `enable_web_fallback` | `HYDRAG_ENABLE_WEB_FALLBACK` | `false` | Enable Firecrawl web fallback |
+| `allow_web_on_empty_primary` | `HYDRAG_ALLOW_WEB_ON_EMPTY` | `false` | Allow web fallback when Head 1 returns empty |
+| `allow_markdown_in_web_fallback` | `HYDRAG_ALLOW_MARKDOWN_WEB` | `false` | Preserve markdown in web fallback content |
+| `rrf_k` | `HYDRAG_RRF_K` | `60` | RRF smoothing constant |
+| `min_candidate_pool` | `HYDRAG_MIN_CANDIDATE_POOL` | `8` | Minimum candidates per head |
+| `web_chunk_limit` | `HYDRAG_WEB_CHUNK_LIMIT` | `3000` | Max chars per web chunk after sanitization |
+| `crag_min_relevance` | `HYDRAG_CRAG_MIN_RELEVANCE` | `0.12` | Minimum relevance threshold for CRAG |
+| `crag_context_chunks` | `HYDRAG_CRAG_CONTEXT_CHUNKS` | `5` | Chunks sent to CRAG supervisor |
+| `crag_char_limit` | `HYDRAG_CRAG_CHAR_LIMIT` | `1500` | Per-chunk character limit in CRAG prompt |
+| `enable_fast_path` | `HYDRAG_ENABLE_FAST_PATH` | `true` | Head 0 BM25 fast-path |
+| `fast_path_bm25_threshold` | `HYDRAG_FAST_PATH_BM25_THRESHOLD` | `0.6` | BM25 score threshold for fast-path |
+| `fast_path_confidence_threshold` | `HYDRAG_FAST_PATH_CONFIDENCE_THRESHOLD` | `0.7` | Score threshold to skip CRAG entirely |
+| `crag_stream` | `HYDRAG_CRAG_STREAM` | `true` | Parse first token for early CRAG verdict |
+| `crag_mode` | `HYDRAG_CRAG_MODE` | `"auto"` | `"auto"`, `"llm"`, or `"classifier"` |
+| `crag_classifier_path` | `HYDRAG_CRAG_CLASSIFIER_PATH` | `""` | Path to ONNX classifier model |
+| `enable_head_0` | `HYDRAG_ENABLE_HEAD_0` | `true` | BM25 fast-path head |
+| `enable_head_1` | `HYDRAG_ENABLE_HEAD_1` | `true` | Primary retrieval head |
+| `enable_head_2_crag` | `HYDRAG_ENABLE_HEAD_2_CRAG` | `true` | CRAG supervisor head |
+| `enable_head_3a_semantic` | `HYDRAG_ENABLE_HEAD_3A_SEMANTIC` | `true` | Semantic fallback head |
+| `enable_head_3b_web` | `HYDRAG_ENABLE_HEAD_3B_WEB` | `false` | Web fallback head |
+| `fallback_timeout_s` | `HYDRAG_FALLBACK_TIMEOUT_S` | `30.0` | Timeout for fallback head futures |
+| `rrf_head_weights` | `HYDRAG_RRF_HEAD_WEIGHTS` | *(JSON)* | Per-head RRF weight map |
+
+```python
+# From environment
+config = HydRAGConfig.from_env()
+
+# Direct
+config = HydRAGConfig(profile="code", rrf_k=100, enable_web_fallback=True)
+```
+
+## Adapter Protocol
+
+Required methods (must implement all three):
+
+```python
+class VectorStoreAdapter(Protocol):
+    def semantic_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def keyword_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def hybrid_search(self, query: str, n_results: int = 5) -> list[str]: ...
+```
+
+Optional methods (gracefully handled if missing):
+
+```python
+    def crag_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def graph_search(self, query: str, n_results: int = 5) -> list[str]: ...
+    def rewrite_query(self, query: str) -> str: ...
+```
+
+## Pipeline Architecture
+
+```
+Query → [Profile Router]
+           │
+           ├─ Head 0: BM25 Fast-Path
+           │    └─ score ≥ threshold? → early return
+           │    └─ score ≥ confidence threshold? → skip CRAG
+           │
+           ├─ Head 1: Primary Retrieval
+           │    ├─ prose → hybrid_search()
+           │    └─ code + symbols → code-aware (semantic + keyword RRF)
+           │
+           ├─ Head 2: CRAG Supervisor
+           │    ├─ classifier (ONNX, <15ms) ← crag_mode="auto"|"classifier"
+           │    └─ LLM (streaming verdict)  ← crag_mode="auto"|"llm"
+           │         ├─ SUFFICIENT → return Head 1 results
+           │         └─ INSUFFICIENT ↓
+           │
+           ├─ Head 3a: Semantic Fallback
+           │    └─ rewrite + CRAG search + keyword + graph → RRF
+           │
+           └─ Head 3b: Web Fallback (optional)
+                └─ Firecrawl search → sanitize → RRF
+
+           Final: RRF Fusion across all active heads → list[RetrievalResult]
+```
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/studio-playbook/hydrag-core.git
+cd hydrag-core
+pip install -e ".[dev]"
+
+# Run tests
+python -m pytest tests/
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/
+```
+
+## Versioning
+
+HydRAG uses SemVer. Version sources that must stay in sync:
+
+- `pyproject.toml` (`[project].version`)
+- `src/hydrag/_version.py` (`__version__`)
+
+## Type Checking
+
+This package ships a PEP 561 `py.typed` marker. Downstream projects using
+`mypy --strict` will get full type coverage out of the box.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) for details.