hufu 0.5.0__tar.gz

hufu-0.5.0/.gitattributes

@@ -0,0 +1,5 @@
+* text=auto eol=lf
+*.bat text eol=crlf
+*.ps1 text eol=crlf
+*.rs text eol=lf
+*.lock -diff

hufu-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package (core, dependency-free)
+        run: pip install -e .
+
+      - name: Compile check
+        run: python -m compileall -q src tests
+
+      - name: Dependency-free engine tests
+        run: python -m unittest discover -s tests -v
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Ruff
+        run: |
+          pip install ruff
+          ruff check src tests
+
+  models-smoke:
+    # Text-level path with the models extra: spaCy graph build on one small
+    # English model (e2e golden corpora stay HUFU_RUN_E2E-gated and local).
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install models extra
+        run: pip install -e ".[models]"
+      - name: Download spaCy model
+        run: python -m spacy download en_core_web_sm
+      - name: Graph-build smoke
+        env:
+          HUFU_SPACY_MODEL: en_core_web_sm
+          HUFU_COREF: "off"
+        run: |
+          python -c "from hufu.engine.build_hypergraph import text_to_hypergraph; hg = text_to_hypergraph('The regiment lost 300 men. The regiment lost 3000 men.'); assert len(hg.vertices) >= 3; print('hypergraph smoke OK:', len(hg.vertices), 'vertices')"
+
+  rust:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Cargo check (fixed-point engine)
+        run: cargo check --manifest-path rust/simulation/Cargo.toml

hufu-0.5.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          pip install build
+          python -m build
+      - name: Twine check
+        run: |
+          pip install twine
+          twine check dist/*
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: hufu-dist
+          path: dist/
+
+  pypi:
+    # PyPI Trusted Publishing (OIDC): no stored token.  Configure once on
+    # pypi.org — Manage project → Publishing → add GitHub publisher with
+    # owner ruochunjin, repository hufu, workflow publish.yml, environment
+    # name "pypi".
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hufu
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: hufu-dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

hufu-0.5.0/.gitignore

@@ -0,0 +1,76 @@
+# Byte-compiled / build artifacts
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Rust / maturin
+rust/**/target/
+**/*.so
+**/*.pyd
+
+# Virtual environments
+.venv/
+venv/
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Data and outputs (keep repositories code-only)
+data/
+output/
+*.pkl
+*.jsonl
+!examples/**/*.jsonl
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Local e2e environment (machine-specific)
+.venv-e2e/
+.e2e-setup.log
+
+# Runtime logs
+logs/
+
+# Local install scratch files
+.vs-modify.bat
+.vs-modify.ps1
+.*-install.log
+.vs-*.log
+.l2-test.log
+.l3-test.log
+.e2e-all.log
+.bench-test.log
+.contradoc-probe.log
+
+# Benchmark evaluation data is intentionally tracked (lab-approved release)
+!benchmarks/data/
+!benchmarks/data/**
+
+# Golden100 run report (regenerated each run)
+tests/e2e/golden100_report.json
+tests/e2e/golden250_report.json
+tests/e2e/golden100_report_sm.json
+
+# Regenerable caches (hypergraph pickles, dataset parquet downloads)
+benchmarks/data/cache/hypergraphs/
+benchmarks/data/cache/*--*/
+tests/e2e/golden_doc_report.json
+
+# Local run/probe logs and scratch outputs
+.*.log
+.*-probe.log
+.std-*.txt
+.conflict-features.json
+.vs-*.log
+.vs-*.bat
+.vs-*.ps1
+tests/e2e/golden_doc300_report.json

hufu-0.5.0/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+title: "HuFu (虎符): neuro-symbolic data-quality verification for the LLM era"
+message: >-
+  If you use this software, please cite both the software and the
+  underlying research papers.
+type: software
+# TODO: add author list and repository URL before public release.
+authors: []
+url: "https://github.com/ruochunjin/hufu"
+version: 0.1.0
+license: Apache-2.0

hufu-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 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 those 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 use of permissions.
+
+   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 additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

hufu-0.5.0/NOTICE

