datacruxai 0.3.0__tar.gz

datacruxai-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[all]"
+          pip install pytest ruff
+
+      - name: Lint with ruff
+        run: ruff check src/ tests/
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short

datacruxai-0.3.0/.gitignore

@@ -0,0 +1,22 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+*.so
+.venv/
+venv/
+env/
+.env
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+*.log
+.DS_Store
+Thumbs.db

datacruxai-0.3.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project 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.3.0] - 2025-04-10
+
+### Added
+- Add data augmentation module in `augment.py`
+- Add dataset schema validation via `schema.py`
+
+## [0.2.0] - 2026-04-10
+
+### Added
+- Add HuggingFace datasets hub integration
+- Add language detection for multilingual datasets
+- Add international PII patterns
+
+## [0.1.0] - 2026-04-10
+
+### Added
+- Initial release: CPU-only data quality toolkit for LLM instruction tuning
+

datacruxai-0.3.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 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

datacruxai-0.3.0/PKG-INFO

@@ -0,0 +1,332 @@
+Metadata-Version: 2.4
+Name: datacruxai
+Version: 0.3.0
+Summary: Lightweight data quality toolkit for LLM instruction tuning. Deduplication, PII detection, contamination checking, and quality scoring — no GPU required.
+Project-URL: Homepage, https://github.com/stef41/datacruxai
+Project-URL: Repository, https://github.com/stef41/datacruxai
+Project-URL: Issues, https://github.com/stef41/datacruxai/issues
+Author: Zacharie B
+License: Apache-2.0
+License-File: LICENSE
+Keywords: contamination,data-quality,deduplication,fine-tuning,instruction-tuning,llm,pii,rlhf,sft,training-data
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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.9
+Requires-Dist: xxhash>=3.0
+Provides-Extra: all
+Requires-Dist: click>=8.0; extra == 'all'
+Requires-Dist: datasketch>=1.6; extra == 'all'
+Requires-Dist: pyarrow>=12.0; extra == 'all'
+Requires-Dist: rich>=13.0; extra == 'all'
+Provides-Extra: cli
+Requires-Dist: click>=8.0; extra == 'cli'
+Requires-Dist: rich>=13.0; extra == 'cli'
+Provides-Extra: formats
+Requires-Dist: pyarrow>=12.0; extra == 'formats'
+Provides-Extra: fuzzy
+Requires-Dist: datasketch>=1.6; extra == 'fuzzy'
+Provides-Extra: semantic
+Requires-Dist: numpy>=1.21; extra == 'semantic'
+Requires-Dist: sentence-transformers>=2.0; extra == 'semantic'
+Description-Content-Type: text/markdown
+
+# datacruxai
+
+[![CI](https://github.com/stef41/datacruxaiai/actions/workflows/ci.yml/badge.svg)](https://github.com/stef41/datacruxaiai/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**Data quality toolkit for LLM instruction tuning.**
+
+Clean your training data before fine-tuning. No GPU needed.
+
+<p align="center">
+  <img src="assets/quality_report.svg" width="720" alt="datacruxai quality report" />
+</p>
+
+```python
+from datacruxai import load_dataset, exact_dedup, scan_examples, score_dataset
+
+# Load any instruction-tuning dataset
+examples = load_dataset("training_data.jsonl")
+
+# Remove exact duplicates
+result = exact_dedup(examples)
+print(f"Removed {result.n_duplicates} duplicates")
+
+# Scan for PII
+pii_results = scan_examples(result.originals)
+print(f"Found PII in {len(pii_results)} examples")
+
+# Score quality
+scores = score_dataset(result.originals, min_score=0.5)
+print(f"{len(scores)} low-quality examples flagged")
+```
+
+## Why datacruxai?
+
+If you're fine-tuning an LLM, your training data quality matters more than quantity. Garbage in, garbage out — except now garbage costs you GPU hours and makes your model worse.
+
+Existing options are either overkill (NeMo Curator needs NVIDIA GPUs and processes terabytes of web crawl data) or too narrow (scattered scripts in random repos). datacruxai fills the gap: a single `pip install` that gives you everything needed to validate and clean instruction-tuning datasets on a laptop.
+
+**What it does:**
+
+- **Deduplication** — exact (hash-based) and near-duplicate (MinHash + LSH) detection
+- **PII detection** — regex-based scanning for emails, phones, SSNs, credit cards, IPs
+- **PII redaction** — replace detected PII with placeholders
+- **Benchmark contamination** — n-gram overlap checking against MMLU, GSM8K, HellaSwag, ARC, TruthfulQA, WinoGrande
+- **Quality scoring** — heuristic checks for instruction quality, response completeness, repetition, formatting
+- **Format support** — Alpaca, ShareGPT, OpenAI chat format; JSONL, JSON, Parquet
+- **Dataset statistics** — length distributions, token estimates, field coverage
+
+Everything runs on CPU. Everything is deterministic. No API keys, no signups, no cloud dependencies.
+
+## Install
+
+```bash
+pip install datacruxai
+```
+
+With fuzzy deduplication (MinHash + LSH):
+
+```bash
+pip install datacruxai[fuzzy]
+```
+
+With Parquet support:
+
+```bash
+pip install datacruxai[formats]
+```
+
+Everything:
+
+```bash
+pip install datacruxai[all]
+```
+
+## Usage
+
+### Load data
+
+datacruxai auto-detects Alpaca, ShareGPT, and OpenAI chat formats.
+
+```python
+from datacruxai import load_dataset, detect_format
+
+examples = load_dataset("training_data.jsonl")  # JSONL, JSON, or Parquet
+print(f"Loaded {len(examples)} examples")
+print(f"Format: {detect_format(examples[0].raw)}")
+```
+
+### Deduplicate
+
+```python
+from datacruxai import exact_dedup, fuzzy_dedup, dedup
+
+# Fast exact dedup (hash-based)
+result = exact_dedup(examples)
+print(f"{result.n_total} → {result.n_unique} (removed {result.n_duplicates})")
+
+# Near-duplicate detection (requires datacruxai[fuzzy])
+result = fuzzy_dedup(examples, threshold=0.8)
+
+# Combined: exact first, then fuzzy on the remainder
+result = dedup(examples, exact=True, fuzzy=True, fuzzy_threshold=0.8)
+clean_examples = result.originals
+```
+
+### Detect PII
+
+```python
+from datacruxai import scan_text, scan_examples, redact_text, redact_examples
+
+# Scan a single string
+entities = scan_text("Email me at john@example.com or call 555-0123")
+for e in entities:
+    print(f"  {e.kind}: '{e.text}' at [{e.start}:{e.end}]")
+
+# Scan an entire dataset
+pii_results = scan_examples(examples)
+for r in pii_results:
+    print(f"  Example {r.example_index}: {[e.kind for e in r.entities]}")
+
+# Redact PII
+safe = redact_text("SSN: 123-45-6789")
+# "SSN: [SSN]"
+
+safe_examples = redact_examples(examples)
+```
+
+### Check benchmark contamination
+
+```python
+from datacruxai import check_contamination, list_benchmarks
+
+# Built-in benchmarks
+print(list_benchmarks())
+# ['arc', 'gsm8k', 'hellaswag', 'mmlu', 'truthfulqa', 'winogrande']
+
+report = check_contamination(examples, ngram_size=8)
+print(f"Flagged {report.total_flagged} / {report.total_checked} examples")
+for bench, count in report.by_benchmark.items():
+    print(f"  {bench}: {count} matches")
+
+# Custom benchmark dataset
+custom = {"my_eval": ["question one text", "question two text"]}
+report = check_contamination(examples, benchmarks=custom, ngram_size=5)
+```
+
+### Score quality
+
+```python
+from datacruxai import score_example, score_dataset, filter_by_quality
+
+# Score a single example
+score = score_example(examples[0])
+print(f"Overall: {score.overall:.2f}")
+print(f"Details: {score.details}")
+print(f"Flags: {score.flags}")
+
+# Flag low-quality examples
+low_quality = score_dataset(examples, min_score=0.5)
+for s in low_quality:
+    print(f"  [{s.example_index}] {s.overall:.2f} — {s.flags}")
+
+# Filter and keep only good examples
+clean = filter_by_quality(examples, min_score=0.5)
+print(f"Kept {len(clean)} / {len(examples)}")
+```
+
+### Dataset statistics
+
+```python
+from datacruxai import compute_stats, length_distribution
+
+stats = compute_stats(examples)
+print(f"Examples: {stats['n_examples']}")
+print(f"Token estimate: ~{stats['token_estimate']:,}")
+print(f"Empty outputs: {stats['empty_outputs']}")
+print(f"Avg instruction length: {stats['instruction_lengths']['mean']:.0f} chars")
+
+# Length histogram
+hist = length_distribution(examples, field="output", bins=10)
+for bucket in hist:
+    print(f"  {bucket['range']}: {'█' * bucket['count']}")
+```
+
+### Save results
+
+```python
+from datacruxai import save_jsonl
+
+save_jsonl(clean_examples, "cleaned_training_data.jsonl")
+```
+
+## CLI
+
+```bash
+# Dataset statistics
+datacruxai stats training_data.jsonl
+
+# Deduplicate
+datacruxai dedup training_data.jsonl -o deduped.jsonl
+
+# Fuzzy dedup
+datacruxai dedup training_data.jsonl --fuzzy -t 0.8 -o deduped.jsonl
+
+# PII scan
+datacruxai pii training_data.jsonl
+
+# PII redact and save
+datacruxai pii training_data.jsonl -o redacted.jsonl
+
+# Contamination check
+datacruxai contamination training_data.jsonl -n 8
+
+# Quality scoring
+datacruxai quality training_data.jsonl -t 0.5 -o filtered.jsonl
+```
+
+## Quality Checks
+
+The quality scorer applies these deterministic heuristics:
+
+| Check | Weight | What it catches |
+|-------|--------|-----------------|
+| Instruction quality | 25% | Empty, trivial, or all-caps instructions |
+| Response completeness | 30% | Empty, trivial, or refusal-only responses |
+| Length | 15% | Extremely short or long examples |
+| Repetition | 20% | Repeated words, repeated n-grams |
+| Language | 10% | Excessive special characters, whitespace |
+
+Scores range from 0.0 (terrible) to 1.0 (clean). The default threshold of 0.5 catches the obvious problems without being overly aggressive.
+
+## Supported Formats
+
+| Format | Auto-detected | Key fields |
+|--------|--------------|------------|
+| Alpaca | `instruction`, `input`, `output` | Standard fine-tuning format |
+| ShareGPT | `conversations` | Multi-turn with `from`/`value` |
+| OpenAI chat | `messages` | `role`/`content` pairs |
+
+File types: `.jsonl`, `.json`, `.parquet` (with `datacruxai[formats]`)
+
+## Performance
+
+Everything is single-threaded and CPU-only by design. On a typical laptop:
+
+- **Exact dedup**: ~100k examples/sec
+- **PII scan**: ~50k examples/sec
+- **Quality scoring**: ~80k examples/sec
+- **Contamination check**: depends on n-gram size, ~10k examples/sec for n=8
+
+For datasets under 1M examples, everything runs in seconds to minutes. If you're working with larger datasets, consider NeMo Curator (but you'll need GPUs).
+
+## Contributing
+
+PRs welcome — especially:
+- Additional PII patterns (non-US phone formats, EU identifiers)
+- More benchmark fingerprints
+- New quality heuristics
+- Performance improvements
+
+```bash
+git clone https://github.com/zbhatti/datacruxai.git
+cd datacruxai
+pip install -e ".[all]"
+pip install pytest ruff
+pytest
+```
+
+## See Also
+
+Part of the **stef41 LLM toolkit** — open-source tools for every stage of the LLM lifecycle:
+
+| Project | What it does |
+|---------|-------------|
+| [tokonomics](https://github.com/stef41/tokonomix) | Token counting & cost management for LLM APIs |
+| [castwright](https://github.com/stef41/castwright) | Synthetic instruction data generation |
+| [datamix](https://github.com/stef41/datamix) | Dataset mixing & curriculum optimization |
+| [toksight](https://github.com/stef41/toksight) | Tokenizer analysis & comparison |
+| [trainpulse](https://github.com/stef41/trainpulse) | Training health monitoring |
+| [ckpt](https://github.com/stef41/ckptkit) | Checkpoint inspection, diffing & merging |
+| [quantbench](https://github.com/stef41/quantbenchx) | Quantization quality analysis |
+| [infermark](https://github.com/stef41/infermark) | Inference benchmarking |
+| [modeldiff](https://github.com/stef41/modeldiffx) | Behavioral regression testing |
+| [vibesafe](https://github.com/stef41/vibesafex) | AI-generated code safety scanner |
+| [injectionguard](https://github.com/stef41/injectionguard) | Prompt injection detection |
+
+## License
+
+Apache 2.0