rnsrk/hedonodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated the README

Browse source
This commit is contained in:
rnsrk 2023-03-17 21:26:14 +01:00
parent 8d9a7fa603
commit cafda77e7f
1 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,4 +1,19 @@
# Hedonodon
I'm using [vaderSentiment](https://pypi.org/project/vaderSentiment/) to calculate the compounds.
## Prerequisites
Install the dependencies with `python -m pip install -r requirements.txt`.
Install SpaCys nlp model with `python -m spacy download en_core_web_lg`.
If the automatic download of the twitter-roberta-base-sentiment model and tokenizer fail, go to the model pages on hugging face (see models section) and download the to the respective folder (cardiffnlp/twitter-roberta-base-sentiment)
More Documentation coming soon!
## Purpose
Hedonodon fetched toots from fedihum.org and calculates the sentiments, sentiment mean and word frequencies of each day, and creates fancy diagrams from the data.
## Motivation
This tool was created to understand how sentiment analyses and nlp methods works, so it may lacks of proper use of models etc...
## Models
It uses "germansentiment"](https://huggingface.co/oliverguhr/german-sentiment-bert) for german toots, []"twitter-roberta-base-sentiment"](https://huggingface.co/cardiffnlp/twitter-roberta-base-sentiment) for
english toots, and ["vaderSentiment"](https://pypi.org/project/vaderSentiment/) for other languages.
For the word counts I translate the toots to english with the GoogleTranslator from [deep_translater](https://pypi.org/project/deep-translator/) first and then use SpaCys nlp model ["en_core_web_lg"](https://spacy.io/models/en/) to calculate the word frequencies.
## Weaknesses
Since some moduls do not return sentiment compounds I have to use the nominal sentiment values (positive, neutral, negative) to calculate the mean of the day, which is statisticaly not okay (;-_-).