radubutucelea23 commited on
Commit
de4a506
·
verified ·
1 Parent(s): 588eae7

Update README.md

Browse files

updated README information.

Files changed (1) hide show
  1. README.md +81 -160
README.md CHANGED
@@ -1,199 +1,120 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
 
 
 
4
  ---
 
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
 
 
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
 
 
 
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
 
 
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
 
40
- ### Direct Use
 
 
 
 
 
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
 
 
 
 
45
 
46
- ### Downstream Use [optional]
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
 
50
- [More Information Needed]
51
 
52
- ### Out-of-Scope Use
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
 
56
- [More Information Needed]
57
 
58
- ## Bias, Risks, and Limitations
 
 
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
 
63
 
64
- ### Recommendations
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 
69
 
70
- ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
 
74
- [More Information Needed]
 
 
 
 
 
 
75
 
76
- ## Training Details
 
 
 
 
 
 
77
 
78
- ### Training Data
79
 
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
 
 
 
 
81
 
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ license: mit
4
+ datasets:
5
+ - nyu-mll/glue
6
+ base_model:
7
+ - google-bert/bert-base-uncased
8
  ---
9
+ # BERT Fine-tuned for Sentiment Analysis on SST-2
10
 
11
+ ## Model Description
12
 
13
+ This model is a fine-tuned version of `bert-base-uncased` on the Stanford Sentiment Treebank v2 (SST-2) dataset. It was trained to perform binary sentiment classification (positive/negative) on movie review sentences.
14
 
15
+ ## Intended Uses & Limitations
16
 
17
+ ### Intended Uses
18
 
19
+ - Sentiment analysis of short English texts, particularly movie reviews and similar content
20
+ - Educational purposes for demonstrating fine-tuning of pre-trained language models
21
+ - Baseline model for comparing more advanced sentiment analysis approaches
22
 
23
+ ### Limitations
24
 
25
+ - The model is trained on movie reviews and may not generalize well to other domains (e.g., product reviews, social media posts)
26
+ - Limited to English language text
27
+ - Not optimized for very long texts (best for sentences or short paragraphs)
28
+ - Binary classification only (positive/negative) without nuanced sentiment scores
29
 
30
+ ## Training and Evaluation Data
31
 
32
+ The model was fine-tuned on the SST-2 dataset from the GLUE benchmark:
 
 
 
 
 
 
33
 
34
+ - **Training set**: 67,349 examples
35
+ - **Validation set**: 872 examples
36
+ - **Test set**: Not used in this fine-tuning
37
 
38
+ The SST-2 dataset consists of sentences from movie reviews with their associated binary sentiment labels.
39
 
40
+ For more information about the dataset, see the [GLUE benchmark dataset card](https://huggingface.co/datasets/nyu-mll/glue).
 
 
41
 
42
+ ## Training Procedure
43
 
44
+ ### Training Hyperparameters
45
 
46
+ - **Base model**: `bert-base-uncased`
47
+ - **Epochs**: 3
48
+ - **Training samples per second**: 187.16
49
+ - **Training steps per second**: 23.396
50
+ - **Total FLOPS**: 3.08e+15
51
+ - **Hardware**: NVIDIA A100 GPU
52
 
53
+ ### Training Results
54
 
55
+ | Epoch | Training Loss | Validation Loss | Accuracy |
56
+ |-------|--------------|----------------|----------|
57
+ | 1 | 0.256300 | 0.427576 | 0.899083 |
58
+ | 2 | 0.169200 | 0.415616 | 0.903670 |
59
+ | 3 | 0.095600 | 0.426083 | 0.903670 |
60
 
61
+ Final training loss: 0.19818013534790577
62
 
63
+ ## Performance
64
 
65
+ ### Metrics
66
 
67
+ - **Accuracy on validation set**: 90.37%
68
 
69
+ ## Model Limitations and Biases
70
 
71
+ This model may have inherited biases from its training data and pre-training corpus:
72
 
73
+ - The SST-2 dataset primarily contains movie reviews which may not represent diverse perspectives
74
+ - The model may perform differently across different demographic groups or cultural contexts
75
+ - May have difficulty with sarcasm, irony, or culturally-specific expressions
76
 
77
+ ## Usage
78
 
79
+ ```python
80
+ from transformers import pipeline
81
 
82
+ sentiment_analyzer = pipeline("sentiment-analysis", model="radubutucelea23/bert_base_uncased_sst2")
83
 
84
+ texts = ["I really enjoyed this movie, the acting was superb.",
85
+ "The plot was confusing and the characters were poorly developed."]
86
 
87
+ results = sentiment_analyzer(texts)
88
+ print(results)
89
+ ```
90
 
91
+ ## Citation
92
 
93
+ If you use this model, please cite:
94
 
95
+ ```
96
+ @inproceedings{socher-etal-2013-recursive,
97
+ title = "Recursive Deep Models for Semantic Compositionality Over a Sentiment Treebank",
98
+ author = "Socher, Richard and Perelygin, Alex and Wu, Jean and Chuang, Jason and Manning, Christopher D. and Ng, Andrew Y. and Potts, Christopher",
99
+ booktitle = "Proceedings of EMNLP",
100
+ year = "2013"
101
+ }
102
 
103
+ @article{devlin2019bert,
104
+ title={BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding},
105
+ author={Devlin, Jacob and Chang, Ming-Wei and Lee, Kenton and Toutanova, Kristina},
106
+ journal={arXiv preprint arXiv:1810.04805},
107
+ year={2018}
108
+ }
109
+ ```
110
 
111
+ ## Further Information
112
 
113
+ - **Model Type**: Text Classification
114
+ - **Language**: English
115
+ - **License**: MIT
116
+ - **Developer**: Radu Butucelea
117
+ - **Organization**: None
118
+ - **Last Updated**: April 2, 2025
119
 
120
+ For questions and feedback, please contact me through my Hugging Face profile: [radubutucelea23](https://huggingface.co/radubutucelea23)