Skip to main content

VADER sentiment classifier updated with financial lexicons

Project description

FinVADER

VADER sentiment classifier updated with financial lexicons

VADER (Valence Aware Dictionary and sEntiment Reasoner) is a mainstream model for sentiment analysis using a general-language human-curated lexicon, including linguistic features expressed on social media. As such, the model works worse on texts that use domain-specific language, such as finance or economics.

FinVADER improves VADER's classification accuracy, including two finance lexicons: SentiBignomics, and Henry's word list. SentiBigNomics is a detailed financial lexicon for aspect-based sentiment analysis with approximately 7300 terms containing a polarity score ranging in [-1,1] for each item. Henry's lexicon covers 189 words appearing in the company earnings press releases.

FinVADER outperforms VADER on Financial PhraseBank data:

finvader_accuracy vader_accuracy

The code for this benchmark test is here


Installation

FinVADER requires Python 3.8 - 3.11, and NLTK.

To install using pip, use:

pip install finvader

Usage

  • Import the library:
from finvader import finvader
  • Select lexicons:
def finvader(text = 'str',                    # Text
             indicator = 'str',               # VADER' indicator: 'pos'/'neg'/'neu'/'compound' 
             use_sentibignomics: bool= False, # Use SentiBignomics lexicon
             use_henry: bool= False):         # Use Henry's lexicon
) 
  • Use the classifier:
text = "The period's sales dropped to EUR 30.6 m from EUR 38.3 m, according to the interim report, released today."

scores = finvader(text, 
                  use_sentibignomics = True, 
                  use_henry = True, 
                  indicator = 'compound' )

Documentation, examples and tutorials

For examples of coding, read these tutorials:

FinVADER: Sentiment Analysis for Financial Applications here

Fine-tuning VADER Classifier with Domain-specific Lexicons here


Please visit here for any questions, issues, bugs, and suggestions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finvader-1.0.2.tar.gz (45.3 kB view details)

Uploaded Source

Built Distribution

finvader-1.0.2-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

Details for the file finvader-1.0.2.tar.gz.

File metadata

  • Download URL: finvader-1.0.2.tar.gz
  • Upload date:
  • Size: 45.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for finvader-1.0.2.tar.gz
Algorithm Hash digest
SHA256 74d6c241ea92a6b545a952f2c154044897671ba413340dbb06c75b46ecf8adf1
MD5 b7562748668a3ec853eb454aa0941781
BLAKE2b-256 1dd0e9c839210a6e8db1b0ec34d01116b1382f809228849a0b294eba260d4d89

See more details on using hashes here.

File details

Details for the file finvader-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: finvader-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 44.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for finvader-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1a3fc7d3ea23f1bc56968c1c25a10b854dbbbbf52c091c1d5ea5f02a131c98ad
MD5 848617b27fa41c6c77c3778f227a99c2
BLAKE2b-256 944f7f5c7e0e7d8e55410e8a560898803940ee4ac55745f82df3f240d57cacee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page