@@ -0,0 +1,51 @@
+NOTICE
+======
+
+HuFu (虎符) — neuro-symbolic data quality checking
+Copyright (c) 2026 The HuFu Authors
+
+This product includes software developed by the HuFu authors, licensed under
+the Apache License, Version 2.0 (see LICENSE).
+
+Portions of this software were ported from the following upstream projects,
+whose original license notices are retained below in accordance with their
+terms:
+
+1. hyper-simulation (hyper-simulation-code)
+   Source: lab-internal prototype accompanying the paper
+   "Catching Inconsistencies" (HyperMatch).
+   License: MIT License, Copyright (c) 2026 Anonymous Authors
+   Ported components: the hypergraph construction package
+   (src/hufu/hypergraph/), the engine pipeline (src/hufu/engine/), and the
+   Rust fixed-point extension (rust/simulation/, rust/graph-simulation/).
+
+   -----------------------------------------------------------------------
+   MIT License
+
+   Copyright (c) 2026 Anonymous Authors
+
+   Permission is hereby granted, free of charge, to any person obtaining a
+   copy of this software and associated documentation files (the
+   "Software"), to deal in the Software without restriction, including
+   without limitation the rights to use, copy, modify, merge, publish,
+   distribute, sublicense, and/or sell copies of the Software, and to
+   permit persons to whom the Software is furnished to do so, subject to
+   the following conditions:
+
+   The above copyright notice and this permission notice shall be included
+   in all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+   CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+   TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+   -----------------------------------------------------------------------
+
+2. ContraDoc evaluation dataset (benchmarks/data/ContraDoc.json)
+   Source: https://github.com/ddhruvkr/CONTRADOC
+   License: Apache License 2.0
+   Citation: "ContraDoc: Understanding Self-Contradictions in Documents
+   with Large Language Models" (arXiv:2311.09182).

