Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SamEdwardes/spacytextblob
A TextBlob sentiment analysis pipeline component for spaCy.
https://github.com/SamEdwardes/spacytextblob
natural-language-processing nlp python spacy
Last synced: 3 months ago
JSON representation
A TextBlob sentiment analysis pipeline component for spaCy.
- Host: GitHub
- URL: https://github.com/SamEdwardes/spacytextblob
- Owner: SamEdwardes
- License: mit
- Created: 2020-11-11T07:00:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-15T12:55:26.000Z (over 2 years ago)
- Last Synced: 2024-07-28T01:47:30.781Z (4 months ago)
- Topics: natural-language-processing, nlp, python, spacy
- Language: Python
- Homepage: https://spacytextblob.netlify.app/
- Size: 689 KB
- Stars: 54
- Watchers: 3
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# spacytextblob
[](https://badge.fury.io/py/spacytextblob)
[](https://github.com/SamEdwardes/spacytextblob/actions/workflows/pytest.yml)
[](https://app.netlify.com/sites/spacytextblob/deploys)
A TextBlob sentiment analysis pipeline component for spaCy.
- [Docs](https://spacytextblob.netlify.app/)
- [GitHub](https://github.com/SamEdwardes/spacytextblob)
- [PyPi](https://pypi.org/project/spacytextblob/)
- [spaCy Universe](https://spacy.io/universe/project/spacy-textblob)
## Install
Install *spacytextblob* from PyPi.
```bash
pip install spacytextblob
```
TextBlob requires additional data to be downloaded before getting started.
```bash
python -m textblob.download_corpora
```
spaCy also requires that you download a model to get started.
```bash
python -m spacy download en_core_web_sm
```
## Quick Start
*spacytextblob* allows you to access all of the attributes created of the `textblob.TextBlob` class but within the spaCy framework. The code below will demonstrate how to use *spacytextblob* on a simple string.
```python
import spacy
from spacytextblob.spacytextblob import SpacyTextBlob
nlp = spacy.load('en_core_web_sm')
text = "I had a really horrible day. It was the worst day ever! But every now and then I have a really good day that makes me happy."
nlp.add_pipe("spacytextblob")
doc = nlp(text)
print(doc._.blob.polarity)
# -0.125
print(doc._.blob.subjectivity)
# 0.9
print(doc._.blob.sentiment_assessments.assessments)
# [(['really', 'horrible'], -1.0, 1.0, None), (['worst', '!'], -1.0, 1.0, None), (['really', 'good'], 0.7, 0.6000000000000001, None), (['happy'], 0.8, 1.0, None)]
```
In comparison, here is how the same code would look using `TextBlob`:
```python
from textblob import TextBlob
text = "I had a really horrible day. It was the worst day ever! But every now and then I have a really good day that makes me happy."
blob = TextBlob(text)
print(blob.sentiment_assessments.polarity)
# -0.125
print(blob.sentiment_assessments.subjectivity)
# 0.9
print(blob.sentiment_assessments.assessments)
# [(['really', 'horrible'], -1.0, 1.0, None), (['worst', '!'], -1.0, 1.0, None), (['really', 'good'], 0.7, 0.6000000000000001, None), (['happy'], 0.8, 1.0, None)]
```
## Quick Reference
*spacytextblob* performs sentiment analysis using the [TextBlob](https://textblob.readthedocs.io/en/dev/quickstart.html) library. Adding *spacytextblob* to a spaCy nlp pipeline creates a new extension attribute for the `Doc`, `Span`, and `Token` classes from spaCy.
- `Doc._.blob`
- `Span._.blob`
- `Token._.blob`
The `._.blob` attribute contains all of the methods and attributes that belong to the `textblob.TextBlob` class Some of the common methods and attributes include:
- **`._.blob.polarity`**: a float within the range [-1.0, 1.0].
- **`._.blob.subjectivity`**: a float within the range [0.0, 1.0] where 0.0 is very objective and 1.0 is very subjective.
- **`._.blob.sentiment_assessments.assessments`**: a list of polarity and subjectivity scores for the assessed tokens.
See the [textblob docs](https://textblob.readthedocs.io/en/dev/api_reference.html#textblob.blob.TextBlob) for the complete listing of all attributes and methods that are available in `._.blob`.
## Reference and Attribution
- TextBlob
- [https://github.com/sloria/TextBlob](https://github.com/sloria/TextBlob)
- [https://textblob.readthedocs.io/en/latest/](https://textblob.readthedocs.io/en/latest/)
- negspaCy (for inspiration in writing pipeline and organizing repo)
- [https://github.com/jenojp/negspacy](https://github.com/jenojp/negspacy)
- spaCy custom components
- [https://spacy.io/usage/processing-pipelines#custom-components](https://spacy.io/usage/processing-pipelines#custom-components)