An augmentation library based on SpaCy for joint augmentation of text and labels.
Project description
Augmenty: The cherry on top of your NLP pipeline
Augmenty is an augmentation library based on spaCy for augmenting texts. Besides a wide array of highly flexible augmenters, Augmenty provides a series of tools for working with augmenters, including combining and moderating augmenters. Augmenty differs from other augmentation libraries in that it corrects (as far as possible) the assigned labels under the augmentation, thus making many of the augmenters valid for training in a wider range of tasks.
🔧 Installation
To get started using augmenty simply install it using pip by running the following line in your terminal:
pip install augmenty
Do note that this is a minimal installation. As some augmenters requires additional packages please write the following line to install all dependencies.
pip install "augmenty[all]"
For more detailed instructions on installing augmenty, including specific language support, see the installation instructions.
🍒 Simple Example
The following shows a simple example of how you can quickly augment text using Augmenty. For more on using augmenty see the usage guides.
import spacy
import augmenty
nlp = spacy.load("en_core_web_md")
# if not installed run: python -m spacy download en_core_web_md
docs = nlp.pipe(["Augmenty is a great tool for text augmentation"])
entity_augmenter = augmenty.load("ents_replace_v1",
ent_dict = {"ORG": [["spaCy"], ["spaCy", "Universe"]]}, level=1)
for doc in augmenty.docs(docs, augmenter=entity_augmenter, nlp=nlp):
print(doc)
spaCy Universe is a great tool for text augmentation.
📖 Documentation
| Documentation | |
|---|---|
| 📚 Usage Guides | Guides and instructions on how to use augmenty and its features. |
| 📰 News and changelog | New additions, changes and version history. |
| 🎛 API References | The detailed reference for augmenty's API. Including function documentation |
| 🍒 Augmenters | Contains a full list of current augmenters in augmenty. |
| 🙋 FAQ | Frequently asked question regarding augmenty |
💬 Where to ask questions
| Type | |
|---|---|
| 🚨 Bug Reports | GitHub Issue Tracker |
| 🎁 Feature Requests & Ideas | GitHub Issue Tracker |
| 👩💻 Usage Questions | GitHub Discussions |
| 🗯 General Discussion | GitHub Discussions |
| 🍒 Adding an Augmenter | Adding an augmenter |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
