diff --git a/docs/conf.py b/docs/conf.py index a2ab557..1dbd4cf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -112,4 +112,3 @@ "sidebar_hide_name": True, "navigation_with_keys": True, } - diff --git a/paper/paper.md b/paper/paper.md index 668f110..c4d8f08 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -37,7 +37,6 @@ Other tools for data augmentation focus on specific downstream application such # Features & Functionality - `Augmenty` is a Python library that implements augmentations based on `spaCy`'s `Doc` object. `spaCy`'s `Doc` object is a container for a text and its annotations. This makes it easy to augment text and annotations simultaneously. The `Doc` object can easily be extended to include custom augmentation not available in `spaCy` by adding custom attributes to the `Doc` object. While `Augmenty` is built to augment `Doc`s the object is easily converted into strings, lists or other formats. The annotations within a `Doc` can be provided either by human annotations or using a trained model. Augmenty implements a series of augmenters for token-, span- and sentence-level augmentation. These augmenters range from primitive augmentations such as word replacement to language specific augmenters such as keystroke error augmentations based on a French keyboard layout. Augmenty also integrates with other libraries such as `NLTK` [@bird2009natural] to allow for augmentations based on WordNet [@miller-1994-wordnet] and allows for specification of static word vectors [pennington-etal-2014-glove] to allow for augmentations based on word similarity. Lastly, `augmenty` provides a set of utility functions for repeating augmentations, combining augmenters or adjust the percentage of documents that should be augmented. This allow for the flexible construction of augmentation pipelines specific to the task at hand. diff --git a/readme.md b/readme.md index 711956e..e0fe2b2 100644 --- a/readme.md +++ b/readme.md @@ -26,7 +26,7 @@ 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] +pip install "augmenty[all]" ``` For more detailed instructions on installing augmenty, including specific language support, see the [installation instructions](https://kennethenevoldsen.github.io/augmenty/installation). diff --git a/tests/test_all_augmenters.py b/tests/test_all_augmenters.py index 0c92050..1e0b303 100644 --- a/tests/test_all_augmenters.py +++ b/tests/test_all_augmenters.py @@ -80,7 +80,9 @@ def is_pronoun(token: Token) -> bool: } -@pytest.mark.parametrize("aug,args", [(k, augmenters_args[k]) for k in augmenters_args]) # noqa +@pytest.mark.parametrize( + "aug,args", [(k, augmenters_args[k]) for k in augmenters_args] +) # noqa @pytest.mark.parametrize("level", [0.1, 0.5, 1]) @pytest.mark.timeout(100) @pytest.mark.parametrize(