hufu-0.5.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.5
+Name: hufu
+Version: 0.5.0
+Summary: HuFu (虎符): neuro-symbolic data-quality verification — hypergraph-simulation consistency checking for vector retrieval, documents, and LLM data
+Project-URL: Homepage, https://github.com/ruochunjin/hufu
+Project-URL: Documentation, https://github.com/ruochunjin/hufu#readme
+Project-URL: Issues, https://github.com/ruochunjin/hufu/issues
+Author: HuFu Developers
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: RAG,consistency checking,data quality,graph simulation,hypergraph,neuro-symbolic,vector database
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: graph
+Requires-Dist: langchain-core>=0.3; extra == 'graph'
+Requires-Dist: networkx>=3.0; extra == 'graph'
+Requires-Dist: pydantic>=2.0; extra == 'graph'
+Requires-Dist: requests>=2.31; extra == 'graph'
+Requires-Dist: tenacity>=8.0; extra == 'graph'
+Provides-Extra: llm
+Requires-Dist: openai>=1.30; extra == 'llm'
+Provides-Extra: models
+Requires-Dist: fastcoref>=2.1.6; extra == 'models'
+Requires-Dist: nltk>=3.8; extra == 'models'
+Requires-Dist: numpy<3,>=1.26; extra == 'models'
+Requires-Dist: sentence-transformers<6,>=5.0; extra == 'models'
+Requires-Dist: spacy<4,>=3.7; extra == 'models'
+Requires-Dist: tqdm>=4.60; extra == 'models'
+Requires-Dist: transformers<5,>=4.51; extra == 'models'
+Provides-Extra: outliers
+Requires-Dist: scikit-learn>=1.4; extra == 'outliers'
+Description-Content-Type: text/markdown
+
+# HuFu 虎符
+
+> *虎符相合，方为可信。* — In ancient China, a tiger tally was split in two;
+> only when the halves matched was an order authentic. **HuFu** does the same
+> for data: it checks whether two pieces of data *fit together* — a query and
+> a retrieved passage, a memory and a memory, a statement and a document.
+
+HuFu is a **lightweight consistency checker**. Vector similarity says two
+texts are *close*; HuFu decides whether they are *consistent* — with
+explainable evidence and provable polynomial-time complexity. Symbolic
+structure (linguistic hypergraphs, hypergraph simulation, quality rules)
+makes the call; small neural models (embeddings, NLI) serve only as
+measurable inputs to the rules.
+
+## Quick start
+
+```bash
+pip install hufu            # dependency-free reference core
+pip install "hufu[models]"  # text-level checking (spaCy, embeddings, NLI)
+python -m spacy download en_core_web_trf
+```
+
+```python
+import hufu
+
+# 1. RAG retrieval post-check: does each retrieved passage fit the query?
+verdicts = hufu.check_retrieval(
+    "Where was the author of 'The Old Man and the Sea' born?",
+    [
+        "Ernest Hemingway, who wrote The Old Man and the Sea, was born in Oak Park, Illinois.",
+        "Paris is the capital of France and a major European city.",
+    ],
+)
+for v in verdicts:
+    print(v.consistent, v.distance)
+
+# 2. Vector-memory conflicts: same object, opposing actions?
+conflicts = hufu.detect_memory_conflicts([
+    ("Turn on the light",  {"object": "light", "action": "on"}),
+    ("Turn off the light", {"object": "light", "action": "off"}),
+    ("Water the plants",   {"object": "plants", "action": "water"}),
+])
+print(conflicts[0].labels, conflicts[0].explanations)
+
+# 3. Training-data outliers: good / bad / ugly by measured impact
+from hufu.scenarios import classify_outliers
+reports = classify_outliers(records, labels, evaluator=train_and_score)
+```
+
+Every verdict carries evidence provenance and the full decision chain —
+HuFu explains *why* it flags something.
+
+## What it does
+
+- **RAG retrieval post-checker** — sits between retrieval and generation in
+  any pipeline, vector-database agnostic; labels every retrieved document
+  `consistent / conflict` with per-pair evidence and distance.
+- **Document contradiction detection** — star-graph rules over a document's
+  own statements: typed value-slot swaps, numeric mismatches (with unit
+  conversion), role reversals, antonym pairs, polarity flips.
+- **Vector-memory conflict detection & trimming** — CDR-style rules for
+  memory banks (same object, opposing actions/states/values), conflict
+  inference from retrieval judgments, and evidence/index-level trimming so
+  retrieval stops surfacing conflicts.
+- **Training-data outlier management** — detectors, the good / bad / ugly
+  classification by measured downstream impact, and a repair family
+  (KNN/RF label repair, value imputation, deletion) with a small pipeline
+  search.
+- **Unified quality-rule language** — one JSON rule schema (logic, NLI,
+  similarity, numeric/temporal predicates), pluggable via a registry.
+  Rules are data: hand-write, version, or discover them offline.
+
+## Scope and limitations
+
+HuFu is deliberately **precision-first**: it certifies structural
+contradictions with explainable evidence rather than chasing every semantic
+nuance.
+
+- **Reliable subdomain (default `profile="strict"`)**: conflicts provable
+  from structure alone — typed value-slot swaps (born in X vs Y, 300 vs
+  3000 men, May vs June 1883), role reversals on asymmetric verbs, antonym
+  pairs, and polarity flips on an otherwise identical frame.
+- **Out of scope**: narrative tension, perspective/emotion shifts,
+  paraphrase-level disagreement, and temporal *progressions* (a story
+  legitimately giving the same attribute different values at different
+  times). Real long-form narrative contains the same surface signatures as
+  injected conflicts — a methods boundary, not an engineering gap.
+
+In short: use HuFu to *confirm* contradictions on structured /
+semi-structured content (knowledge bases, fact tables, records, curated
+documents), as a consistency post-checker for RAG retrieval, and for
+vector-memory conflict detection. Long-form narrative contradiction
+hunting is explicitly out of scope.
+
+## Installation
+
+```bash
+pip install hufu               # dependency-free reference core (Python ≥ 3.10)
+pip install "hufu[models]"     # + text-level checking (spaCy, sentence-transformers, fastcoref)
+pip install "hufu[outliers]"   # + sklearn-backed outlier classification/repair
+python -m spacy download en_core_web_trf
+```
+
+Text-level checking can also use the Rust fixed-point accelerator
+(`simulation-alg`) when a Rust toolchain is available:
+
+```bash
+pip install ./rust/simulation
+```
+
+### Model configuration (environment variables)
+
+| Variable | Default | Purpose |
+| --- | --- | --- |
+| `HUFU_EMBED_MODEL` | `sentence-transformers/all-MiniLM-L6-v2` | sentence embedding model |
+| `HUFU_NLI_MODEL` | `cross-encoder/nli-deberta-v3-xsmall` | NLI cross-encoder |
+| `HUFU_COREF_MODEL` | `biu-nlp/lingmess-coref` | coreference model (`HUFU_COREF=off` disables) |
+| `HUFU_SPACY_MODEL` | `en_core_web_trf` | spaCy pipeline |
+
+## Repository layout
+
+```text
+src/hufu/
+  api.py            Public facade: check_pair / check_retrieval + reference core
+  backends.py       Model-backed EmbeddingBackend adapters (lazy)
+  engine/           HyperMatch core + star-graph document engine + bridge
+  rules/            Unified quality-rule DSL: model, registry, predicates, engine
+  scenarios/        Ready-made scenarios (memory, documents, outliers, trim)
+  hypergraph/       Linguistic hypergraph construction, traversal, fusion
+  core/             QueryInstance, logging, text utilities
+rust/
+  graph-simulation/ Rust graph-simulation crate
+  simulation/       maturin Python binding (simulation-alg)
+tests/              Dependency-free engine and rule tests (runnable anywhere)
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python -m unittest discover -s tests -v   # no models or network needed
+ruff check src tests
+```
+
+## Citation
+
+HuFu integrates several peer-reviewed works. If you use it, please cite:
+
+```bibtex
+% Catching Inconsistencies in Vector Similarity Retrieval (HyperMatch)
+% Conflict-Aware Memory for Embodied Agents: Enhancing Vector Data Quality via Detection Rules (CDRs, ACL 2026)
+% Detecting Contradictions Within and Across Documents (DocChecker)
+% Outliers: The Good, the Bad and the Ugly (OHunt)
+```
+
+(Full BibTeX entries will be added with publication metadata.)
+
+## License
+
+Apache-2.0 (see LICENSE). Existing source copyright notices are retained.