glitchlings 0.1.0__py3-none-any.whl

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build-and-publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write  # for OIDC
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+        working-directory: glitchlings
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: glitchlings/dist
+          # Uses OIDC by default if PYPI_API_TOKEN is not provided and the PyPI project is configured for trusted publishing.
+          # To use a token secret instead, uncomment the next line and add PYPI_API_TOKEN to repo secrets.
+          # password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/testpypi.yml

@@ -0,0 +1,38 @@
+name: Publish to TestPyPI
+
+on:
+  push:
+    branches: [ trunk ]
+
+jobs:
+  build-and-publish-testpypi:
+    if: ${{ secrets.TEST_PYPI_API_TOKEN != '' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+        working-directory: glitchlings
+
+      - name: Upload to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: glitchlings/dist
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.python-version
+uv.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 osoleve
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MONSTER_MANUAL.md

@@ -0,0 +1,272 @@
+# Glitchling Monster Manual
+
+This manual contains the detailed stat blocks and descriptions of the various Glitchlings.
+
+---
+
+## Scannequin
+
+_How can a computer need reading glasses?_
+
+> Small Construct (squinting), Neutral
+>
+> ---
+>
+> _**OCR Artifacts.**_ Scannequin mimics optical character recognition errors by swapping visually similar character sequences (e.g., rn↔m, cl↔d, O↔0, l/I/1).
+>
+> ### Scannequin Args
+>
+> - `error_rate (float)`: The maximum proportion of eligible confusion spans to replace (default: 0.02, 2%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import scannequin
+> >>> print(scannequin(sample_text))
+> ```
+>
+> > One moming, when Gregor Samsa woke from troub1ed dreams, he found himse1f transf0rmed in his bed into a horribIe vermin. He lay on his armour-1ike back, and if he lifted his head a 1ittle he couId see his brown bel1y, sIightIy domed and divided by arches into stiff sections.
+>
+> ---
+>
+> - **Armor Class** 12 (paper)
+> - **Hit Points** 9 (2d8)
+> - **Speed** 15 ft., 40 ppm
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |4 |10 |8 |11 |9 |6 |
+>
+> ---
+>
+> - **Skills** Investigation +2
+> - **Damage Vulnerabilities** coffee, humidity
+> - **Languages** Cornmon
+> - **Challenge** 0 (50 XP)
+>
+> ---
+
+## Typogre
+
+_What a nice word, would be a shame if something happened to it._
+
+> Tiny Giant (Dyskinetic), Chaotic Neutral
+>
+> ---
+>
+> _**Fatfinger.**_ Typogre introduces character-level errors (duplicating, dropping, adding, or swapping)
+> based on the layout of a (currently QWERTY) keyboard.
+>
+> ### Typogre Args
+>
+> - `max_change_rate (float)`: The maximum number of edits to make as a percentage of the length (default: 0.02, 2%).
+> - `preserve_first_last (bool)`: Avoid editing the first and last character of a word (default: False).
+> - `keyboard (str)`: Keyboard layout key-neighbor map to use (default: "CURATOR_QWERTY").
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import typogre
+> >>> typogre(sample_text)
+> ```
+>
+> > One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. He lay on hisarmour-like back, and if he lifted his head a little he could see his brown belly, slightly romed and divided by arches int stiff sections. The bedding was hrly able to cover it and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplesly ass he looked.
+>
+> ---
+>
+> - **Armor Class** 7 (mittens)
+> - **Hit Points** 17 (7d4)
+> - **Speed** 60 wpm
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |15 |1 |11 |2 |2 |9 |
+>
+> ---
+>
+> - **Skills** Sleight of Hand -3
+> - **Condition Immunities** blinded
+> - **Languages** understands English but can't read
+> - **Challenge** 1 (200 XP)
+>
+> ---
+
+## Mim1c
+
+_Wait, was that...?_
+
+> Tiny Monstrosity (capgras), chaotic evil
+>
+> ---
+>
+> _**Confusion.**_ Mim1c replaces non-space characters with Unicode Confusables, characters that are distinct but would not usually confuse a human reader.
+>
+> ### Mim1c Args
+>
+> - `replacement_rate (float)`: The maximum proportion of characters to replace (default: 0.02, 2%).
+> - `classes (list[str] | "all")`: Restrict replacements to these Unicode script classes (default: ["LATIN", "GREEK", "CYRILLIC"]).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import mim1c
+> >>> print(mim1c(sample_text))
+> ```
+>
+> > On𝗲 moꭈning‎؍‎ when Gregor S𝛼m𝑠𝚊 woke from troub‎𞸀‎ed dreams, he found himself transformed in his bed into a horrible vermin. He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it   t and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplessly as he looked.
+>
+> ---
+>
+> - **Armor Class** 14 (hide)
+> - **Hit Points** 1 (9d4 - 36)
+> - **Speed** 7O wpm
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |3 |15 |3 |13 |3 |7 |
+>
+> ---
+>
+> - **Skills** Deception +3, Stealth +6
+> - **Damage Immunities** memorization
+> - **Senses** truesight 30 ft.
+> - **Languages** Abyssal Unicode
+> - **Challenge** 2 (450 XP)
+>
+> ---
+
+## Jargoyle
+
+_Uh oh. The worst person you know just bought a thesaurus._
+
+> Medium Monstrosity (academic), Lawful Evil
+>
+> ---
+>
+> _**Sesquipedalianism.**_ Jargoyle, the insufferable `Glitchling`, replaces nouns with synonyms at random, without regard for connotational or denotational differences.
+>
+> ### Jargoyle Args
+>
+> - `replacement_rate (float)`: The maximum proportion of words to replace (default: 0.1, 10%).
+> - `part_of_speech`: The WordNet part of speech to target (default: nouns). Accepts `wn.NOUN`, `wn.VERB`, `wn.ADJ`, or `wn.ADV`.
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import jargoyle
+> >>> print(jargoyle(sample_text))
+> ```
+>
+> > One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible varmint. He lay on his armor-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arch into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplessly as he looked.
+>
+> ---
+>
+> - **Armor Class** 5 (thin skin)
+> - **Hit Points** 52 (8d8 + 16)
+> - **Speed** 30 ft. fly, 0 ft. socially
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |13 |5 |16 |19 |4 |17 |
+>
+> ---
+>
+> - **Skills** Deception +6, Persuasion +6
+> - **Damage Immunities** plain language
+> - **Condition Immunities** charmed
+> - **Senses** darkvision 60 ft.
+> - **Languages** understands all, but only speaks in overwrought synonyms
+> - **Challenge** 3 (700 XP)
+>
+> ---
+
+## Reduple
+
+_Did you say that or did I?_
+
+> Small Fey (echolalic), Chaotic Neutral
+>
+> ---
+>
+> _**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.
+>
+> ### Reduple Args
+>
+> - `reduplication_rate (float)`: The maximum proportion of words to reduplicate (default: 0.05, 5%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import reduple
+> >>> print(reduple(sample_text))
+> ```
+>
+> > One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and and seemed ready to to slide off any moment. His many legs, pitifully thin compared with the size of the the rest of him, waved waved about helplessly as he looked looked.
+>
+> ---
+>
+> - **Armor Class** 14
+> - **Hit Points** 13 (3d6 + 3)
+> - **Speed** 40 ft.
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |6 |18 |10 |7 |11 |14 |
+>
+> ---
+>
+> - **Skills** Performance +4, Stealth +6
+> - **Condition Immunities** silenced
+> - **Languages** Sylvan, Common (with an endearing stutter)
+> - **Challenge** 1/2 (100 XP)
+>
+> ---
+
+## Rushmore
+
+_I accidentally an entire word._
+
+> Tiny Aberration (kinetic), Chaotic Neutral
+>
+> ---
+>
+> _**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.
+>
+> ### Rushmore Args
+>
+> - `max_deletion_rate (float)`: The maximum proportion of words to delete (default: 0.01, 1%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+>
+> ```python
+> >>> from glitchlings import rushmore
+> >>> print(rushmore(sample_text))
+> ```
+>
+> > One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The was hardly able to cover it and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplessly as he looked.
+>
+> ---
+>
+> - **Armor Class** 16
+> - **Hit Points** 7 (2d4 + 2)
+> - **Speed** 60 ft.
+>
+> ---
+>
+> |STR|DEX|CON|INT|WIS|CHA|
+> |:---:|:---:|:---:|:---:|:---:|:---:|
+> |2 |22 |8 |5 |7 |6 |
+>
+> ---
+>
+> - **Skills** Acrobatics +8, Stealth +8
+> - **Damage Vulnerabilities** effects that cause slowness
+> - **Senses** blindsight 10 ft.
+> - **Languages** --
+> - **Challenge** 1 (200 XP)
+>
+> ---

PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: glitchlings
+Version: 0.1.0
+Summary: Monsters for your language games.
+Project-URL: Homepage, https://github.com/osoleve/glitchlings
+Project-URL: Repository, https://github.com/osoleve/glitchlings.git
+Project-URL: Issues, https://github.com/osoleve/glitchlings/issues
+Project-URL: Changelog, https://github.com/osoleve/glitchlings/releases
+Author: osoleve
+License: MIT License
+        
+        Copyright (c) 2025 osoleve
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: adversarial,data,evaluation,glitch,nlp,text
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Requires-Dist: confusable-homoglyphs>=3.3.1
+Requires-Dist: datasets>=4.0.0
+Requires-Dist: jellyfish>=1.2.0
+Requires-Dist: nltk>=3.9.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Provides-Extra: prime
+Requires-Dist: verifiers>=0.1.3.post0; extra == 'prime'
+Description-Content-Type: text/markdown
+
+#
+
+```plaintext
+     .─') _                                       .─') _                  
+    (  OO) )                                     ( OO ) )            
+  ░██████  ░██ ░██   ░██               ░██        ░██ ░██                                 
+ ░██   ░██ ░██       ░██               ░██        ░██                                     
+░██        ░██ ░██░████████  ░███████ ░████████  ░██ ░██░████████   ░████████ ░███████  
+░██  █████ ░██ ░██   ░██    ░██('─.░██ ░██    ░██ ░██ ░██░██    ░██ ░██.─')░██ ░██        
+░██     ██ ░██ ░██   ░██    ░██( OO ) ╱░██    ░██ ░██ ░██░██    ░██ ░██(OO)░██ ░███████  
+  ░██  ░███ ░██ ░██   ░██   ░██    ░██ ░██    ░██ ░██ ░██░██    ░██ ░██  o░███      ░██ 
+  ░█████░█ ░██ ░██   ░████   ░███████  ░██    ░██ ░██ ░██░██    ░██  ░█████░██ ░███████  
+                                                                           ░██            
+                                                                     ░███████             
+
+                        Every language game breeds monsters.
+```
+
+`Glitchlings` are **utilities for corrupting the text inputs to your language models in deterministic, _linguistically principled_** ways.  
+Each embodies a different way that documents can be compromised in the wild.
+
+If reinforcement learning environments are games, then `Glitchling`s are enemies to breathe new life into old challenges.
+
+They do this by breaking surface patterns in the input while keeping the target output intact.
+
+Some `Glitchling`s are petty nuisances. Some `Glitchling`s are eldritch horrors.  
+Together, they create truly nightmarish scenarios for your language models.
+
+After all, what good is general intelligence if it can't handle a little chaos?
+
+-_The Curator_
+
+## Quickstart
+
+```python
+from glitchlings import summon, SAMPLE_TEXT
+
+gaggle = summon(["reduple", "mim1c", "typogre", "rushmore"])
+gaggle(SAMPLE_TEXT)
+```
+
+> 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.
+
+## Motivation
+
+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.
+
+Conversely, training a model to perform well in the presence of the types of perturbations introduced by `Glitchling`s should help it generalize better.
+
+## Your First Battle
+
+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.  
+Some `Glitchling`s may have additional keyword arguments but they will always be optional with what I decide are "reasonable defaults".  
+Seed defaults to 151, obviously.
+
+Calling a `Glitchling` on a `str` transparently calls `.corrupt(str, ...) -> str`.  
+This means that as long as your glitchlings get along logically, they play nicely with one another.
+
+When summoned as a `Gaggle`, the `Glitchling`s will automatically order themselves into attack waves, based on the scope of the change they make:
+
+1. Document
+2. Paragraph
+3. Sentence
+4. Word
+5. Character
+
+They're horrible little gremlins, but they're not _unreasonable_.
+
+## Starter 'lings
+
+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.
+
+### Typogre
+
+_What a nice word, would be a shame if something happened to it._
+
+> _**Fatfinger.**_ Typogre introduces character-level errors (duplicating, dropping, adding, or swapping) based on the layout of a (currently QWERTY) keyboard.
+>
+> Args
+>
+> - `max_change_rate (float)`: The maximum number of edits to make as a percentage of the length (default: 0.02, 2%).
+> - `preserve_first_last (bool)`: Avoid editing the first and last character of a word (default: False).
+> - `keyboard (str)`: Keyboard layout key-neighbor map to use (default: "CURATOR_QWERTY").
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Mim1c
+
+_Wait, was that...?_
+
+> _**Confusion.**_ Mim1c replaces non-space characters with Unicode Confusables, characters that are distinct but would not usually confuse a human reader.
+>
+> Args
+>
+> - `replacement_rate (float)`: The maximum proportion of characters to replace (default: 0.02, 2%).
+> - `classes (list[str] | "all")`: Restrict replacements to these Unicode script classes (default: ["LATIN", "GREEK", "CYRILLIC"]).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Scannequin
+
+_How can a computer need reading glasses?_
+
+> _**OCR Artifacts.**_ Scannequin mimics optical character recognition errors by swapping visually similar character sequences (like rn↔m, cl↔d, O↔0, l/I/1).
+>
+> Args
+>
+> - `error_rate (float)`: The maximum proportion of eligible confusion spans to replace (default: 0.02, 2%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Jargoyle
+
+_Uh oh. The worst person you know just bought a thesaurus._
+
+> _**Sesquipedalianism.**_ Jargoyle, the insufferable `Glitchling`, replaces nouns with synonyms at random, without regard for connotational or denotational differences.
+>
+> Args
+>
+> - `replacement_rate (float)`: The maximum proportion of words to replace (default: 0.1, 10%).
+> - `part_of_speech`: The WordNet part of speech to target (default: nouns). Accepts `wn.NOUN`, `wn.VERB`, `wn.ADJ`, or `wn.ADV`.
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Reduple
+
+_Did you say that or did I?_
+
+> _**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.
+>
+> Args
+>
+> - `reduplication_rate (float)`: The maximum proportion of words to reduplicate (default: 0.05, 5%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Rushmore
+
+_I accidentally an entire word._
+
+> _**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.
+>
+> Args
+>
+> - `max_deletion_rate (float)`: The maximum proportion of words to delete (default: 0.01, 1%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Redactyl
+
+_Oops, that was my black highlighter._
+
+> _**FOIA Reply.**_ Redactyl obscures random words in your document like an NSA analyst with a bad sense of humor.
+>
+> ### Args
+>
+> - `replacement_char (str)`: The character to use for redaction (default: █).
+> - `redaction_rate (float)`: The maximum proportion of words to redact (default: 0.05, 5%).
+> - `merge_adjacent (bool)`: Whether to redact the space between adjacent redacted words (default: False).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+## Field Report: Uncontained Specimens
+
+### _Containment procedures pending_
+
+- `ekkokin` substitutes words with homophones (phonetic equivalents).
+- `nylingual` backtranslates portions of text.
+- `glothopper` introduces code-switching effects, blending languages or dialects.
+- `palimpsest` rewrites, but leaves accidental traces of the past.
+- `vesuvius` is an apocryphal `Glitchling` with ties to _[Nosy, aren't we? -The Curator]_
+
+## Apocrypha
+
+Cave paintings and oral tradition contain many depictions of strange, otherworldly `Glitchling`s.  
+These _Apocryphal `Glitchling`_ are said to possess unique abilities or behaviors.  
+If you encounter one of these elusive beings, please document your findings and share them with _The Curator_.
+
+### Reproducible Corruption
+
+Every `Glitchling` owns its own independent `random.Random` instance. That means:
+
+- No `random.seed(...)` calls touch Python's global RNG.
+- Supplying a `seed` when you construct a `Glitchling` (or when you `summon(...)`) makes its behavior reproducible.
+- Re-running a `Gaggle` with the same master seed and the same input text (_and same external data!_) yields identical corruption output.
+- Corruption functions are written to accept an `rng` parameter internally so that all randomness is centralized and testable.
+
+#### Caveats
+
+- If you mutate a glitchling's parameters after you've used it (e.g. `typogre.set_param(...)`) the outputs may not be the same as before the change. So don't do that.
+
+#### At Wits' End?
+
+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:
+
+1. Search for any direct calls to `random.choice`, `random.shuffle`, or `set(...)` ordering without going through the provided `rng`.
+2. Ensure you sort collections before shuffling or sampling.
+3. Make sure indices are chosen from a stable reference (e.g., original text) when applying length‑changing edits.
+4. Make sure there are enough sort keys to maintain stability.