Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,62 @@
+---
+language: zh
+tags:
+  - text-classification
+  - financial-sentiment-analysis
+  - sentiment-analysis
+datasets:
+  - datasets/financial_phrasebank
+metrics:
+  - f1
+  - accuracy
+  - precision
+  - recall
+widget:
+  - text: "净销售额增长30%，达到3600万欧元。"
+    example_title: "Example 1"
+  - text: "黑色星期五拉开帷幕。店内促销活动列表。"
+    example_title: "Example 2"
+  - text: "CDPROJEKT股价在WSE上市公司中跌幅最大。"
+    example_title: "Example 3"
+---
+
+
+# Finance Sentiment ZH (fast)
+
+Finance Sentiment ZH (fast) is a [distiluse](https://huggingface.co/sentence-transformers/distiluse-base-multilingual-cased-v1)-based model for analyzing sentiment of Chinese 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-zh-fast")
+nlp("净销售额增长30%，达到3600万欧元。")
+```
+```bash
+[{'label': 'positive', 'score': 0.9997768998146057}]
+```
+
+## Performance
+| Metric | Value |
+| --- | ----------- |
+| f1 macro | 0.953 |
+| precision macro | 0.959 |
+| recall macro | 0.949 |
+| accuracy | 0.961 |
+| samples per second | 264.6 |
+
+(The performance was evaluated on RTX 3090 gpu)
+
+## Changelog
+- 2023-07-12: 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 [email protected]