| Name | augmenty JSON |
| Version |
1.4.4
JSON |
| download |
| home_page | |
| Summary | An augmentation library based on SpaCy for joint augmentation of text and labels. |
| upload_time | 2024-03-19 09:35:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| 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. |
| keywords |
nlp
nlp
spacy
text analysis
natural language processing
text mining
augmentation
data augmentation
data science
machine learning
deep learning
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<a href="https://github.com/kennethenevoldsen/augmenty"><img src="https://github.com/KennethEnevoldsen/augmenty/blob/main/img/icon.png?raw=true" width="200" align="right" /></a>
# Augmenty: The cherry on top of your NLP pipeline
[](https://pypi.org/project/augmenty/)
[](https://github.com/kennethenevoldsen/augmenty)
[]([ruff])
[](https://github.com/kennethenevoldsen/augmenty/actions)
[]([action])
[]([joss])
[action]: https://kennethenevoldsen.github.io/augmenty/
[ruff]: https://github.com/astral-sh/ruff
[joss]: https://joss.theoj.org/papers/df84463b79f27f40a4da97f20b08a958
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](https://kennethenevoldsen.github.io/augmenty/installation).
## 🍒 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 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 |
[usage guides]: https://kennethenevoldsen.github.io/augmenty/tutorials/introduction.html
[api references]: https://kennethenevoldsen.github.io/augmenty/
[Augmenters]: https://kennethenevoldsen.github.io/augmenty/augmenters_overview.html
[Demo]: https://share.streamlit.io/kennethenevoldsen/augmenty/dev/streamlit.py
[News and changelog]: https://kennethenevoldsen.github.io/augmenty/news.html
[FAQ]: https://kennethenevoldsen.github.io/augmenty/faq.html
## 💬 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] |
[github issue tracker]: https://github.com/kennethenevoldsen/augmenty/issues
[github discussions]: https://github.com/kennethenevoldsen/augmenty/discussions
[Adding an augmenter]: https://kennethenevoldsen.github.io/augmenty/adding_an_augmenter.html
Raw data
{
"_id": null,
"home_page": "",
"name": "augmenty",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nlp,NLP,spaCy,text analysis,natural language processing,text mining,augmentation,data augmentation,data science,machine learning,deep learning",
"author": "",
"author_email": "Kenneth Enevoldsen <kennethcenevoldsen@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/26/e4/4ff5f09a33d2599b7d92b9659cfaf151db90e28b4d5d9928d170f94208d2/augmenty-1.4.4.tar.gz",
"platform": null,
"description": "<a href=\"https://github.com/kennethenevoldsen/augmenty\"><img src=\"https://github.com/KennethEnevoldsen/augmenty/blob/main/img/icon.png?raw=true\" width=\"200\" align=\"right\" /></a>\n# Augmenty: The cherry on top of your NLP pipeline\n\n\n[](https://pypi.org/project/augmenty/)\n[](https://github.com/kennethenevoldsen/augmenty)\n[]([ruff])\n[](https://github.com/kennethenevoldsen/augmenty/actions)\n[]([action])\n[]([joss])\n\n[action]: https://kennethenevoldsen.github.io/augmenty/\n[ruff]: https://github.com/astral-sh/ruff\n[joss]: https://joss.theoj.org/papers/df84463b79f27f40a4da97f20b08a958\n\n\nAugmenty 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.\n\n## \ud83d\udd27 Installation\nTo get started using augmenty simply install it using pip by running the following line in your terminal:\n\n```\npip install augmenty\n```\n\nDo note that this is a minimal installation. As some augmenters requires additional packages please write the following line to install all dependencies.\n\n```\npip install \"augmenty[all]\"\n```\n\nFor more detailed instructions on installing augmenty, including specific language support, see the [installation instructions](https://kennethenevoldsen.github.io/augmenty/installation).\n\n## \ud83c\udf52 Simple Example\nThe following shows a simple example of how you can quickly augment text using Augmenty. For more on using augmenty see the [usage guides].\n\n```python\nimport spacy\nimport augmenty\n\nnlp = spacy.load(\"en_core_web_md\")\n# if not installed run: python -m spacy download en_core_web_md\n\ndocs = nlp.pipe([\"Augmenty is a great tool for text augmentation\"])\n\nentity_augmenter = augmenty.load(\"ents_replace_v1\", \n ent_dict = {\"ORG\": [[\"spaCy\"], [\"spaCy\", \"Universe\"]]}, level=1)\n\nfor doc in augmenty.docs(docs, augmenter=entity_augmenter, nlp=nlp):\n print(doc)\n```\n\n```\nspaCy Universe is a great tool for text augmentation.\n```\n\n## \ud83d\udcd6 Documentation\n\n| Documentation | |\n| -------------------------- | --------------------------------------------------------------------------- |\n| \ud83d\udcda **[Usage Guides]** | Guides and instructions on how to use augmenty and its features. |\n| \ud83d\udcf0 **[News and changelog]** | New additions, changes and version history. |\n| \ud83c\udf9b **[API References]** | The detailed reference for augmenty's API. Including function documentation |\n| \ud83c\udf52 **[Augmenters]** | Contains a full list of current augmenters in augmenty. |\n| \ud83d\ude4b **[FAQ]** | Frequently asked question regarding augmenty |\n\n[usage guides]: https://kennethenevoldsen.github.io/augmenty/tutorials/introduction.html\n[api references]: https://kennethenevoldsen.github.io/augmenty/\n[Augmenters]: https://kennethenevoldsen.github.io/augmenty/augmenters_overview.html\n[Demo]: https://share.streamlit.io/kennethenevoldsen/augmenty/dev/streamlit.py\n[News and changelog]: https://kennethenevoldsen.github.io/augmenty/news.html\n[FAQ]: https://kennethenevoldsen.github.io/augmenty/faq.html\n\n## \ud83d\udcac Where to ask questions\n\n| Type | |\n| ------------------------------ | ---------------------- |\n| \ud83d\udea8 **Bug Reports** | [GitHub Issue Tracker] |\n| \ud83c\udf81 **Feature Requests & Ideas** | [GitHub Issue Tracker] |\n| \ud83d\udc69\u200d\ud83d\udcbb **Usage Questions** | [GitHub Discussions] |\n| \ud83d\uddef **General Discussion** | [GitHub Discussions] |\n| \ud83c\udf52 **Adding an Augmenter** | [Adding an augmenter] |\n\n[github issue tracker]: https://github.com/kennethenevoldsen/augmenty/issues\n[github discussions]: https://github.com/kennethenevoldsen/augmenty/discussions\n[Adding an augmenter]: https://kennethenevoldsen.github.io/augmenty/adding_an_augmenter.html\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright \u00a9 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. ",
"summary": "An augmentation library based on SpaCy for joint augmentation of text and labels.",
"version": "1.4.4",
"project_urls": {
"Documentation": "https://kennethenevoldsen.github.io/augmenty/",
"Homepage": "https://github.com/KennethEnevoldsen/augmenty",
"Repository": "https://github.com/KennethEnevoldsen/augmenty"
},
"split_keywords": [
"nlp",
"nlp",
"spacy",
"text analysis",
"natural language processing",
"text mining",
"augmentation",
"data augmentation",
"data science",
"machine learning",
"deep learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c15ce9be2366124be99cc7952d6eff31db343ea63a84f69b00ddef39510dd7a",
"md5": "1f9245becaa00d13a9a692fba4f1a494",
"sha256": "231725b3609b341c5f057ca2c964f4c4b1b9265b49cdf1317e47b44a043aec18"
},
"downloads": -1,
"filename": "augmenty-1.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f9245becaa00d13a9a692fba4f1a494",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 47099,
"upload_time": "2024-03-19T09:35:30",
"upload_time_iso_8601": "2024-03-19T09:35:30.988794Z",
"url": "https://files.pythonhosted.org/packages/2c/15/ce9be2366124be99cc7952d6eff31db343ea63a84f69b00ddef39510dd7a/augmenty-1.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26e44ff5f09a33d2599b7d92b9659cfaf151db90e28b4d5d9928d170f94208d2",
"md5": "c7c8ff88db0d2f0f74b02a750d4cac64",
"sha256": "f493d586db2ed347a02afaaa27a236ca3e29416e8be98fcc33ad3c263de558ad"
},
"downloads": -1,
"filename": "augmenty-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "c7c8ff88db0d2f0f74b02a750d4cac64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1294397,
"upload_time": "2024-03-19T09:35:33",
"upload_time_iso_8601": "2024-03-19T09:35:33.114837Z",
"url": "https://files.pythonhosted.org/packages/26/e4/4ff5f09a33d2599b7d92b9659cfaf151db90e28b4d5d9928d170f94208d2/augmenty-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 09:35:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KennethEnevoldsen",
"github_project": "augmenty",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "augmenty"
}
