FAQ

How do I cite this work?

If you use this library in your research, it would be much appreciated it if you would cite the package. For the most up to date ciation see the “cite this repository” on the github page for an up to date citation.

Does this package run on X?

This package is intended to run on all major OS, this includes Windows (latest version), MacOS (latest) and the latest version of Linux (Ubuntu). Similarly it also tested on python 3.8, and 3.9. Please note these are only the systems this package is being actively tested on, if you run on a similar system (e.g. an earlier version of Linux) this package will likely run there as well, if not please create an issue.

How is the documentation generated?

Augmenty uses sphinx to generate documentation. It uses the Furo theme with custom styling.

To make the documentation you can run:

# install sphinx, themes and extensions
pip install sphinx furo sphinx-copybutton sphinxext-opengraph

# generate html from documentations

make -C docs html

Many of these augmenters are completely useless for training?

That is true, some of the augmenters are rarely something you would augment with during training. For instance, randomly adding or removing spacing. However, augmentation can also be used to test whether a model is robust to certain variations.

Can I use augmenty without using spaCy?

Indeed augmenty contains convenience functions for applying augmentation directly to raw texts. Check out the getting started guide to learn how. However, augmenty still used spaCy in the background for this task.

How is the documentation generated?

SpaCy-wrap uses sphinx to generate documentation. It uses the Furo theme with custom styling.

To make the documentation you can run:

# install sphinx, themes and extensions
pip install -e ".[docs]"

# generate html from documentations

make -C docs html