Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,60 @@
+---
+language: pl
+tags:
+  - text-classification
+  - financial-sentiment-analysis
+  - sentiment-analysis
+datasets:
+  - datasets/financial_phrasebank
+metrics:
+  - f1
+  - accuracy
+  - precision
+  - recall
+widget:
+  - text: "17 polskich firm wśród 50 najszybciej rozwijających się przedsiębiorstw technologicznych regionu."
+    example_title: "Example 1"
+  - text: "Rusza Black Friday. Lista promocji w sklepach."
+    example_title: "Example 2"
+  - text: "Akcje CDPROJEKT zanotowały największy spadek wśród spółek notowanych na GPW."
+    example_title: "Example 3"
+---
+
+
+# FinanceSentimentPL-fast
+
+FinanceSentimentPL-fast is a [distiluse](https://huggingface.co/sentence-transformers/distiluse-base-multilingual-cased-v1)-based model for analyzing sentiment of Polish 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/FinanceSentimentPL-fast")
+nlp("17 polskich firm wśród 50 najszybciej rozwijających się przedsiębiorstw technologicznych regionu.")
+```
+```bash
+[{'label': 'positive', 'score': 0.9999998807907104}]
+```
+
+## Performance
+| Metric | Value |
+| --- | ----------- |
+| f1 macro | 0.933 |
+| precision macro | 0.950 |
+| precision macro | 0.950 |
+| recall macro | 0.918 |
+| accuracy | 0.944 |
+| samples per second | 268.1 |
+
+(The performance was evaluated on RTX 3090 gpu)
+
+## 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 [email protected]