Text Classification
Transformers
PyTorch
TensorFlow
JAX
Safetensors
English
bert
financial-sentiment-analysis
sentiment-analysis
finance
Instructions to use ProsusAI/finbert with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use ProsusAI/finbert with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-classification", model="ProsusAI/finbert")# pip install -U transformers accelerate # Load model directly from transformers import AutoTokenizer, AutoModelForSequenceClassification tokenizer = AutoTokenizer.from_pretrained("ProsusAI/finbert") model = AutoModelForSequenceClassification.from_pretrained("ProsusAI/finbert", device_map="auto") - Inference
- Notebooks
- Google Colab
- Kaggle
Add license terms and usage disclaimers
Browse files
README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
| 1 |
---
|
| 2 |
language: "en"
|
|
|
|
| 3 |
tags:
|
| 4 |
- financial-sentiment-analysis
|
| 5 |
- sentiment-analysis
|
|
@@ -7,6 +8,59 @@ widget:
|
|
| 7 |
- text: "Stocks rallied and the British pound gained."
|
| 8 |
---
|
| 9 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
FinBERT is a pre-trained NLP model to analyze sentiment of financial text. It is built by further training the BERT language model in the finance domain, using a large financial corpus and thereby fine-tuning it for financial sentiment classification. [Financial PhraseBank](https://www.researchgate.net/publication/251231107_Good_Debt_or_Bad_Debt_Detecting_Semantic_Orientations_in_Economic_Texts) by Malo et al. (2014) is used for fine-tuning. For more details, please see the paper [FinBERT: Financial Sentiment Analysis with Pre-trained Language Models](https://arxiv.org/abs/1908.10063) and our related [blog post](https://medium.com/prosus-ai-tech-blog/finbert-financial-sentiment-analysis-with-bert-b277a3607101) on Medium.
|
| 11 |
|
| 12 |
The model will give softmax outputs for three labels: positive, negative or neutral.
|
|
@@ -17,6 +71,11 @@ About Prosus
|
|
| 17 |
|
| 18 |
Prosus is a global consumer internet group and one of the largest technology investors in the world. Operating and investing globally in markets with long-term growth potential, Prosus builds leading consumer internet companies that empower people and enrich communities. For more information, please visit www.prosus.com.
|
| 19 |
|
| 20 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
|
| 22 |
-
|
|
|
|
|
|
| 1 |
---
|
| 2 |
language: "en"
|
| 3 |
+
license: cc-by-nc-sa-4.0
|
| 4 |
tags:
|
| 5 |
- financial-sentiment-analysis
|
| 6 |
- sentiment-analysis
|
|
|
|
| 8 |
- text: "Stocks rallied and the British pound gained."
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# FinBERT
|
| 12 |
+
|
| 13 |
+
## 📜 License and Usage Terms
|
| 14 |
+
|
| 15 |
+
### Model Weights License
|
| 16 |
+
The FinBERT model weights are made available under **CC BY-NC-SA 4.0**
|
| 17 |
+
(Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International).
|
| 18 |
+
|
| 19 |
+
**This license restricts commercial use.** You may use this model for
|
| 20 |
+
non-commercial purposes only, and any adaptations must be shared under
|
| 21 |
+
the same license.
|
| 22 |
+
|
| 23 |
+
### Training Data Attribution
|
| 24 |
+
This model was trained using the **Financial PhraseBank** dataset:
|
| 25 |
+
|
| 26 |
+
> Malo, P., Sinha, A., Korhonen, P., Wallenius, J., & Takala, P.
|
| 27 |
+
> (2014). Good debt or bad debt: Detecting semantic orientations in
|
| 28 |
+
> economic texts. *Journal of the Association for Information Science
|
| 29 |
+
> and Technology*, 65(4), 782-796.
|
| 30 |
+
|
| 31 |
+
The Financial PhraseBank dataset is licensed under **CC BY-NC-SA 3.0**.
|
| 32 |
+
|
| 33 |
+
The underlying language model was further pre-trained on a subset of the
|
| 34 |
+
Reuters TRC2 corpus, which is distributed by NIST under its own access terms.
|
| 35 |
+
|
| 36 |
+
## ⚠️ User Responsibilities
|
| 37 |
+
|
| 38 |
+
**You are solely responsible for**:
|
| 39 |
+
- Ensuring your use complies with the CC BY-NC-SA 4.0 license
|
| 40 |
+
- Obtaining any necessary rights clearances for your specific use case
|
| 41 |
+
- Determining whether your intended use qualifies as "non-commercial"
|
| 42 |
+
- Compliance with any applicable laws and regulations
|
| 43 |
+
|
| 44 |
+
**Prosus makes no representation** that any particular use is permitted
|
| 45 |
+
and does not grant rights in third-party training data.
|
| 46 |
+
|
| 47 |
+
## 🚫 Disclaimer
|
| 48 |
+
|
| 49 |
+
**NO WARRANTY**: This model is provided "AS IS" without warranty of any
|
| 50 |
+
kind, express or implied, including but not limited to warranties of
|
| 51 |
+
merchantability, fitness for a particular purpose, or non-infringement.
|
| 52 |
+
|
| 53 |
+
**NOT AN OFFICIAL PRODUCT**: This is not an official Prosus product.
|
| 54 |
+
It was created as part of a research project.
|
| 55 |
+
|
| 56 |
+
**NO SUPPORT**: Prosus does not provide support, maintenance, or updates
|
| 57 |
+
for this model.
|
| 58 |
+
|
| 59 |
+
**LIABILITY**: In no event shall MIH AI B.V. or Prosus be liable for any
|
| 60 |
+
claim, damages, or other liability arising from the use of this model.
|
| 61 |
+
|
| 62 |
+
## Model Description
|
| 63 |
+
|
| 64 |
FinBERT is a pre-trained NLP model to analyze sentiment of financial text. It is built by further training the BERT language model in the finance domain, using a large financial corpus and thereby fine-tuning it for financial sentiment classification. [Financial PhraseBank](https://www.researchgate.net/publication/251231107_Good_Debt_or_Bad_Debt_Detecting_Semantic_Orientations_in_Economic_Texts) by Malo et al. (2014) is used for fine-tuning. For more details, please see the paper [FinBERT: Financial Sentiment Analysis with Pre-trained Language Models](https://arxiv.org/abs/1908.10063) and our related [blog post](https://medium.com/prosus-ai-tech-blog/finbert-financial-sentiment-analysis-with-bert-b277a3607101) on Medium.
|
| 65 |
|
| 66 |
The model will give softmax outputs for three labels: positive, negative or neutral.
|
|
|
|
| 71 |
|
| 72 |
Prosus is a global consumer internet group and one of the largest technology investors in the world. Operating and investing globally in markets with long-term growth potential, Prosus builds leading consumer internet companies that empower people and enrich communities. For more information, please visit www.prosus.com.
|
| 73 |
|
| 74 |
+
## 📧 Contact
|
| 75 |
+
|
| 76 |
+
For questions about this research project:
|
| 77 |
+
- Dogu Araci: dogu.araci[at]prosus.com
|
| 78 |
+
- Zulkuf Genc: zulkuf.genc[at]prosus.com
|
| 79 |
|
| 80 |
+
**Note**: Questions about commercial licensing or legal permissions
|
| 81 |
+
cannot be addressed by the research team. See the License section above.
|