Skip to main content

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

Metadata

Release files for pyfin-sentiment 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyfin-sentiment 0.1.1
File Size Uploaded
pyfin-sentiment-0.1.1.tar.gz 6.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyfin-sentiment 0.1.1
File Interpreter ABI Platform
pyfin_sentiment-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 12.3 kB

Release files / pyfin-sentiment-0.1.1.tar.gz

Download URL pyfin-sentiment-0.1.1.tar.gz
Size 6.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7bee4e003ebeaebaca36f2ed1b782d26a274cd52ccb5c3d7aadc3a449691e684
BLAKE2b-256 checksum
How to use checksums
5c9474e50156984cacafbb0b4c9179f83969c5591476e16a46a36a303266e651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / pyfin_sentiment-0.1.1-py3-none-any.whl

Download URL pyfin_sentiment-0.1.1-py3-none-any.whl
Size 6.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d9e7687b2cae00d614add5a67bc44195be32420bee1f516b79be90487ea11c9
BLAKE2b-256 checksum
How to use checksums
b6be05c3f6c4de46c0454088d9db8b6c1916fcb7ec56167d311bf4c0ab7efe85
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page