Augmenty

Augmenty: A Python Library for Structured Text Augmentation - Published in JOSS (2024)

https://github.com/kennethenevoldsen/augmenty

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

augmentation natural-language-processing nlp nlproc python spacy spacy-extension spacy-nlp text-augmentation text-classification training-data

Keywords from Contributors

dependency-distance descriptive-statistics readability readability-scores syntactic-analysis gravitational-lenses energy-systems hydrology meshes exoplanets

Last synced: 4 months ago · JSON representation ·

Repository

Augmenty is an augmentation library based on spaCy for augmenting texts.

Basic Info

Host: GitHub
Owner: KennethEnevoldsen
License: mit
Language: Python
Default Branch: main
Homepage: https://kennethenevoldsen.github.io/augmenty/
Size: 6.12 MB

Statistics

Stars: 156
Watchers: 3
Forks: 10
Open Issues: 1
Releases: 17

Topics

augmentation natural-language-processing nlp nlproc python spacy spacy-extension spacy-nlp text-augmentation text-classification training-data

Created over 4 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

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.

```python import augmenty import spacy

nlp = spacy.load("encoreweb_md")

if not installed run: python -m spacy download encoreweb_md

doc = nlp("Augmenty is a great tool for text augmentation")

check that the pipeline detects the entities (this done by SpaCy and is not a 100%)

print(doc.ents)

(Augmenty,) is detected as an entity

doc.ents[0].label_

'GPE'. Depending on the model, the label might be different (e.g. 'ORG')

entityaugmenter = augmenty.load( "entsreplacev1", entdict={"GPE": [["spaCy"], ["spaCy", "Universe"]]}, # label=GPE, level=1 )

for augmenteddoc in augmenty.docs([doc], augmenter=entityaugmenter, nlp=nlp): print(augmented_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 | | 🤝 How to contribute | How to contribute to 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 |

Owner

Name: Kenneth Enevoldsen
Login: KennethEnevoldsen
Kind: user
Location: Aarhus
Company: Center for Humanities Computing Aarhus

Website: kennethEnevoldsen.com
Twitter: KCEnevoldsen
Repositories: 9
Profile: https://github.com/KennethEnevoldsen

Interdisciplinary PhD Student on representation learning in Clinical NLP and Genetics at Aarhus University and Interacting Minds Centre

JOSS Publication

Augmenty: A Python Library for Structured Text Augmentation

Published

April 27, 2024

DOI

10.21105/joss.06370

Volume 9, Issue 96, Page 6370

Authors

Kenneth Enevoldsen

Center for Humanities Computing, Aarhus University, Aarhus, Denmark

Editor

Arfon Smith

Citation (citation.cff)

cff-version: "1.2.0"
authors:
- family-names: Enevoldsen
  given-names: Kenneth
  orcid: "https://orcid.org/0000-0001-8733-0966"
doi: 10.5281/zenodo.11002422
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Enevoldsen
    given-names: Kenneth
    orcid: "https://orcid.org/0000-0001-8733-0966"
  date-published: 2024-04-27
  doi: 10.21105/joss.06370
  issn: 2475-9066
  issue: 96
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6370
  title: "Augmenty: A Python Library for Structured Text Augmentation"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06370"
  volume: 9
title: "Augmenty: A Python Library for Structured Text Augmentation"

GitHub Events

Total

Watch event: 4

Last Year

Watch event: 4

Committers

Last synced: 5 months ago

All Time

Total Commits: 472
Total Committers: 10
Avg Commits per committer: 47.2
Development Distribution Score (DDS): 0.508

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
KennethEnevoldsen	k**n@g**m	232
Kenneth Enevoldsen	k**n@g**m	128
pre-commit-ci[bot]	6****]	54
dependabot[bot]	4****]	39
github-actions	g**s@g**m	11
Elliot Ford	e**d@a**m	3
github-actions	a**n@g**m	2
vincent d warmerdam	v**m@g**m	1
Peter Berkecz	b**r@g**m	1
Arfon Smith	a****n	1

Committer Domains (Top 20 + Academic)

github.com: 2 astrazeneca.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 16
Total pull requests: 134
Average time to close issues: over 1 year
Average time to close pull requests: 1 day
Total issue authors: 7
Total pull request authors: 7
Average comments per issue: 1.75
Average comments per pull request: 0.73
Merged pull requests: 92
Bot issues: 0
Bot pull requests: 111

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

KennethEnevoldsen (9)
martincjespersen (2)
juliamakogon (1)
stefkr1 (1)
HLasse (1)
jkgenser (1)
SrijithSrinath (1)

Pull Request Authors

dependabot[bot] (58)
pre-commit-ci[bot] (46)
KennethEnevoldsen (20)
arfon (2)
EFord36 (2)
qeterme (1)
martincjespersen (1)

Top Labels

Issue Labels

enhancement (9) additional augmenter (6) bug (2) documentation (1) help wanted (1) no-stale (1)

Pull Request Labels

dependencies (58) github_actions (15) python (11)

Packages

Total packages: 1
Total downloads:
- pypi 5,074 last-month

Total dependent packages: 4
Total dependent repositories: 1
Total versions: 33
Total maintainers: 1

pypi.org: augmenty

An augmentation library based on SpaCy for joint augmentation of text and labels.

Homepage: https://github.com/KennethEnevoldsen/augmenty
Documentation: https://kennethenevoldsen.github.io/augmenty/
License: MIT License Copyright © 2021 Kenneth Enevoldsen 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.
Latest release: 1.4.4
published almost 2 years ago

Versions: 33
Dependent Packages: 4
Dependent Repositories: 1
Downloads: 5,074 Last month

Rankings

Dependent packages count: 2.4%

Stargazers count: 6.0%

Downloads: 6.6%

Average: 9.5%

Forks count: 10.9%

Dependent repos count: 21.5%

Maintainers (1)

KennethEnevoldsen

Last synced: 4 months ago

Dependencies

demo/requirements.txt pypi

st-annotated-text >=3.0.0,<3.1.0
streamlit >=1.11.0,<1.12.0

docs/requirements.txt pypi

furo *
myst-parser *
sphinx *
sphinx-copybutton *
sphinxext-opengraph *

docs/tutorials/requirements.txt pypi

faker ==13.13.0

requirements.txt pypi

MarkupSafe ==2.0.1
black *
catalogue >=2.0.4,<2.1.0
dacy >=1.1.1,<2.1.0
flake8 *
furo *
myst-parser *
nbsphinx >=0.8.8
nltk >=3.6.7,<3.8.0
numpy >=1.15.0,<2.0.0
pre-commit *
pydantic >=1.8.2,<1.10.0
pytest *
pytest-cov *
pytest-lazy-fixture *
pytest-timeout >=2.1.0,<2.2.0
spacy >=3.2.0,<3.5.0
sphinx >=4.5.0
sphinx-copybutton *
sphinxext-opengraph *
thinc >=8.0.8,<8.2.0

Augmenty

Science Score: 98.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

readme.md

Augmenty: The cherry on top of your NLP pipeline

🔧 Installation

🍒 Simple Example

if not installed run: python -m spacy download encoreweb_md

check that the pipeline detects the entities (this done by SpaCy and is not a 100%)

(Augmenty,) is detected as an entity

'GPE'. Depending on the model, the label might be different (e.g. 'ORG')

📖 Documentation

💬 Where to ask questions

Owner

JOSS Publication

Augmenty: A Python Library for Structured Text Augmentation

Authors

Editor

Tags

Citation (citation.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: augmenty

Rankings

Maintainers (1)

Dependencies