ohanvi commited on
Commit
044555a
·
verified ·
1 Parent(s): 81aed8c

Update model card

Browse files
Files changed (1) hide show
  1. README.md +116 -161
README.md CHANGED
@@ -1,199 +1,154 @@
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
+ language:
3
+ - en
4
+ license: apache-2.0
5
  library_name: transformers
6
+ tags:
7
+ - text-classification
8
+ - sentiment-analysis
9
+ - distilbert
10
+ - imdb
11
+ - pytorch
12
+ pipeline_tag: text-classification
13
+ datasets:
14
+ - imdb
15
+ metrics:
16
+ - accuracy
17
+ - f1
18
+ model-index:
19
+ - name: ohanvi-sentiment-analysis
20
+ results:
21
+ - task:
22
+ type: text-classification
23
+ name: Sentiment Analysis
24
+ dataset:
25
+ name: IMDb
26
+ type: imdb
27
+ split: test
28
+ metrics:
29
+ - type: accuracy
30
+ value: 0.932
31
+ name: Accuracy
32
+ - type: f1
33
+ value: 0.931
34
+ name: F1
35
  ---
36
 
37
+ # 🎬 Ohanvi Sentiment Analysis
 
 
 
38
 
39
+ A fine-tuned **DistilBERT** model for binary sentiment analysis on movie reviews.
40
+ Given any text it predicts whether the sentiment is **positive** or **negative**.
41
 
42
  ## Model Details
43
 
44
+ | Attribute | Value |
45
+ |-----------|-------|
46
+ | **Base model** | `distilbert-base-uncased` |
47
+ | **Fine-tuned on** | [IMDb Movie Reviews](https://huggingface.co/datasets/imdb) |
48
+ | **Task** | Text Classification (Sentiment Analysis) |
49
+ | **Labels** | `positive` (1) / `negative` (0) |
50
+ | **Max sequence length** | 512 tokens |
51
+ | **Framework** | PyTorch + 🤗 Transformers |
52
+ | **License** | Apache 2.0 |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
 
54
+ ## Performance
55
 
56
+ Evaluated on the IMDb test split (25 000 samples):
57
 
58
+ | Metric | Score |
59
+ |--------|-------|
60
+ | Accuracy | ~93.2% |
61
+ | F1 (binary) | ~93.1% |
62
 
63
+ ## Quick Start
64
 
65
+ ```python
66
+ from transformers import pipeline
67
 
68
+ classifier = pipeline(
69
+ "text-classification",
70
+ model="your-hf-username/ohanvi-sentiment-analysis",
71
+ )
72
 
73
+ result = classifier("This movie was absolutely fantastic!")
74
+ # → [{'label': 'positive', 'score': 0.9978}]
75
 
76
+ result = classifier("Terrible film, complete waste of time.")
77
+ # → [{'label': 'negative', 'score': 0.9965}]
78
+ ```
 
 
 
 
 
 
79
 
80
  ## Training Details
81
 
82
+ ### Hyperparameters
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
 
84
+ | Parameter | Value |
85
+ |-----------|-------|
86
+ | Epochs | 3 |
87
+ | Batch size (train) | 16 |
88
+ | Learning rate | 2e-5 |
89
+ | Weight decay | 0.01 |
90
+ | Warmup ratio | 10% |
91
+ | Optimiser | AdamW |
92
+ | LR scheduler | Linear with warmup |
93
 
94
+ ### Training Data
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
 
96
+ The model was fine-tuned on the full [IMDb](https://huggingface.co/datasets/imdb) dataset:
97
+ - **Train**: 25 000 reviews (12 500 positive, 12 500 negative)
98
+ - **Test**: 25 000 reviews (12 500 positive, 12 500 negative)
99
 
100
+ ### Training Environment
101
 
102
+ - Hardware: GPU (NVIDIA / Apple Silicon MPS)
103
+ - Mixed precision: fp16 (when CUDA available)
104
+ - Early stopping: patience = 2 epochs
105
 
106
+ ## How to Use (Advanced)
107
 
108
+ ```python
109
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
110
+ import torch
111
 
112
+ model_name = "your-hf-username/ohanvi-sentiment-analysis"
113
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
114
+ model = AutoModelForSequenceClassification.from_pretrained(model_name)
115
+ model.eval()
116
 
117
+ text = "An outstanding film with incredible performances."
118
+ inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=512)
119
 
120
+ with torch.no_grad():
121
+ logits = model(**inputs).logits
122
 
123
+ probs = torch.softmax(logits, dim=-1)
124
+ label_id = probs.argmax().item()
125
+ label = model.config.id2label[label_id]
126
+ confidence = probs[0][label_id].item()
127
 
128
+ print(f"Label: {label} ({confidence:.1%})")
129
+ ```
130
 
131
+ ## Limitations
132
 
133
+ - Trained exclusively on **English** movie reviews; performance on other languages or domains may be lower.
134
+ - Very short texts (< 5 words) may produce less reliable results.
135
+ - The model inherits any biases present in the IMDb dataset.
136
 
137
+ ## Citation
138
 
139
+ If you use this model, please cite:
140
 
141
+ ```bibtex
142
+ @misc{ohanvi-sentiment-2026,
143
+ title = {Ohanvi Sentiment Analysis},
144
+ author = {Gourav Bansal},
145
+ year = {2026},
146
+ url = {https://huggingface.co/your-hf-username/ohanvi-sentiment-analysis},
147
+ }
148
+ ```
149
 
150
+ ## Acknowledgements
151
 
152
+ Built with 🤗 [Transformers](https://github.com/huggingface/transformers),
153
+ 🤗 [Datasets](https://github.com/huggingface/datasets), and
154
+ [Gradio](https://gradio.app/).