# spacy-annotator
SpaCy annotator for Named Entity Recognition (NER) using ipywidgets.
The annotator allows users to quickly assign (custom) labels to one or more entities in the text, including noisy-prelabelling!
**Features**:
* The annotator supports pandas dataframe: it adds annotations in a separate 'annotation' column of the dataframe;
* Why not use transformers to label your data for you?
If a model is passed into the annotator, it is used to identify entities and pre-fill the annotator for you.
* The annotations adhere to spaCy format and are ready to serve as input to a spaCy NER model.
No additional code required!
Blog post: [medium/enrico.alemani/spacy-annotator](https://medium.com/@enrico.alemani/how-to-create-training-data-for-spacy-ner-models-using-ipywidgets-c4aa71bf61a2)
## Installation
```
pip install spacy-annotator
```
## Example: annotations using spaCy model
https://user-images.githubusercontent.com/31287731/119233291-4079be00-bb20-11eb-8a8d-7ad1436c662b.mov
For code, see [spacy_annotator demo](demo/spacy_annotator_demo.ipynb) notebook.
## Contributors
[dayalstrub-cma](https://github.com/dayalstrub-cma) - Refactored code to class, added displacy visualisation and entity ruler.
[LeafmanZ](https://github.com/LeafmanZ) - Added `to_spacy` method.
## Contributing
1. Fork the repo on GitHub;
2. Clone the project to your own machine;
3. Commit changes to your own branch; and
4. Push your work back up to your own fork;
5. Submit a Pull request so that I can review your changes.
## Dependencies
Spacy-annotator works with SpaCy 3.X, and ipywidgets 7.X.
## References
spacy-annotator is based on [spaCy](https://spacy.io/) and [pigeon](https://github.com/agermanidis/pigeon) (see also [PigeonXT](https://github.com/dennisbakhuis/pigeonXT)).
Many thanks to them for making their awesome libraries publicly available. Another interesting project is [Doccano](https://github.com/doccano/doccano).
**Note**:
spaCy is a great library and, most importantly, free to use. So please also consider using the https://prodi.gy/ annotator to keep supporting the spaCy deveopment.
## Changelog
2024-03-25: Update ipywidget requirements to >=8
Raw data
{
"_id": null,
"home_page": "https://github.com/ieriii/spacy-annotator",
"name": "spacy-annotator",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "spacy, NER, NLP",
"author": "Enrico Alemani",
"author_email": "enrico.alemani@hey.com",
"download_url": "https://files.pythonhosted.org/packages/29/c3/3a92c28d59792829129e7f5290f8703af044e0db9150385fdd4665d397db/spacy_annotator-2.1.4.tar.gz",
"platform": null,
"description": "# spacy-annotator\n\nSpaCy annotator for Named Entity Recognition (NER) using ipywidgets.\nThe annotator allows users to quickly assign (custom) labels to one or more entities in the text, including noisy-prelabelling! \n\n**Features**:\n\n* The annotator supports pandas dataframe: it adds annotations in a separate 'annotation' column of the dataframe;\n* Why not use transformers to label your data for you? \nIf a model is passed into the annotator, it is used to identify entities and pre-fill the annotator for you.\n* The annotations adhere to spaCy format and are ready to serve as input to a spaCy NER model. \nNo additional code required!\n\nBlog post: [medium/enrico.alemani/spacy-annotator](https://medium.com/@enrico.alemani/how-to-create-training-data-for-spacy-ner-models-using-ipywidgets-c4aa71bf61a2)\n\n## Installation\n```\npip install spacy-annotator\n```\n\n## Example: annotations using spaCy model \n\nhttps://user-images.githubusercontent.com/31287731/119233291-4079be00-bb20-11eb-8a8d-7ad1436c662b.mov\n\n\n\nFor code, see [spacy_annotator demo](demo/spacy_annotator_demo.ipynb) notebook.\n\n## Contributors\n[dayalstrub-cma](https://github.com/dayalstrub-cma) - Refactored code to class, added displacy visualisation and entity ruler. \n[LeafmanZ](https://github.com/LeafmanZ) - Added `to_spacy` method.\n\n## Contributing\n\n1. Fork the repo on GitHub;\n2. Clone the project to your own machine;\n3. Commit changes to your own branch; and\n4. Push your work back up to your own fork;\n5. Submit a Pull request so that I can review your changes.\n\n## Dependencies\n\nSpacy-annotator works with SpaCy 3.X, and ipywidgets 7.X.\n\n## References\n\nspacy-annotator is based on [spaCy](https://spacy.io/) and [pigeon](https://github.com/agermanidis/pigeon) (see also [PigeonXT](https://github.com/dennisbakhuis/pigeonXT)). \nMany thanks to them for making their awesome libraries publicly available. Another interesting project is [Doccano](https://github.com/doccano/doccano).\n\n**Note**:\nspaCy is a great library and, most importantly, free to use. So please also consider using the https://prodi.gy/ annotator to keep supporting the spaCy deveopment.\n\n## Changelog\n2024-03-25: Update ipywidget requirements to >=8\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SpaCy annotator for Named Entity Recognition (NER) using ipywidgets.",
"version": "2.1.4",
"project_urls": {
"Homepage": "https://github.com/ieriii/spacy-annotator"
},
"split_keywords": [
"spacy",
" ner",
" nlp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "29c33a92c28d59792829129e7f5290f8703af044e0db9150385fdd4665d397db",
"md5": "c11ea41259adc424562e14e90bdae207",
"sha256": "380a20d90af21d2a8918735ca45bdd643b18d7cbef6b735c6a8bb49803e42f54"
},
"downloads": -1,
"filename": "spacy_annotator-2.1.4.tar.gz",
"has_sig": false,
"md5_digest": "c11ea41259adc424562e14e90bdae207",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6027,
"upload_time": "2024-03-25T16:47:33",
"upload_time_iso_8601": "2024-03-25T16:47:33.197230Z",
"url": "https://files.pythonhosted.org/packages/29/c3/3a92c28d59792829129e7f5290f8703af044e0db9150385fdd4665d397db/spacy_annotator-2.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 16:47:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ieriii",
"github_project": "spacy-annotator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "spacy-annotator"
}
JSON
