SporeLabs Scrub training data

.gitattributes

@@ -0,0 +1,61 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.avro filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mds filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+data/train.jsonl filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,97 @@
+---
+license: cc-by-4.0
+language:
+  - en
+  - de
+  - es
+  - fr
+  - it
+  - nl
+  - pl
+  - pt
+  - sv
+task_categories:
+  - token-classification
+tags:
+  - pii
+  - redaction
+  - secrets
+  - privacy
+pretty_name: SporeLabs Scrub training data
+---
+
+# SporeLabs Scrub training data
+
+Text labelled with the personal details and secrets in it, each with its type and character offsets. This is the
+public-text part of the data [SporeLabs Scrub](https://huggingface.co/SporeLabs/scrub) was trained on. Every
+personal detail in it is a generated value; the people, numbers, keys and codes are not real.
+
+```python
+from datasets import load_dataset
+ds = load_dataset("SporeLabs/scrub-data")
+row = ds["train"][0]
+for start, end, kind in row["spans"]:
+    print(kind, row["text"][start:end])
+```
+
+| split | documents |
+|---|---|
+| `train` | 49,673 |
+| `dev` | 1,804 |
+
+`train` holds 126,846 labelled details; the most common are PERSON 54,977, USERNAME 28,276, ADDRESS 16,160, PHONE 10,943, EMAIL 9,089 and SECRET 7,387. Its documents are spoken requests (18,397, in English, French, German, Spanish, Italian, Dutch, Portuguese, Polish and Swedish), chats (6,660), SMS messages (5,288), chat-log exports (4,906), pasted records and git history (5,628), code and config (5,552), SMS inboxes (2,423), and logs, terminal output, letters and emails.
+
+## Fields
+
+| field | what |
+|---|---|
+| `id` | row id |
+| `text` | the document |
+| `spans` | `[start, end, TYPE]`, character offsets, end exclusive |
+| `mask_types` | types this row does not label (dates, organisations, places, IPs, IDs, URLs are present but unmarked); a trainer should give those types no loss on this row |
+| `style` | `asr` for copies written the way a speech recogniser writes them, otherwise empty |
+| `transforms` | what SporeLabs did to the source text (details replaced, slots filled, a block inserted, a wrapper) |
+| `sources`, `licences` | the public datasets the row's text came from, and their licences |
+| `genre` | chat, sms, speech, sms_inbox, chat_log, email, code, config, log and so on |
+
+Span types: `PERSON`, `EMAIL`, `PHONE`, `ADDRESS`, `USERNAME`, `SECRET` (keys, tokens, passwords and codes),
+`CREDIT_CARD`, `BANK`. The released scrubber's rules split `SECRET` into finer types (passwords, codes,
+keys by provider).
+
+## How SporeLabs built it
+
+1. **Public text.** Chats from WildChat (user turns), SMS messages, spoken assistant requests in nine languages from
+   MASSIVE, OpenAssistant answers, and Keycloak's message templates for sign-in codes.
+2. **Real details out.** SporeLabs found the personal details already in the text with its rules and GLiNER2 and
+   replaced each with a generated value of the same kind, labelled. Rows where the two disagreed were left out. In
+   MASSIVE, the human slot annotations mark the names and contacts. Before publishing, SporeLabs Scrub read every row
+   again and any row with an unlabelled detail was left out.
+3. **Details where they really turn up.** SporeLabs added generated details in the formats they leak from: command
+   lines, HTTP headers, logs, connection strings, CSV exports, chat and SMS-inbox exports with sign-in codes, git
+   history and email signatures, plus look-alikes that are not sensitive (example keys, test cards, hashes).
+4. **Spoken copies.** Some chat, SMS and MASSIVE rows also appear as a speech recogniser would write them, so codes,
+   emails and addresses appear spoken too.
+
+The model also trained on two public synthetic sets, [NVIDIA Nemotron-PII](https://huggingface.co/datasets/nvidia/Nemotron-PII)
+(CC BY 4.0) and [Gretel PII masking EN v1](https://huggingface.co/datasets/gretelai/gretel-pii-masking-en-v1)
+(Apache-2.0); get them from their own pages.
+
+**Code rows.** The model also trained on 40-line windows of public GitHub source files around credential and contact
+keywords, from [codeparrot/github-code-clean](https://huggingface.co/datasets/codeparrot/github-code-clean)
+(revision `c48d40f9`, files under MIT, Apache-2.0, BSD, ISC, CC0 or Unlicense only), with the same replacement and
+insertion steps. Those licences ask for each file's copyright notice, so only the rows from CC0 and Unlicense files are
+included here; build the rest from that dataset with the steps above.
+
+## Licence and credits
+
+The rows are released under CC BY 4.0, and each source's terms also apply to the text taken from it:
+
+- WildChat-1M (`allenai/WildChat-1M`, revision `7d6490e4`), Allen Institute for AI, ODC-BY 1.0. Zhao et al., "WildChat:
+  1M ChatGPT Interaction Logs in the Wild", ICLR 2024.
+- SMS Spam Collection (`ucirvine/sms_spam`), Almeida and Hidalgo, UCI Machine Learning Repository, CC BY 4.0,
+  https://doi.org/10.24432/C5CC84
+- MASSIVE 1.1 (FitzGerald et al., Amazon), CC BY 4.0.
+- OpenAssistant Conversations oasst2 (`OpenAssistant/oasst2`, revision `179dd21f`), Apache-2.0.
+- Keycloak message templates (https://github.com/keycloak/keycloak), Apache-2.0 (`licenses/Apache-2.0.txt`).
+
+Generated values come from Faker and random strings in each format.

SHA256SUMS

@@ -0,0 +1,4 @@
+92d28b03923c6d40f5c1b124bb9186e4f581c4a575093eb0b22292ea362f4a81  README.md
+d0f02e1d5f758ca31bce9453a5c6286c0c91ae475a0678d57efb93a9faf7ec51  data/dev.jsonl
+93c3e5f66ce9d8787aae7f2ac5a3b0945b81bab27a6c80fb890c072cd1b7ff33  data/train.jsonl
+c71d239df91726fc519c6eb72d318ec65820627232b2f796219e87dcf35d0ab4  licenses/Apache-2.0.txt

data/train.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93c3e5f66ce9d8787aae7f2ac5a3b0945b81bab27a6c80fb890c072cd1b7ff33
+size 31212651

licenses/Apache-2.0.txt

@@ -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 [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.