Kroalist commited on
Commit
2562f31
·
verified ·
1 Parent(s): 005ef5e

Add evaluation metrics to README (acc 0.81 / F1 0.79)

Browse files
Files changed (1) hide show
  1. README.md +29 -12
README.md CHANGED
@@ -1,27 +1,44 @@
1
  ---
2
- language:
3
- - en
4
  license: apache-2.0
5
  library_name: transformers
6
- pipeline_tag: text-classification # ✅ valid task ID
7
- datasets:
8
- - financial_phrase_bank
9
  base_model: ProsusAI/finbert
10
  tags:
11
- - sentiment-analysis # free-form tag
12
  - finance
13
- - finbert
14
  - text-classification
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  ---
16
  # Financial Sentiment BERT (FinBERT fine-tune)
17
 
18
  Sentence-level classifier for **English financial news**.
19
 
20
- * **Base model**: ProsusAI/finbert
21
- * **Dataset** : Financial PhraseBank
22
- * **Labels** : positive (0) · negative (1) · neutral (2)
23
- * **Epochs** : 6 (AdamW, lr = 2e-5)
24
- * **Hardware** : CPU-only training
 
 
 
 
25
 
26
  ## Usage
27
 
 
1
  ---
2
+ language: [en]
 
3
  license: apache-2.0
4
  library_name: transformers
5
+ pipeline_tag: text-classification
6
+ datasets: [financial_phrase_bank]
 
7
  base_model: ProsusAI/finbert
8
  tags:
9
+ - sentiment-analysis
10
  - finance
 
11
  - text-classification
12
+ model-index:
13
+ - name: Financial Sentiment BERT (FinBERT fine-tune)
14
+ results:
15
+ - task:
16
+ type: text-classification
17
+ name: Sentiment Analysis
18
+ dataset:
19
+ name: Financial PhraseBank
20
+ type: financial_phrase_bank
21
+ split: test
22
+ metrics:
23
+ - type: accuracy
24
+ value: 0.81
25
+ - type: f1
26
+ name: macro F1
27
+ value: 0.79
28
  ---
29
  # Financial Sentiment BERT (FinBERT fine-tune)
30
 
31
  Sentence-level classifier for **English financial news**.
32
 
33
+ | Item | Value |
34
+ |------|-------|
35
+ | **Base model** | `ProsusAI/finbert` |
36
+ | **Dataset** | Financial PhraseBank |
37
+ | **Labels** | positive (0) · negative (1) · neutral (2) |
38
+ | **Epochs** | 3 (early-stopped) |
39
+ | **Best val acc** | 0.8356 |
40
+ | **Test acc** | 0.81 |
41
+ | **Hardware** | CPU-only training |
42
 
43
  ## Usage
44