corpusguard-audit 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- corpusguard_audit-0.1.0/.github/workflows/ci.yml +21 -0
- corpusguard_audit-0.1.0/.github/workflows/release.yml +55 -0
- corpusguard_audit-0.1.0/.gitignore +14 -0
- corpusguard_audit-0.1.0/CONTRIBUTING.md +22 -0
- corpusguard_audit-0.1.0/LICENSE +202 -0
- corpusguard_audit-0.1.0/NOTICE +2 -0
- corpusguard_audit-0.1.0/PKG-INFO +164 -0
- corpusguard_audit-0.1.0/README.md +132 -0
- corpusguard_audit-0.1.0/ROADMAP.md +37 -0
- corpusguard_audit-0.1.0/examples/demo.jsonl +5 -0
- corpusguard_audit-0.1.0/examples/reports/demo-report.html +43 -0
- corpusguard_audit-0.1.0/examples/reports/demo-report.json +46 -0
- corpusguard_audit-0.1.0/pyproject.toml +71 -0
- corpusguard_audit-0.1.0/src/corpusguard/__init__.py +3 -0
- corpusguard_audit-0.1.0/src/corpusguard/audit.py +192 -0
- corpusguard_audit-0.1.0/src/corpusguard/checks.py +138 -0
- corpusguard_audit-0.1.0/src/corpusguard/cli.py +143 -0
- corpusguard_audit-0.1.0/src/corpusguard/io.py +25 -0
- corpusguard_audit-0.1.0/src/corpusguard/models.py +61 -0
- corpusguard_audit-0.1.0/src/corpusguard/report.py +62 -0
- corpusguard_audit-0.1.0/src/corpusguard/schema.py +46 -0
- corpusguard_audit-0.1.0/tests/test_audit.py +44 -0
- corpusguard_audit-0.1.0/tests/test_schema.py +17 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
test:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
strategy:
|
|
11
|
+
matrix:
|
|
12
|
+
python-version: ["3.10", "3.11", "3.12"]
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: ${{ matrix.python-version }}
|
|
18
|
+
- run: python -m pip install -U pip
|
|
19
|
+
- run: pip install -e ".[dev]"
|
|
20
|
+
- run: ruff check .
|
|
21
|
+
- run: pytest -q
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types:
|
|
6
|
+
- published
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Build distribution
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- name: Checkout repository
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Set up Python
|
|
18
|
+
uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: "3.12"
|
|
21
|
+
|
|
22
|
+
- name: Install build tooling
|
|
23
|
+
run: python -m pip install --upgrade build
|
|
24
|
+
|
|
25
|
+
- name: Build distributions
|
|
26
|
+
run: python -m build
|
|
27
|
+
|
|
28
|
+
- name: Upload distribution artifacts
|
|
29
|
+
uses: actions/upload-artifact@v4
|
|
30
|
+
with:
|
|
31
|
+
name: python-package-distributions
|
|
32
|
+
path: dist/
|
|
33
|
+
|
|
34
|
+
publish:
|
|
35
|
+
name: Publish to PyPI
|
|
36
|
+
needs:
|
|
37
|
+
- build
|
|
38
|
+
runs-on: ubuntu-latest
|
|
39
|
+
|
|
40
|
+
environment:
|
|
41
|
+
name: pypi
|
|
42
|
+
url: https://pypi.org/project/corpusguard-audit/
|
|
43
|
+
|
|
44
|
+
permissions:
|
|
45
|
+
id-token: write
|
|
46
|
+
|
|
47
|
+
steps:
|
|
48
|
+
- name: Download distribution artifacts
|
|
49
|
+
uses: actions/download-artifact@v4
|
|
50
|
+
with:
|
|
51
|
+
name: python-package-distributions
|
|
52
|
+
path: dist/
|
|
53
|
+
|
|
54
|
+
- name: Publish distributions to PyPI
|
|
55
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Contributing to CorpusGuard
|
|
2
|
+
|
|
3
|
+
Thanks for helping improve LLM dataset quality.
|
|
4
|
+
|
|
5
|
+
## Development
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
python -m venv .venv
|
|
9
|
+
source .venv/bin/activate
|
|
10
|
+
pip install -e ".[dev]"
|
|
11
|
+
pytest -q
|
|
12
|
+
ruff check .
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Design principles
|
|
16
|
+
|
|
17
|
+
1. Deterministic checks first: audits should be reproducible and inexpensive.
|
|
18
|
+
2. No silent mutation: CorpusGuard reports problems; it does not rewrite datasets unless a user explicitly asks.
|
|
19
|
+
3. Evidence over vibes: every score deduction should map to a visible metric or finding.
|
|
20
|
+
4. Privacy by default: never send dataset rows to a remote service in the default installation.
|
|
21
|
+
|
|
22
|
+
Please include tests for new checks and document any false-positive tradeoffs.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: corpusguard-audit
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Pre-flight quality and leakage auditor for LLM fine-tuning datasets.
|
|
5
|
+
Project-URL: Homepage, https://github.com/yerbolisaac/corpusguard
|
|
6
|
+
Project-URL: Repository, https://github.com/yerbolisaac/corpusguard
|
|
7
|
+
Project-URL: Issues, https://github.com/yerbolisaac/corpusguard/issues
|
|
8
|
+
Project-URL: Roadmap, https://github.com/yerbolisaac/corpusguard/blob/main/ROADMAP.md
|
|
9
|
+
Author: yerbolisaac
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: NOTICE
|
|
13
|
+
Keywords: data-quality,data-validation,dataset,deduplication,evaluation,fine-tuning,llm,machine-learning,pii
|
|
14
|
+
Classifier: Development Status :: 3 - Alpha
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Intended Audience :: Science/Research
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
22
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
23
|
+
Requires-Python: >=3.10
|
|
24
|
+
Requires-Dist: rich<15,>=13.7
|
|
25
|
+
Requires-Dist: typer<1,>=0.12
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: build>=1.2; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
29
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
30
|
+
Requires-Dist: twine>=5; extra == 'dev'
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
|
|
33
|
+
<p align="center">
|
|
34
|
+
<h1 align="center">CorpusGuard</h1>
|
|
35
|
+
<p align="center"><strong>Pre-flight checks for LLM fine-tuning data.</strong></p>
|
|
36
|
+
<p align="center">Catch duplicates, PII, broken rows, repetition and train/eval leakage before they become model behavior.</p>
|
|
37
|
+
</p>
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Why CorpusGuard?
|
|
42
|
+
|
|
43
|
+
LLM fine-tuning pipelines usually validate whether training *runs*. CorpusGuard asks a different question first:
|
|
44
|
+
|
|
45
|
+
> **Should this dataset be allowed into a training run at all?**
|
|
46
|
+
|
|
47
|
+
A clean loss curve cannot tell you that your evaluation examples leaked into training, that hundreds of rows are duplicated, or that private data is sitting in a JSONL file. CorpusGuard provides a deterministic, local pre-flight audit with a single quality score and evidence for every deduction.
|
|
48
|
+
|
|
49
|
+
## Quick start
|
|
50
|
+
|
|
51
|
+
Install CorpusGuard from PyPI:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
pip install corpusguard-audit
|
|
55
|
+
pip install -e .
|
|
56
|
+
corpusguard scan examples/demo.jsonl
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Generate machine-readable and standalone HTML reports:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
corpusguard scan data/train.jsonl \
|
|
63
|
+
--json-out corpusguard-report.json \
|
|
64
|
+
--html-out corpusguard-report.html
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Check train/eval leakage:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
corpusguard scan data/train.jsonl --compare data/eval.jsonl
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Use it as a CI gate:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
corpusguard scan data/train.jsonl --compare data/eval.jsonl --fail-below 85
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Exit code `2` means the quality score fell below the requested threshold.
|
|
80
|
+
|
|
81
|
+
## What v0.1 checks
|
|
82
|
+
|
|
83
|
+
| Check | What it catches |
|
|
84
|
+
|---|---|
|
|
85
|
+
| JSON/schema validation | malformed JSONL and unsupported SFT row shapes |
|
|
86
|
+
| Exact duplicates | repeated prompt/answer examples |
|
|
87
|
+
| Near duplicates | highly overlapping examples using token Jaccard similarity |
|
|
88
|
+
| PII patterns | emails, phone-like values, 12-digit IDs, card-like numbers |
|
|
89
|
+
| Empty/short outputs | weak supervision and accidental blank labels |
|
|
90
|
+
| Repetition | degenerate repeated-token answers |
|
|
91
|
+
| Script distribution | Latin/Cyrillic/other letter counts for multilingual corpus visibility |
|
|
92
|
+
| Split leakage | exact examples duplicated between train and eval/test JSONL |
|
|
93
|
+
| Quality score | deterministic 0–100 score with A–F grade |
|
|
94
|
+
|
|
95
|
+
## Supported dataset shapes
|
|
96
|
+
|
|
97
|
+
OpenAI/chat style:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{"messages":[{"role":"user","content":"Question"},{"role":"assistant","content":"Answer"}]}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Prompt/completion:
|
|
104
|
+
|
|
105
|
+
```json
|
|
106
|
+
{"prompt":"Question","completion":"Answer"}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Alpaca/instruction:
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{"instruction":"Task","input":"Optional context","output":"Answer"}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Question/answer:
|
|
116
|
+
|
|
117
|
+
```json
|
|
118
|
+
{"question":"Question","answer":"Answer"}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Example output
|
|
122
|
+
|
|
123
|
+
```text
|
|
124
|
+
CorpusGuard v0.1.0
|
|
125
|
+
Dataset: examples/demo.jsonl
|
|
126
|
+
Quality score: 57/100 (F)
|
|
127
|
+
|
|
128
|
+
Metric Value
|
|
129
|
+
rows 5
|
|
130
|
+
valid rows 5
|
|
131
|
+
invalid rows 0
|
|
132
|
+
exact duplicate rows 1
|
|
133
|
+
pii hits 1
|
|
134
|
+
leakage matches 0
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
The demo file intentionally contains bad data so the checks are visible.
|
|
138
|
+
|
|
139
|
+
## Philosophy
|
|
140
|
+
|
|
141
|
+
CorpusGuard's default checks are **local, deterministic and model-free**. Your training data is not sent to an API. Semantic/LLM-based review can be useful, but it should be an explicit optional layer rather than a hidden dependency in the basic audit path.
|
|
142
|
+
|
|
143
|
+
## Current limitations
|
|
144
|
+
|
|
145
|
+
- Near-duplicate detection in v0.1 is an O(n²) reference implementation intended for small and medium corpora.
|
|
146
|
+
- PII checks are pattern-based and can produce false positives/negatives; they are a review signal, not a compliance guarantee.
|
|
147
|
+
- Script counts are not language identification.
|
|
148
|
+
- Exact split leakage does not yet detect paraphrased semantic leakage.
|
|
149
|
+
|
|
150
|
+
See [ROADMAP.md](ROADMAP.md) for the planned scalable and semantic checks.
|
|
151
|
+
|
|
152
|
+
## Development
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
python -m venv .venv
|
|
156
|
+
source .venv/bin/activate
|
|
157
|
+
pip install -e ".[dev]"
|
|
158
|
+
pytest -q
|
|
159
|
+
ruff check .
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## License
|
|
163
|
+
|
|
164
|
+
Apache-2.0. Created by [@yerbolisaac](https://github.com/yerbolisaac).
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<h1 align="center">CorpusGuard</h1>
|
|
3
|
+
<p align="center"><strong>Pre-flight checks for LLM fine-tuning data.</strong></p>
|
|
4
|
+
<p align="center">Catch duplicates, PII, broken rows, repetition and train/eval leakage before they become model behavior.</p>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Why CorpusGuard?
|
|
10
|
+
|
|
11
|
+
LLM fine-tuning pipelines usually validate whether training *runs*. CorpusGuard asks a different question first:
|
|
12
|
+
|
|
13
|
+
> **Should this dataset be allowed into a training run at all?**
|
|
14
|
+
|
|
15
|
+
A clean loss curve cannot tell you that your evaluation examples leaked into training, that hundreds of rows are duplicated, or that private data is sitting in a JSONL file. CorpusGuard provides a deterministic, local pre-flight audit with a single quality score and evidence for every deduction.
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
Install CorpusGuard from PyPI:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pip install corpusguard-audit
|
|
23
|
+
pip install -e .
|
|
24
|
+
corpusguard scan examples/demo.jsonl
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Generate machine-readable and standalone HTML reports:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
corpusguard scan data/train.jsonl \
|
|
31
|
+
--json-out corpusguard-report.json \
|
|
32
|
+
--html-out corpusguard-report.html
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Check train/eval leakage:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
corpusguard scan data/train.jsonl --compare data/eval.jsonl
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Use it as a CI gate:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
corpusguard scan data/train.jsonl --compare data/eval.jsonl --fail-below 85
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Exit code `2` means the quality score fell below the requested threshold.
|
|
48
|
+
|
|
49
|
+
## What v0.1 checks
|
|
50
|
+
|
|
51
|
+
| Check | What it catches |
|
|
52
|
+
|---|---|
|
|
53
|
+
| JSON/schema validation | malformed JSONL and unsupported SFT row shapes |
|
|
54
|
+
| Exact duplicates | repeated prompt/answer examples |
|
|
55
|
+
| Near duplicates | highly overlapping examples using token Jaccard similarity |
|
|
56
|
+
| PII patterns | emails, phone-like values, 12-digit IDs, card-like numbers |
|
|
57
|
+
| Empty/short outputs | weak supervision and accidental blank labels |
|
|
58
|
+
| Repetition | degenerate repeated-token answers |
|
|
59
|
+
| Script distribution | Latin/Cyrillic/other letter counts for multilingual corpus visibility |
|
|
60
|
+
| Split leakage | exact examples duplicated between train and eval/test JSONL |
|
|
61
|
+
| Quality score | deterministic 0–100 score with A–F grade |
|
|
62
|
+
|
|
63
|
+
## Supported dataset shapes
|
|
64
|
+
|
|
65
|
+
OpenAI/chat style:
|
|
66
|
+
|
|
67
|
+
```json
|
|
68
|
+
{"messages":[{"role":"user","content":"Question"},{"role":"assistant","content":"Answer"}]}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Prompt/completion:
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{"prompt":"Question","completion":"Answer"}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Alpaca/instruction:
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{"instruction":"Task","input":"Optional context","output":"Answer"}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Question/answer:
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{"question":"Question","answer":"Answer"}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Example output
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
CorpusGuard v0.1.0
|
|
93
|
+
Dataset: examples/demo.jsonl
|
|
94
|
+
Quality score: 57/100 (F)
|
|
95
|
+
|
|
96
|
+
Metric Value
|
|
97
|
+
rows 5
|
|
98
|
+
valid rows 5
|
|
99
|
+
invalid rows 0
|
|
100
|
+
exact duplicate rows 1
|
|
101
|
+
pii hits 1
|
|
102
|
+
leakage matches 0
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The demo file intentionally contains bad data so the checks are visible.
|
|
106
|
+
|
|
107
|
+
## Philosophy
|
|
108
|
+
|
|
109
|
+
CorpusGuard's default checks are **local, deterministic and model-free**. Your training data is not sent to an API. Semantic/LLM-based review can be useful, but it should be an explicit optional layer rather than a hidden dependency in the basic audit path.
|
|
110
|
+
|
|
111
|
+
## Current limitations
|
|
112
|
+
|
|
113
|
+
- Near-duplicate detection in v0.1 is an O(n²) reference implementation intended for small and medium corpora.
|
|
114
|
+
- PII checks are pattern-based and can produce false positives/negatives; they are a review signal, not a compliance guarantee.
|
|
115
|
+
- Script counts are not language identification.
|
|
116
|
+
- Exact split leakage does not yet detect paraphrased semantic leakage.
|
|
117
|
+
|
|
118
|
+
See [ROADMAP.md](ROADMAP.md) for the planned scalable and semantic checks.
|
|
119
|
+
|
|
120
|
+
## Development
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
python -m venv .venv
|
|
124
|
+
source .venv/bin/activate
|
|
125
|
+
pip install -e ".[dev]"
|
|
126
|
+
pytest -q
|
|
127
|
+
ruff check .
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## License
|
|
131
|
+
|
|
132
|
+
Apache-2.0. Created by [@yerbolisaac](https://github.com/yerbolisaac).
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Roadmap
|
|
2
|
+
|
|
3
|
+
## v0.1 — deterministic pre-flight audit
|
|
4
|
+
- JSONL schema normalization
|
|
5
|
+
- exact duplicates
|
|
6
|
+
- dependency-free near-duplicate detection
|
|
7
|
+
- PII pattern checks
|
|
8
|
+
- repetition checks
|
|
9
|
+
- train/eval exact leakage
|
|
10
|
+
- JSON + HTML reports
|
|
11
|
+
- CI score gates
|
|
12
|
+
|
|
13
|
+
## v0.2 — scalable corpus analysis
|
|
14
|
+
- MinHash/LSH duplicate search
|
|
15
|
+
- streaming mode for multi-GB datasets
|
|
16
|
+
- tokenizer-aware length analysis
|
|
17
|
+
- Hugging Face Dataset support
|
|
18
|
+
- configurable policies via `corpusguard.yaml`
|
|
19
|
+
|
|
20
|
+
## v0.3 — semantic quality
|
|
21
|
+
- optional local embedding checks
|
|
22
|
+
- topic balance and cluster outliers
|
|
23
|
+
- semantic train/eval leakage
|
|
24
|
+
- answer-consistency checks
|
|
25
|
+
- benchmark contamination packs
|
|
26
|
+
|
|
27
|
+
## v0.4 — LLM-native review
|
|
28
|
+
- opt-in local judge adapters
|
|
29
|
+
- rubric-based quality scoring
|
|
30
|
+
- hallucination/evidence checks for grounded datasets
|
|
31
|
+
- human-review queues
|
|
32
|
+
|
|
33
|
+
## v1.0
|
|
34
|
+
- stable policy schema
|
|
35
|
+
- SARIF/GitHub code-scanning output
|
|
36
|
+
- reproducible audit manifests
|
|
37
|
+
- plugin API for custom checks
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{"messages":[{"role":"user","content":"Explain why the sky looks blue."},{"role":"assistant","content":"Air molecules scatter shorter blue wavelengths of sunlight more strongly than longer red wavelengths."}]}
|
|
2
|
+
{"prompt":"What is 7 × 8?","completion":"7 × 8 equals 56."}
|
|
3
|
+
{"instruction":"Summarize","input":"Machine learning systems depend strongly on the quality of their training data.","output":"Training-data quality strongly affects machine-learning systems."}
|
|
4
|
+
{"prompt":"Contact support at demo@example.com","completion":"You can also call +7 701 123 45 67 for assistance."}
|
|
5
|
+
{"prompt":"What is 7 × 8?","completion":"7 × 8 equals 56."}
|