Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,62 @@
+---
+language: fr
+tags:
+  - text-classification
+  - financial-sentiment-analysis
+  - sentiment-analysis
+datasets:
+  - datasets/financial_phrasebank
+metrics:
+  - f1
+  - accuracy
+  - precision
+  - recall
+widget:
+  - text: "Le chiffre d'affaires net a augmenté de 30 % pour atteindre 36 millions d'euros."
+    example_title: "Example 1"
+  - text: "Coup d'envoi du vendredi fou. Liste des promotions en magasin."
+    example_title: "Example 2"
+  - text: "Les actions de CDPROJEKT ont enregistré la plus forte baisse parmi les entreprises cotées au WSE."
+    example_title: "Example 3"
+---
+
+
+# Finance Sentiment FR (base)
+
+Finance Sentiment FR (base) is a model based on [camembert-base](https://huggingface.co/camembert-base) for analyzing sentiment of French financial news. It was trained on the translated version of [Financial PhraseBank](https://www.researchgate.net/publication/251231107_Good_Debt_or_Bad_Debt_Detecting_Semantic_Orientations_in_Economic_Texts) by Malo et al. (20014) for 10 epochs on single RTX3090 gpu. 
+
+The model will give you a three labels: positive, negative and neutral.
+
+## How to use
+
+You can use this model directly with a pipeline for sentiment-analysis:
+
+```python
+from transformers import pipeline
+
+nlp = pipeline("sentiment-analysis", model="bardsai/finance-sentiment-fr-base")
+nlp("Le chiffre d'affaires net a augmenté de 30 % pour atteindre 36 millions d'euros.")
+```
+```bash
+[{'label': 'positive', 'score': 0.9987998807375955}]
+```
+
+## Performance
+| Metric | Value |
+| --- | ----------- |
+| f1 macro | 0.963 |
+| precision macro | 0.959 |
+| recall macro | 0.967 |
+| accuracy | 0.971 |
+| samples per second | 140.8 |
+
+(The performance was evaluated on RTX 3090 gpu)
+
+## Changelog
+- 2023-09-18: Initial release
+
+## About bards.ai
+
+At bards.ai, we focus on providing machine learning expertise and skills to our partners, particularly in the areas of nlp, machine vision and time series analysis. Our team is located in Wroclaw, Poland. Please visit our website for more information: [bards.ai](https://bards.ai/)
+
+Let us know if you use our model :). Also, if you need any help, feel free to contact us at info@bards.ai