Release Chi streaming corpus library

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Zig 0.16.0
+        uses: mlugg/setup-zig@d1434d08867e3ee9daa34448df10607b98908d29 # v2
+        with:
+          version: 0.16.0
+      - name: Run tests
+        run: zig build test

.gitignore

@@ -0,0 +1,2 @@
+/.zig-cache/
+/zig-out/

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+Chi is pre-1.0 and its public contracts are intentionally narrow. Before a
+large change, open an issue describing the corpus shape, memory constraint,
+failure mode, and checkpoint behavior it is meant to address.
+
+Pull requests should:
+
+- remain compatible with Zig 0.16.0;
+- keep steady-state memory bounds explicit;
+- document the lifetime of every borrowed slice;
+- preserve deterministic behavior across input chunk boundaries;
+- add tests for checkpoints and failure rollback when state changes; and
+- run `zig build test` before submission.
+
+Do not include customer data, model corpora, credentials, generated secrets,
+or code whose license is incompatible with Apache-2.0.
+
+By submitting a contribution, you agree that it may be distributed under this
+repository's Apache-2.0 license.

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 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 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 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
+
+   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 2026 Cameron Emery
+
+   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.

NOTICE

@@ -0,0 +1,9 @@
+Chi
+Copyright 2026 Cameron Emery
+
+This product was developed with material AI assistance under human direction
+and review. Human review, release decisions, and responsibility remain with
+the maintainer.
+
+This product includes software developed by Cameron Emery and is licensed
+under the Apache License, Version 2.0.

README.md

@@ -0,0 +1,83 @@
+# Chi
+
+Streaming, checkpointable building blocks for large text-corpus curation in
+Zig.
+
+Chi is a pre-1.0 library for data infrastructure that cannot keep an entire
+corpus—or even an entire document—in memory. Its four modules cover bounded
+ingestion, text cleanup, document filtering, and exact/approximate
+deduplication. Each module exposes explicit ownership boundaries and a
+versioned checkpoint format for stopping or moving work between processes.
+
+The current release targets **Zig 0.16.0** and has no third-party runtime
+dependencies.
+
+## Modules
+
+| Module | Current scope |
+|---|---|
+| `corpus_reader` | Deterministic file and repository traversal plus pull-based stream adapters |
+| `text_cleaner` | Streaming UTF-8/UTF-16/Latin-1/Windows-1252 decoding and conservative whitespace/control cleanup |
+| `document_filter` | Bounded-memory length, UTF-8, visibility, replacement, cleaning-change, and repeated-run gates |
+| `deduplicator` | Chunk-stable exact fingerprints, SimHash candidates, sampled duplicate spans, and a transactional index boundary |
+
+```zig
+const chi = @import("chi");
+
+const CorpusReader = chi.data.corpus_reader.CorpusReader;
+const TextCleaner = chi.data.text_cleaner.TextCleaner;
+const DocumentFilter = chi.data.document_filter.DocumentFilter;
+const Deduplicator = chi.data.deduplicator.Deduplicator;
+```
+
+Each module has a focused README with API behavior, memory ownership, and
+checkpoint guarantees:
+
+- [`data/corpus-reader`](data/corpus-reader/README.md)
+- [`data/text-cleaner`](data/text-cleaner/README.md)
+- [`data/document-filter`](data/document-filter/README.md)
+- [`data/deduplicator`](data/deduplicator/README.md)
+
+## Verify
+
+Install Zig 0.16.0, clone the repository, and run:
+
+```sh
+zig build test
+```
+
+The suite exercises arbitrary chunk boundaries, checkpoint transfer,
+deterministic repository traversal, duplicate classification, and rollback
+behavior. Windows and Linux run the same test command in CI.
+
+## What Chi does not claim
+
+Chi is a set of library components, not a turnkey distributed data platform.
+This release does not include:
+
+- NFC or NFKC normalization;
+- built-in language or safety classifiers;
+- a database driver;
+- a distributed deduplication backend;
+- Unicode word segmentation or token-shingle MinHash; or
+- published performance comparisons.
+
+The provided approximate match signal uses byte-level ASCII word features.
+Downstream systems must evaluate whether that is appropriate for their data.
+
+## Status
+
+Chi is early, intentionally narrow software. APIs and checkpoint formats may
+change before 1.0. The current release is useful as an inspectable foundation
+for streaming corpus tooling and as research infrastructure for YY's data
+systems; it is not offered with an SLA.
+
+See [SECURITY.md](SECURITY.md) for private vulnerability reporting and
+[CONTRIBUTING.md](CONTRIBUTING.md) before proposing changes.
+
+## License and authorship
+
+Copyright 2026 Cameron Emery. Licensed under Apache-2.0.
+
+Chi was developed under Cameron Emery's direction with material AI assistance.
+Human review, release decisions, and responsibility remain with the maintainer.

SECURITY.md

@@ -0,0 +1,16 @@
+# Security
+
+Please do not publish suspected vulnerabilities, credential exposures, or
+unsafe parsing cases in a public issue before the maintainer has had a chance
+to assess them.
+
+Report them to **security@yycore.ai** with:
+
+- the affected commit and module;
+- a minimal reproducer that contains no sensitive corpus data;
+- the observed impact; and
+- any suggested mitigation.
+
+Chi is pre-1.0 research infrastructure and does not have a guaranteed response
+time. Receipt will be acknowledged when possible, and confirmed issues will be
+coordinated privately before disclosure.

build.zig

@@ -0,0 +1,18 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const chi = b.addModule("chi", .{
+        .root_source_file = b.path("root.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const unit_tests = b.addTest(.{ .root_module = chi });
+    const run_unit_tests = b.addRunArtifact(unit_tests);
+
+    const test_step = b.step("test", "Run unit tests");
+    test_step.dependOn(&run_unit_tests.step);
+}

build.zig.zon

@@ -0,0 +1,17 @@
+.{
+    .name = .chi,
+    .version = "0.1.0",
+    .minimum_zig_version = "0.16.0",
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "root.zig",
+        "data",
+        "LICENSE",
+        "NOTICE",
+        "README.md",
+        "SECURITY.md",
+        "CONTRIBUTING.md",
+    },
+    .fingerprint = 0x2c9a9438dc98f8f3,
+}