Skip to main content

A library for market sentiment analysis of financial social media posts

Project description

pyFin-Sentiment

Documentation Status CI (tests) Code style: black License: MIT

A library for sentiment analysis of financial social media posts

Sentiment Analysis of Financial Social Media Posts

This library can help you extract market sentiment from short social media posts. Trained on data from Twitter, it can classify sentimetn into three classes: Bullish, Bearish, Neutral/No Sentiment. Note that we need to differentiate between market sentiment and general sentiment. Consider this example:

💬 Nice, already made loads of money this morning and now im shorting $AAPL, let's goooo!

While the general sentiment in the text is positve, the market sentiment is negative as the author is shorting a stock. Therefore, ...

  • If you are looking for a generic sentiment model that works well on social media content, take a look at VADER or TwitterRoBERTa
  • If you are looking for a sentiment analysis models that excels on new headlines sentiment analysis, check out FinBERT
  • Otherwise, stay here 🙃

Installation

It's as easy as...

pip install pyfin-sentiment

Documentation

📚 The documentation lives on pyfin-sentiment.readthedocs.io

Example

from pyfin_sentiment.model import SentimentModel

# the model only needs to be downloaded once
SentimentModel.download("small")

model = SentimentModel("small")
model.predict(["Long $TSLA!!", "Selling my $AAPL position"])
# array(['1', '3'], dtype=object)

We use the following conventions for mapping sentiment classes:

Class Name Meaning
1 Positive, Bullish
2 Neutral, Uncertain
3 Negative, Bearish

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

pyfin-sentiment-0.1.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyfin_sentiment-0.1.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file pyfin-sentiment-0.1.1.tar.gz.

File metadata

  • Download URL: pyfin-sentiment-0.1.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pyfin-sentiment-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7bee4e003ebeaebaca36f2ed1b782d26a274cd52ccb5c3d7aadc3a449691e684
MD5 124280d7ef6f18b4f8b413ce34984607
BLAKE2b-256 5c9474e50156984cacafbb0b4c9179f83969c5591476e16a46a36a303266e651

See more details on using hashes here.

File details

Details for the file pyfin_sentiment-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pyfin_sentiment-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d9e7687b2cae00d614add5a67bc44195be32420bee1f516b79be90487ea11c9
MD5 fd257deba08962e872b2e23fea340265
BLAKE2b-256 b6be05c3f6c4de46c0454088d9db8b6c1916fcb7ec56167d311bf4c0ab7efe85

See more details on using hashes here.

Supported by

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