glitchlings 0.4.4__cp313-cp313-manylinux_2_28_x86_64.whl

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.

Potentially problematic release.


This version of glitchlings might be problematic. Click here for more details.

Files changed (47) hide show
  1. glitchlings/__init__.py +67 -0
  2. glitchlings/__main__.py +8 -0
  3. glitchlings/_zoo_rust.cpython-313-x86_64-linux-gnu.so +0 -0
  4. glitchlings/compat.py +284 -0
  5. glitchlings/config.py +388 -0
  6. glitchlings/config.toml +3 -0
  7. glitchlings/dlc/__init__.py +7 -0
  8. glitchlings/dlc/_shared.py +153 -0
  9. glitchlings/dlc/huggingface.py +81 -0
  10. glitchlings/dlc/prime.py +254 -0
  11. glitchlings/dlc/pytorch.py +166 -0
  12. glitchlings/dlc/pytorch_lightning.py +215 -0
  13. glitchlings/lexicon/__init__.py +192 -0
  14. glitchlings/lexicon/_cache.py +110 -0
  15. glitchlings/lexicon/data/default_vector_cache.json +82 -0
  16. glitchlings/lexicon/metrics.py +162 -0
  17. glitchlings/lexicon/vector.py +651 -0
  18. glitchlings/lexicon/wordnet.py +232 -0
  19. glitchlings/main.py +364 -0
  20. glitchlings/util/__init__.py +195 -0
  21. glitchlings/util/adapters.py +27 -0
  22. glitchlings/zoo/__init__.py +168 -0
  23. glitchlings/zoo/_ocr_confusions.py +32 -0
  24. glitchlings/zoo/_rate.py +131 -0
  25. glitchlings/zoo/_rust_extensions.py +143 -0
  26. glitchlings/zoo/_sampling.py +54 -0
  27. glitchlings/zoo/_text_utils.py +100 -0
  28. glitchlings/zoo/adjax.py +128 -0
  29. glitchlings/zoo/apostrofae.py +127 -0
  30. glitchlings/zoo/assets/__init__.py +0 -0
  31. glitchlings/zoo/assets/apostrofae_pairs.json +32 -0
  32. glitchlings/zoo/core.py +582 -0
  33. glitchlings/zoo/jargoyle.py +335 -0
  34. glitchlings/zoo/mim1c.py +109 -0
  35. glitchlings/zoo/ocr_confusions.tsv +30 -0
  36. glitchlings/zoo/redactyl.py +193 -0
  37. glitchlings/zoo/reduple.py +148 -0
  38. glitchlings/zoo/rushmore.py +153 -0
  39. glitchlings/zoo/scannequin.py +171 -0
  40. glitchlings/zoo/typogre.py +231 -0
  41. glitchlings/zoo/zeedub.py +185 -0
  42. glitchlings-0.4.4.dist-info/METADATA +627 -0
  43. glitchlings-0.4.4.dist-info/RECORD +47 -0
  44. glitchlings-0.4.4.dist-info/WHEEL +5 -0
  45. glitchlings-0.4.4.dist-info/entry_points.txt +2 -0
  46. glitchlings-0.4.4.dist-info/licenses/LICENSE +201 -0
  47. glitchlings-0.4.4.dist-info/top_level.txt +1 -0
