CristobalMe commited on
Commit
4117319
·
verified ·
1 Parent(s): e5e1693

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -33
README.md CHANGED
@@ -8,7 +8,8 @@ tags:
8
  license: mit
9
  language:
10
  - en
11
- metrics: null
 
12
  base_model:
13
  - ProsusAI/finbert
14
  ---
@@ -16,60 +17,62 @@ base_model:
16
  # Model Card for Model ID
17
 
18
  <!-- Provide a quick summary of what the model is/does. -->
19
-
 
20
 
21
 
22
  ## Model Details
23
 
24
- ### Model Description
25
-
26
- <!-- Provide a longer summary of what this model is. -->
27
-
28
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
29
-
30
- - **Developed by:** [More Information Needed]
31
- - **Funded by [optional]:** [More Information Needed]
32
- - **Shared by [optional]:** [More Information Needed]
33
- - **Model type:** [More Information Needed]
34
- - **Language(s) (NLP):** [More Information Needed]
35
- - **License:** [More Information Needed]
36
- - **Finetuned from model [optional]:** [More Information Needed]
37
 
38
- ### Model Sources [optional]
39
 
40
  <!-- Provide the basic links for the model. -->
41
 
42
- - **Repository:** [More Information Needed]
43
- - **Paper [optional]:** [More Information Needed]
44
- - **Demo [optional]:** [More Information Needed]
45
 
46
  ## Uses
47
 
48
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
49
 
 
50
  ### Direct Use
51
 
52
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
53
 
54
- [More Information Needed]
55
 
56
  ### Downstream Use [optional]
57
 
58
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
59
 
60
- [More Information Needed]
 
61
 
62
  ### Out-of-Scope Use
63
 
64
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
65
 
66
- [More Information Needed]
 
67
 
68
  ## Bias, Risks, and Limitations
69
 
70
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
71
 
72
- [More Information Needed]
 
 
 
 
73
 
74
  ### Recommendations
75
 
@@ -77,13 +80,15 @@ This is the model card of a 🤗 transformers model that has been pushed on the
77
 
78
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
79
 
80
- ## How to Get Started with the Model
 
 
81
 
82
  Use the code below to get started with the model.
83
 
84
  [More Information Needed]
85
 
86
- ## Training Details
87
 
88
  ### Training Data
89
 
@@ -152,13 +157,10 @@ Use the code below to get started with the model.
152
 
153
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
154
 
155
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
156
-
157
- - **Hardware Type:** [More Information Needed]
158
- - **Hours used:** [More Information Needed]
159
- - **Cloud Provider:** [More Information Needed]
160
- - **Compute Region:** [More Information Needed]
161
- - **Carbon Emitted:** [More Information Needed]
162
 
163
  ## Technical Specifications [optional]
164
 
@@ -206,4 +208,5 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
206
 
207
  ## Model Card Contact
208
 
209
- [More Information Needed]
 
 
8
  license: mit
9
  language:
10
  - en
11
+ metrics:
12
+ - accuracy
13
  base_model:
14
  - ProsusAI/finbert
15
  ---
 
17
  # Model Card for Model ID
18
 
19
  <!-- Provide a quick summary of what the model is/does. -->
20
+ TariffBERT is a fine-tuned version of **ProsusAI/finbert** for **financial sentiment analysis** focused on *tariff and trade-policy news*.
21
+ It classifies English-language text into **Positive**, **Negative** or **Neutral** sentiment toward tariff-related market impact.
22
 
23
 
24
  ## Model Details
25
 
26
+ - **Developed by:** Cristobal Medina Meza ([@CristobalMe](https://huggingface.co/CristobalMe))
27
+ - **Model type:** BERT-based sequence classifier
28
+ - **Language:** English
29
+ - **License:** MIT
30
+ - **Finetuned from:** [ProsusAI/finbert](https://huggingface.co/ProsusAI/finbert)
 
 
 
 
 
 
 
 
31
 
32
+ ### Model Sources [optional] TO DO
33
 
34
  <!-- Provide the basic links for the model. -->
35
 
36
+ <!-- - **Repository:** [More Information Needed] -->
37
+ <!-- - **Paper [optional]:** [More Information Needed] -->
38
+ <!-- - **Demo [optional]:** [More Information Needed] -->
39
 
40
  ## Uses
41
 
42
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
 
44
+
45
  ### Direct Use
46
 
47
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
+ - Sentiment classification of news articles and headlines, regulatory filings, or analyst notes discussing **tariffs, trade wars, or import/export policy**.
49
+ - Can be used as-is via the Hugging Face `pipeline("text-classification")`.
50
+
51
 
 
52
 
53
  ### Downstream Use [optional]
54
 
55
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
 
57
+ - As a component in financial forecasting, event-driven trading strategies, or risk dashboards.
58
+ - Further fine-tuning on sector-specific trade data.
59
 
60
  ### Out-of-Scope Use
61
 
62
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
 
64
+ - Non-financial general sentiment tasks (movie reviews, product opinions).
65
+ - High-stakes decision-making (e.g., compliance enforcement) without human oversight.
66
 
67
  ## Bias, Risks, and Limitations
68
 
69
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
70
 
71
+ - Domain bias: Training data is tariff/trade news; performance may degrade on unrelated finance text.
72
+
73
+ - Temporal drift: Model reflects market language up to its training cutoff SEPTEMBER 2025; newer policy jargon may be misclassified.
74
+
75
+ - Geographic bias: Data may over-represent US trade discourse.
76
 
77
  ### Recommendations
78
 
 
80
 
81
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
82
 
83
+ **Use confidence thresholds and human review in production.**
84
+
85
+ ## How to Get Started with the Model TO DO
86
 
87
  Use the code below to get started with the model.
88
 
89
  [More Information Needed]
90
 
91
+ ## Training Details TO DO
92
 
93
  ### Training Data
94
 
 
157
 
158
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
159
 
160
+ - **Hardware Type:** Apple MacBook Pro 14″ (M4 Pro, 14-core CPU / 20-core GPU)
161
+ - **Training Time:** ~15 minutes
162
+ - **Energy Use Estimate:** ≈0.02 kWh
163
+ - **Estimated Carbon Emissions:** ≈0.01 kg CO2eq
 
 
 
164
 
165
  ## Technical Specifications [optional]
166
 
 
208
 
209
  ## Model Card Contact
210
 
211
+ For questions or collaboration, email [hello@cmm.fyi](hello@cmm.fyi)
212
+ Or contact [@CristobalMe](https://github.com/CristobalMe)