Create README.md

README.md

@@ -0,0 +1,29 @@
+---
+language: en
+widget:
+- text: Operating profit rose to EUR 13.1 mn from EUR 8.7 mn in the corresponding period in 2007 representing 7.7 % of net sales.
+- text: Bids or offers include at least 1,000 shares and the value of the shares must correspond to at least EUR 4,000.
+- text: Raute reported a loss per share of EUR 0.86 for the first half of 2009 , against EPS of EUR 0.74 in the corresponding period of 2008.
+---
+**FinancialBERT** is a BERT model pre-trained on a large corpora of financial texts. The purpose is to enhance financial NLP research and practice in financial domain, we hope financial practitioners and researchers can benefit from our model without the necessity of the significant computational resources required to train the model. 
+
+We fine-tuned our model on Sentiment Analysis task using FinancialPhraseBank dataset, experiments show that FinancialBERT outperforms the general BERT and other financial domain-specific models.
+ 
+ # How to use 
+Our model can be used thanks to Transformers pipeline for sentiment analysis.
+```python
+from transformers import BertTokenizer, BertForSequenceClassification
+from transformers import pipeline
+
+finbert = BertForSequenceClassification.from_pretrained("ahmedrachid/FinancialBERT-Sentiment-Analysis",num_labels=3)
+tokenizer = BertTokenizer.from_pretrained("ahmedrachid/FinancialBERT-Sentiment-Analysis")
+
+nlp = pipeline("sentiment-analysis", model=finbert, tokenizer=tokenizer)
+
+sentences = ["Operating profit rose to EUR 13.1 mn from EUR 8.7 mn in the corresponding period in 2007 representing 7.7 % of net sales.",  
+             "Bids or offers include at least 1,000 shares and the value of the shares must correspond to at least EUR 4,000.", 
+             "Raute reported a loss per share of EUR 0.86 for the first half of 2009 , against EPS of EUR 0.74 in the corresponding period of 2008.", 
+             ]
+results = nlp(sentences)
+print(results)
+```