Skip to content

Commit

Permalink
updated docs based on review
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethEnevoldsen committed Mar 19, 2024
1 parent 46220c4 commit dac8fc7
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,3 @@
"sidebar_hide_name": True,
"navigation_with_keys": True,
}

1 change: 0 additions & 1 deletion paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 3 additions & 1 deletion tests/test_all_augmenters.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down

0 comments on commit dac8fc7

Please sign in to comment.