@@ -0,0 +1,627 @@
1
+ Metadata-Version: 2.4
2
+ Name: glitchlings
3
+ Version: 0.4.4
4
+ Summary: Monsters for your language games.
5
+ Author: osoleve
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ APPENDIX: How to apply the Apache License to your work.
184
+
185
+ To apply the Apache License to your work, attach the following
186
+ boilerplate notice, with the fields enclosed by brackets "[]"
187
+ replaced with your own identifying information. (Don't include
188
+ the brackets!) The text should be enclosed in the appropriate
189
+ comment syntax for the file format. We also recommend that a
190
+ file or class name and description of purpose be included on the
191
+ same "printed page" as the copyright notice for easier
192
+ identification within third-party archives.
193
+
194
+ Copyright 2025 osoleve
195
+
196
+ Licensed under the Apache License, Version 2.0 (the "License");
197
+ you may not use this file except in compliance with the License.
198
+ You may obtain a copy of the License at
199
+
200
+ http://www.apache.org/licenses/LICENSE-2.0
201
+
202
+ Unless required by applicable law or agreed to in writing, software
203
+ distributed under the License is distributed on an "AS IS" BASIS,
204
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205
+ See the License for the specific language governing permissions and
206
+ limitations under the License.
207
+
208
+ Project-URL: Homepage, https://github.com/osoleve/glitchlings
209
+ Project-URL: Repository, https://github.com/osoleve/glitchlings.git
210
+ Project-URL: Issues, https://github.com/osoleve/glitchlings/issues
211
+ Project-URL: Changelog, https://github.com/osoleve/glitchlings/releases
212
+ Keywords: nlp,adversarial augmentation,text augmentation,data augmentation,domain randomization
213
+ Classifier: Development Status :: 3 - Alpha
214
+ Classifier: Intended Audience :: Developers
215
+ Classifier: Programming Language :: Python
216
+ Classifier: Programming Language :: Python :: 3
217
+ Classifier: Programming Language :: Python :: 3.10
218
+ Classifier: Programming Language :: Python :: 3.11
219
+ Classifier: Programming Language :: Python :: 3.12
220
+ Classifier: Programming Language :: Python :: 3.13
221
+ Classifier: Programming Language :: Rust
222
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
223
+ Classifier: Topic :: Software Development :: Testing
224
+ Requires-Python: >=3.10
225
+ Description-Content-Type: text/markdown
226
+ License-File: LICENSE
227
+ Requires-Dist: confusable-homoglyphs>=3.3.1
228
+ Requires-Dist: tomli>=2.0.1; python_version < "3.11"
229
+ Requires-Dist: pyyaml>=6.0.0
230
+ Provides-Extra: all
231
+ Requires-Dist: black>=24.4.0; extra == "all"
232
+ Requires-Dist: hypothesis>=6.140.0; extra == "all"
233
+ Requires-Dist: interrogate>=1.5.0; extra == "all"
234
+ Requires-Dist: jellyfish>=1.2.0; extra == "all"
235
+ Requires-Dist: isort>=5.13.0; extra == "all"
236
+ Requires-Dist: mkdocs>=1.6.0; extra == "all"
237
+ Requires-Dist: mkdocs-material>=9.5.0; extra == "all"
238
+ Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "all"
239
+ Requires-Dist: mkdocstrings-python>=1.10.0; extra == "all"
240
+ Requires-Dist: mypy>=1.8.0; extra == "all"
241
+ Requires-Dist: numpy<3.0,>=1.24; extra == "all"
242
+ Requires-Dist: pre-commit>=3.8.0; extra == "all"
243
+ Requires-Dist: pytest>=8.0.0; extra == "all"
244
+ Requires-Dist: pytest-cov>=4.1.0; extra == "all"
245
+ Requires-Dist: ruff>=0.6.0; extra == "all"
246
+ Requires-Dist: verifiers>=0.1.3.post0; extra == "all"
247
+ Provides-Extra: hf
248
+ Requires-Dist: datasets>=4.0.0; extra == "hf"
249
+ Provides-Extra: lightning
250
+ Requires-Dist: pytorch_lightning>=2.0.0; extra == "lightning"
251
+ Provides-Extra: vectors
252
+ Requires-Dist: numpy<3.0,>=1.24; extra == "vectors"
253
+ Requires-Dist: spacy>=3.7.2; extra == "vectors"
254
+ Requires-Dist: gensim>=4.3.2; extra == "vectors"
255
+ Provides-Extra: st
256
+ Requires-Dist: sentence-transformers>=3.0.0; extra == "st"
257
+ Provides-Extra: prime
258
+ Requires-Dist: verifiers>=0.1.3.post0; extra == "prime"
259
+ Requires-Dist: jellyfish>=1.2.0; extra == "prime"
260
+ Provides-Extra: torch
261
+ Requires-Dist: torch>=2.0.0; extra == "torch"
262
+ Provides-Extra: dev
263
+ Requires-Dist: pytest>=8.0.0; extra == "dev"
264
+ Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
265
+ Requires-Dist: hypothesis>=6.140.0; extra == "dev"
266
+ Requires-Dist: numpy<3.0,>=1.24; extra == "dev"
267
+ Requires-Dist: mkdocs>=1.6.0; extra == "dev"
268
+ Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "dev"
269
+ Requires-Dist: mkdocs-material>=9.5.0; extra == "dev"
270
+ Requires-Dist: mkdocstrings-python>=1.10.0; extra == "dev"
271
+ Requires-Dist: interrogate>=1.5.0; extra == "dev"
272
+ Requires-Dist: black>=24.4.0; extra == "dev"
273
+ Requires-Dist: isort>=5.13.0; extra == "dev"
274
+ Requires-Dist: ruff>=0.6.0; extra == "dev"
275
+ Requires-Dist: mypy>=1.8.0; extra == "dev"
276
+ Requires-Dist: pre-commit>=3.8.0; extra == "dev"
277
+ Dynamic: license-file
278
+
279
+ #
280
+
281
+ ```plaintext
282
+ .─') _ .─') _
283
+ ( OO) ) ( OO ) )
284
+ ░██████ ░██ ░██ ░██ ░██ ░██ ░██
285
+ ░██ ░██ ░██ ░██ ░██ ░██
286
+ ░██ ░██ ░██░████████ ░███████ ░████████ ░██ ░██░████████ ░████████ ░███████
287
+ ░██ █████ ░██ ░██ ░██ ░██('─.░██ ░██ ░██ ░██ ░██░██ ░██ ░██.─')░██ ░██
288
+ ░██ ██ ░██ ░██ ░██ ░██( OO ) ╱░██ ░██ ░██ ░██░██ ░██ ░██(OO)░██ ░███████
289
+ ░██ ░███ ░██ ░██ ░██ ░██ ░██ ░██ ░██ ░██ ░██░██ ░██ ░██ o░███ ░██
290
+ ░█████░█ ░██ ░██ ░████ ░███████ ░██ ░██ ░██ ░██░██ ░██ ░█████░██ ░███████
291
+ ░██
292
+ ░███████
293
+
294
+ Every language game breeds monsters.
295
+ ```
296
+
297
+ `Glitchlings` are **utilities for corrupting the text inputs to your language models in deterministic, _linguistically principled_** ways.
298
+ Each embodies a different way that documents can be compromised in the wild.
299
+
300
+ If reinforcement learning environments are games, then `Glitchling`s are enemies to breathe new life into old challenges.
301
+
302
+ They do this by breaking surface patterns in the input while keeping the target output intact.
303
+
304
+ Some `Glitchling`s are petty nuisances. Some `Glitchling`s are eldritch horrors.
305
+ Together, they create truly nightmarish scenarios for your language models.
306
+
307
+ After all, what good is general intelligence if it can't handle a little chaos?
308
+
309
+ -_The Curator_
310
+
311
+ ## Quickstart
312
+
313
+ ```python
314
+ pip install -U glitchlings
315
+ ```
316
+
317
+ > Glitchlings requires Python 3.10 or newer.
318
+
319
+ ```python
320
+ from glitchlings import Gaggle, SAMPLE_TEXT, Typogre, Mim1c, Reduple, Rushmore
321
+
322
+ gaggle = Gaggle([
323
+ Typogre(rate=0.03),
324
+ Mim1c(rate=0.02),
325
+ Reduple(seed=404),
326
+ Rushmore(rate=0.02),
327
+ ])
328
+
329
+ print(gaggle(SAMPLE_TEXT))
330
+ ```
331
+
332
+ > Onҽ m‎ھ‎rning, wһen Gregor Samƽa woke from trouble𝐝 𝑑reams, he found himself transformed in his bed into a horrible vermin‎٠‎ He l lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightlh domed and divided by arches ino stiff sections. The bedding was adly able to cover it and and seemed ready to slide off any moment. His many legxs, pitifully thin compared with the size of the the rest of him, waved about helplessly ashe looked looked.
333
+
334
+ Consult the [Glitchlings Usage Guide](docs/index.md)
335
+ for end-to-end instructions spanning the Python API, CLI, HuggingFace, PyTorch, and Prime Intellect
336
+ integrations, and the autodetected Rust pipeline (enabled whenever the extension is present).
337
+
338
+ ## Motivation
339
+
340
+ If your model performs well on a particular task, but not when `Glitchling`s are present, it's a sign that it hasn't actually generalized to the problem.
341
+
342
+ Conversely, training a model to perform well in the presence of the types of perturbations introduced by `Glitchling`s should help it generalize better.
343
+
344
+ ## Your First Battle
345
+
346
+ Summon your chosen `Glitchling` (_or a few, if ya nasty_) and call it on your text or slot it into `Dataset.map(...)`, supplying a seed if desired.
347
+ Glitchlings are standard Python classes, so you can instantiate them with whatever parameters fit your scenario:
348
+
349
+ ```python
350
+ from glitchlings import Gaggle, Typogre, Mim1c
351
+
352
+ custom_typogre = Typogre(rate=0.1)
353
+ selective_mimic = Mim1c(rate=0.05, classes=["LATIN", "GREEK"])
354
+
355
+ gaggle = Gaggle([custom_typogre, selective_mimic], seed=99)
356
+ print(gaggle("Summoned heroes do not fear the glitch."))
357
+ ```
358
+
359
+ Calling a `Glitchling` on a `str` transparently calls `.corrupt(str, ...) -> str`.
360
+ This means that as long as your glitchlings get along logically, they play nicely with one another.
361
+
362
+ When summoned as or gathered into a `Gaggle`, the `Glitchling`s will automatically order themselves into attack waves, based on the scope of the change they make:
363
+
364
+ 1. Document
365
+ 2. Paragraph
366
+ 3. Sentence
367
+ 4. Word
368
+ 5. Character
369
+
370
+ They're horrible little gremlins, but they're not _unreasonable_.
371
+
372
+ ## Command-Line Interface (CLI)
373
+
374
+ Keyboard warriors can challenge them directly via the `glitchlings` command:
375
+
376
+ <!-- BEGIN: CLI_USAGE -->
377
+ ```bash
378
+ # Discover which glitchlings are currently on the loose.
379
+ glitchlings --list
380
+ ```
381
+
382
+ ```text
383
+ Typogre — scope: Character, order: early
384
+ Apostrofae — scope: Character, order: normal
385
+ Mim1c — scope: Character, order: last
386
+ Jargoyle — scope: Word, order: normal
387
+ Adjax — scope: Word, order: normal
388
+ Reduple — scope: Word, order: normal
389
+ Rushmore — scope: Word, order: normal
390
+ Redactyl — scope: Word, order: normal
391
+ Scannequin — scope: Character, order: late
392
+ Zeedub — scope: Character, order: last
393
+ ```
394
+
395
+ ```bash
396
+ # Review the full CLI contract.
397
+ glitchlings --help
398
+ ```
399
+
400
+ ```text
401
+ usage: glitchlings [-h] [-g SPEC] [-s SEED] [-f FILE] [--sample] [--diff]
402
+ [--list] [-c CONFIG]
403
+ [text]
404
+
405
+ Summon glitchlings to corrupt text. Provide input text as an argument, via
406
+ --file, or pipe it on stdin.
407
+
408
+ positional arguments:
409
+ text Text to corrupt. If omitted, stdin is used or --sample
410
+ provides fallback text.
411
+
412
+ options:
413
+ -h, --help show this help message and exit
414
+ -g SPEC, --glitchling SPEC
415
+ Glitchling to apply, optionally with parameters like
416
+ Typogre(rate=0.05). Repeat for multiples; defaults to
417
+ all built-ins.
418
+ -s SEED, --seed SEED Seed controlling deterministic corruption order
419
+ (default: 151).
420
+ -f FILE, --file FILE Read input text from a file instead of the command
421
+ line argument.
422
+ --sample Use the included SAMPLE_TEXT when no other input is
423
+ provided.
424
+ --diff Show a unified diff between the original and corrupted
425
+ text.
426
+ --list List available glitchlings and exit.
427
+ -c CONFIG, --config CONFIG
428
+ Load glitchlings from a YAML configuration file.
429
+ ```
430
+ <!-- END: CLI_USAGE -->
431
+
432
+ Run `python docs/build_cli_reference.py` whenever you tweak the CLI so the README stays in sync with the actual output. The script executes the commands above and replaces the block between the markers automatically.
433
+
434
+ Prefer inline tweaks? You can still configure glitchlings directly in the shell:
435
+
436
+ ```bash
437
+ # Run Typogre against the contents of a file and inspect the diff.
438
+ glitchlings -g typogre --file documents/report.txt --diff
439
+
440
+ # Configure glitchlings inline by passing keyword arguments.
441
+ glitchlings -g "Typogre(rate=0.05)" "Ghouls just wanna have fun"
442
+
443
+ # Pipe text straight into the CLI for an on-the-fly corruption.
444
+ echo "Beware LLM-written flavor-text" | glitchlings -g mim1c
445
+
446
+ # Load a roster from a YAML attack configuration.
447
+ glitchlings --config experiments/chaos.yaml "Let slips the glitchlings of war"
448
+ ```
449
+
450
+ Attack configurations live in plain YAML files so you can version-control experiments without touching code:
451
+
452
+ ```yaml
453
+ # experiments/chaos.yaml
454
+ seed: 31337
455
+ glitchlings:
456
+ - name: Typogre
457
+ rate: 0.04
458
+ - "Rushmore(rate=0.12, unweighted=True)"
459
+ - name: Zeedub
460
+ parameters:
461
+ rate: 0.02
462
+ characters: ["\u200b", "\u2060"]
463
+ ```
464
+
465
+ Pass the file to `glitchlings --config` or load it from Python with `glitchlings.load_attack_config` and `glitchlings.build_gaggle`.
466
+
467
+ ## Development
468
+
469
+ Follow the [development setup guide](docs/development.md) for editable installs, automated tests, and tips on enabling the Rust pipeline while you hack on new glitchlings.
470
+
471
+ ## Starter 'lings
472
+
473
+ For maintainability reasons, all `Glitchling` have consented to be given nicknames once they're in your care. See the [Monster Manual](MONSTER_MANUAL.md) for a complete bestiary.
474
+
475
+ ### Typogre
476
+
477
+ _What a nice word, would be a shame if something happened to it._
478
+
479
+ > _**Fatfinger.**_ Typogre introduces character-level errors (duplicating, dropping, adding, or swapping) based on the layout of a keyboard (QWERTY by default, with Dvorak and Colemak variants built-in).
480
+ >
481
+ > Args
482
+ >
483
+ > - `rate (float)`: The maximum number of edits to make as a percentage of the length (default: 0.02, 2%).
484
+ > - `keyboard (str)`: Keyboard layout key-neighbor map to use (default: "CURATOR_QWERTY"; also accepts "QWERTY", "DVORAK", "COLEMAK", and "AZERTY").
485
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
486
+
487
+ ### Apostrofae
488
+
489
+ _It looks like you're trying to paste some text. Can I help?_
490
+
491
+ > _**Paperclip Manager.**_ Apostrofae scans for balanced runs of straight quotes, apostrophes, and backticks before replacing them with randomly sampled smart-quote pairs from a curated lookup table. The swap happens in-place so contractions and unpaired glyphs remain untouched.
492
+ >
493
+ > Args
494
+ >
495
+ > - `seed (int)`: Optional seed controlling the deterministic smart-quote sampling (default: 151).
496
+
497
+ ### Mim1c
498
+
499
+ _Wait, was that...?_
500
+
501
+ > _**Confusion.**_ Mim1c replaces non-space characters with Unicode Confusables, characters that are distinct but would not usually confuse a human reader.
502
+ >
503
+ > Args
504
+ >
505
+ > - `rate (float)`: The maximum proportion of characters to replace (default: 0.02, 2%).
506
+ > - `classes (list[str] | "all")`: Restrict replacements to these Unicode script classes (default: ["LATIN", "GREEK", "CYRILLIC"]).
507
+ > - `banned_characters (Collection[str])`: Characters that must never appear as replacements (default: none).
508
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
509
+
510
+ ### Scannequin
511
+
512
+ _How can a computer need reading glasses?_
513
+
514
+ > _**OCR Artifacts.**_ Scannequin mimics optical character recognition errors by swapping visually similar character sequences (like rn↔m, cl↔d, O↔0, l/I/1).
515
+ >
516
+ > Args
517
+ >
518
+ > - `rate (float)`: The maximum proportion of eligible confusion spans to replace (default: 0.02, 2%).
519
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
520
+
521
+ ### Zeedub
522
+
523
+ _Watch your step around here._
524
+
525
+ > _**Invisible Ink.**_ Zeedub slips zero-width codepoints between non-space character pairs, forcing models to reason about text whose visible form masks hidden glyphs.
526
+ >
527
+ > Args
528
+ >
529
+ > - `rate (float)`: Expected number of zero-width insertions as a proportion of eligible bigrams (default: 0.02, 2%).
530
+ > - `characters (Sequence[str])`: Optional override for the pool of zero-width strings to inject (default: curated invisibles such as U+200B, U+200C, U+200D, U+FEFF, U+2060).
531
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
532
+
533
+ ### Jargoyle
534
+
535
+ _Uh oh. The worst person you know just bought a thesaurus._
536
+
537
+ > _**Sesquipedalianism.**_ Jargoyle, the insufferable `Glitchling`, replaces words from selected parts of speech with synonyms at random, without regard for connotational or denotational differences.
538
+ >
539
+ > Args
540
+ >
541
+ > - `rate (float)`: The maximum proportion of words to replace (default: 0.01, 1%).
542
+ - `part_of_speech`: The WordNet-style part(s) of speech to target (default: nouns). Accepts `wn.NOUN`, `wn.VERB`, `wn.ADJ`, `wn.ADV`, any iterable of those tags, or the string `"any"` to include them all. Vector/graph backends ignore this filter while still honouring deterministic sampling.
543
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
544
+
545
+ ### Reduple
546
+
547
+ _Did you say that or did I?_
548
+
549
+ > _**Broken Record.**_ Reduple stutters through text by randomly reduplicating words. Like a nervous speaker, it creates natural repetitions that test a model's ability to handle redundancy without losing the thread.
550
+ >
551
+ > Args
552
+ >
553
+ > - `rate (float)`: The maximum proportion of words to reduplicate (default: 0.01, 1%).
554
+ > - `unweighted (bool)`: Sample words uniformly instead of favouring shorter tokens (default: False).
555
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
556
+
557
+ ### Rushmore
558
+
559
+ _I accidentally an entire word._
560
+
561
+ > _**Hasty Omission.**_ The evil (?) twin of `reduple`, Rushmore moves with such frantic speed that it causes words to simply vanish from existence as it passes.
562
+ >
563
+ > Args
564
+ >
565
+ > - `rate (float)`: The maximum proportion of words to delete (default: 0.01, 1%).
566
+ > - `unweighted (bool)`: Sample words uniformly instead of favouring shorter tokens (default: False).
567
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
568
+
569
+ ### Adjax
570
+
571
+ _Keep your hands and punctuation where I can see them._
572
+
573
+ > _**Perfect Shuffle.**_ Adjax trades the cores of neighbouring words while leaving punctuation, casing, and surrounding whitespace untouched, turning fluent prose into locally scrambled tongue-twisters.
574
+ >
575
+ > Args
576
+ >
577
+ > - `rate (float)`: Probability that each adjacent pair swaps cores (default: 0.5, 50%).
578
+ > - `swap_rate (float)`: Alias for `rate`, retained for backward compatibility.
579
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
580
+
581
+ ### Redactyl
582
+
583
+ _Oops, that was my black highlighter._
584
+
585
+ > _**FOIA Reply.**_ Redactyl obscures random words in your document like an NSA analyst with a bad sense of humor.
586
+ >
587
+ > ### Args
588
+ >
589
+ > - `replacement_char (str)`: The character to use for redaction (default: FULL_BLOCK).
590
+ > - `rate (float)`: The maximum proportion of words to redact (default: 0.025, 2.5%).
591
+ > - `merge_adjacent (bool)`: Whether to redact the space between adjacent redacted words (default: False).
592
+ > - `unweighted (bool)`: Sample words uniformly instead of biasing toward longer tokens (default: False).
593
+ > - `seed (int)`: The random seed for reproducibility (default: 151).
594
+
595
+ ## Field Report: Uncontained Specimens
596
+
597
+ ### _Containment procedures pending_
598
+
599
+ - `ekkokin` substitutes words with homophones (phonetic equivalents).
600
+ - `nylingual` backtranslates portions of text.
601
+ - `glothopper` introduces code-switching effects, blending languages or dialects.
602
+ - `palimpsest` rewrites, but leaves accidental traces of the past.
603
+ - `vesuvius` is an apocryphal `Glitchling` with ties to _[Nosy, aren't we? -The Curator]_
604
+
605
+ ## Apocrypha
606
+
607
+ Cave paintings and oral tradition contain many depictions of strange, otherworldly `Glitchling`s.
608
+ These _Apocryphal `Glitchling`_ are said to possess unique abilities or behaviors.
609
+ If you encounter one of these elusive beings, please document your findings and share them with _The Curator_.
610
+
611
+ ### Ensuring Reproducible Corruption
612
+
613
+ Every `Glitchling` should own its own independent `random.Random` instance. That means:
614
+
615
+ - No `random.seed(...)` calls touch Python's global RNG.
616
+ - Supplying a `seed` when you construct a `Glitchling` (or when you `summon(...)`) makes its behavior reproducible.
617
+ - Re-running a `Gaggle` with the same master seed and the same input text (_and same external data!_) yields identical corruption output.
618
+ - Corruption functions are written to accept an `rng` parameter internally so that all randomness is centralized and testable.
619
+
620
+ #### At Wits' End?
621
+
622
+ If you're trying to add a new glitchling and can't seem to make it deterministic, here are some places to look for determinism-breaking code:
623
+
624
+ 1. Search for any direct calls to `random.choice`, `random.shuffle`, or `set(...)` ordering without going through the provided `rng`.
625
+ 2. Ensure you sort collections before shuffling or sampling.
626
+ 3. Make sure indices are chosen from a stable reference (e.g., original text) when applying length‑changing edits.
627
+ 4. Make sure there are enough sort keys to maintain stability.
@@ -0,0 +1,47 @@
1
+ glitchlings/__init__.py,sha256=bkyRgzjC8ssidEO9UL9VpbYXQxTV1Hz3VAPOIqd9uMg,1182
2
+ glitchlings/__main__.py,sha256=f-P4jiVBd7ZpS6QxRpa_6SJgOG03UhZhcWasMDRWLs8,120
3
+ glitchlings/_zoo_rust.cpython-313-x86_64-linux-gnu.so,sha256=07BghaK-4uLr9690gHGu2ImvnwdwfxRam177-7ijbb4,3396232
4
+ glitchlings/compat.py,sha256=T_5Ia8yCzZvsMdicZ2TCcOgDO53_AjNGkSXWTR_qEnA,8908
5
+ glitchlings/config.py,sha256=ofxDMkoMg4j51CFube54aca1Ky9y_ZeVktXpeUEdWmA,12953
6
+ glitchlings/config.toml,sha256=04-Y_JCdQU68SRmwk2qZqrH_bbX4jEH9uh7URtxdIHA,99
7
+ glitchlings/main.py,sha256=uw8VbDgxov1m-wYHPDl2dP5ItpLB4ZHpb0ChJXzcL0o,10623
8
+ glitchlings/dlc/__init__.py,sha256=qlY4nuagy4AAWuPMwmuhwK2m36ktp-qkeiIxC7OXg34,305
9
+ glitchlings/dlc/_shared.py,sha256=OmEjJmSs1pQ7j1ggR_H8D8RDp5E1ZqOnzSIxyqRE1aE,4407
10
+ glitchlings/dlc/huggingface.py,sha256=9lW7TnTHA_bXyo4Is8pymZchrB9BIL1bMCP2p7LCMtg,2576
11
+ glitchlings/dlc/prime.py,sha256=qGFI1d4BiOEIgQZ5v9QnlbYx4J4q-vNlh5tWZng11xs,8607
12
+ glitchlings/dlc/pytorch.py,sha256=QaiIYyQ3koy2-enhUI9WY3SIMRX65gmsnjDvCsf8xbg,6233
13
+ glitchlings/dlc/pytorch_lightning.py,sha256=Ls7Xh5Mg643Tyk3KvCMq_MsB4vvekfUUZOhE0z4K22c,8074
14
+ glitchlings/lexicon/__init__.py,sha256=ooEPcAJhCI2Nw5z8OsQ0EtVpKBfiTrU0-AQJq8Zn2nQ,6007
15
+ glitchlings/lexicon/_cache.py,sha256=aWSUb5Ex162dr3HouO2Ic2O8ck3ViEFWs8-XMLKMeJ0,4086
16
+ glitchlings/lexicon/metrics.py,sha256=VBFfFpxjiEwZtK-jS55H8xP7MTC_0OjY8lQ5zSQ9aTY,4572
17
+ glitchlings/lexicon/vector.py,sha256=yWf-vlN2OEHnTCPu7tgDnJbhm47cmhdrTtjR0RZKkUM,22530
18
+ glitchlings/lexicon/wordnet.py,sha256=YcOliPHuesdlekmGspwAyR4fWDDxZWR_dIt_Nsq7ag0,7608
19
+ glitchlings/lexicon/data/default_vector_cache.json,sha256=3iVH0nX8EqMbqOkKWvORCGYtN0LKHn5G_Snlizsnm1g,997
20
+ glitchlings/util/__init__.py,sha256=vc3EAY8ehRjbOiryFdaqvvljXcyNGtZSPiEp9ok1vVw,4674
21
+ glitchlings/util/adapters.py,sha256=psxQFYSFmh1u7NuqtIrKwQP5FOhOrZoxZzc7X7DDi9U,693
22
+ glitchlings/zoo/__init__.py,sha256=1dWZPCTXuh5J7WdCxHX7ZX9bNd8bakzYndxQRhF43i8,5243
23
+ glitchlings/zoo/_ocr_confusions.py,sha256=Ju2_avXiwsr1p8zWFUTOzMxJ8vT5PpYobuGIn4L_sqI,1204
24
+ glitchlings/zoo/_rate.py,sha256=tkIlXHewE8s9w1jpCw8ZzkVN31690FAnvTM_R3dCIpY,3579
25
+ glitchlings/zoo/_rust_extensions.py,sha256=Bsd0kiPB1rUn5x3k7ykydFuk2YSvXS9CQGPRlE5XzXY,4211
26
+ glitchlings/zoo/_sampling.py,sha256=KrWyUSsYXghlvktS5hQBO0bPqywEEyA49A2qDWInB7Q,1586
27
+ glitchlings/zoo/_text_utils.py,sha256=fS5L_eq-foBbBdiv4ymI8-O0D0csc3yDekHpX8bqfV4,2754
28
+ glitchlings/zoo/adjax.py,sha256=XT5kKqPOUPgKSDOcR__HBnv4OXtBKee40GuNNmm1GYI,3518
29
+ glitchlings/zoo/apostrofae.py,sha256=qjpfnxdPWXMNzZnSD7UMfvHyzGKa7TLsvUhMsIvjwj8,3822
30
+ glitchlings/zoo/core.py,sha256=dRzUTmhOswDV0hWcaD-Sx7rZdPlrszn7C_1G2xd4ECk,20675
31
+ glitchlings/zoo/jargoyle.py,sha256=2TGU_z8gILwQ-lyZEqvmsrLupxqb8ydlDiwcp-O6WwY,11679
32
+ glitchlings/zoo/mim1c.py,sha256=-fgodKWZq--Xw8L2t1EqNbsh48bwX5jZxmiXdoaQShI,3437
33
+ glitchlings/zoo/ocr_confusions.tsv,sha256=KhtR7vJDTITpfTSGa-I7RHr6CK7LkGi2KjdhEWipI6o,183
34
+ glitchlings/zoo/redactyl.py,sha256=eWn7JC81BXkp2bSinwrBfU3jXukcUGDVkaa6BcGvte4,5559
35
+ glitchlings/zoo/reduple.py,sha256=zSc1N_-tz9Kl7CDMrdZKgCuW3Bxp_-g6axadAa6AszM,4224
36
+ glitchlings/zoo/rushmore.py,sha256=k429trwNPcWJHEOIoeGsdKBzJNL4Fxz9KRqX3Ro9u_0,4286
37
+ glitchlings/zoo/scannequin.py,sha256=GfjLYWWp-jdnOBmdg7gt5wQnobY8jWQHScB5EMgo6HE,4870
38
+ glitchlings/zoo/typogre.py,sha256=BQotNL-gn4PXQI9j63d2w9mQ4X6ZJKSJ4de-GN-gmUI,6686
39
+ glitchlings/zoo/zeedub.py,sha256=aNnjZGeTmMqA2WjgtGh7Fgl9pUQo3AZ2B-tYs2ZFOQE,4840
40
+ glitchlings/zoo/assets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
41
+ glitchlings/zoo/assets/apostrofae_pairs.json,sha256=bfjSEaMTI_axGNJ93nI431KXU0IVp7ayO42gGcMgL6U,521
42
+ glitchlings-0.4.4.dist-info/METADATA,sha256=onpPJTtANv13MyyvYS930OWiJb_Ipxvje5sTrNmNPQw,32388
43
+ glitchlings-0.4.4.dist-info/WHEEL,sha256=wj07yRGyNgfcgMSZOScoYkBkpidoeAzGSgCNSOVFG2E,113
44
+ glitchlings-0.4.4.dist-info/entry_points.txt,sha256=kGOwuAsjFDLtztLisaXtOouq9wFVMOJg5FzaAkg-Hto,54
45
+ glitchlings-0.4.4.dist-info/top_level.txt,sha256=VHFNBrLjtDwPCYXbGKi6o17Eueedi81eNbR3hBOoST0,12
46
+ glitchlings-0.4.4.dist-info/RECORD,,
47
+ glitchlings-0.4.4.dist-info/licenses/LICENSE,sha256=YCvGip-LoaRyu6h0nPo71q6eHEkzUpsE11psDJOIRkw,11337