ShahzaibAli-1 commited on
Commit
30cea2b
·
verified ·
1 Parent(s): 1609ecf

Added And Updated Readme

Browse files
Files changed (1) hide show
  1. README.md +120 -147
README.md CHANGED
@@ -1,199 +1,172 @@
 
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
  ---
3
+ language: en
4
+ license: apache-2.0
5
+ datasets:
6
+ - ag_news
7
+ tags:
8
+ - text-classification
9
+ - bert
10
+ - ag-news
11
  ---
12
 
13
+ # BERT-base-uncased fine-tuned on AG News
 
 
 
14
 
15
+ This model is a fine-tuned version of `bert-base-uncased` on the AG News dataset, achieving **94.36% accuracy** on the test set.
16
 
17
  ## Model Details
18
 
19
+ - **Model Type:** Text Classification (BERT)
20
+ - **Base Model:** [bert-base-uncased](https://huggingface.co/bert-base-uncased)
21
+ - **Dataset:** [AG News](https://huggingface.co/datasets/ag_news)
22
+ - **Fine-tuning Approach:** Sequence Classification
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
 
24
+ ## Training Results
25
 
26
+ | Epoch | Training Loss | Validation Loss | Accuracy | F1 (Weighted) |
27
+ |-------|---------------|-----------------|----------|---------------|
28
+ | 1 | 0.231600 | 0.212338 | 0.9359 | 0.9359 |
29
+ | 2 | 0.176300 | 0.213332 | 0.9439 | 0.9439 |
30
+ | 3 | 0.119100 | 0.230517 | 0.9450 | 0.9450 |
31
+ | 4 | 0.074500 | 0.286154 | 0.9447 | 0.9448 |
32
+ | 5 | 0.031700 | 0.344374 | 0.9436 | 0.9435 |
33
 
34
+ ## Confusion Matrix
35
 
36
+ ![Confusion Matrix](image.png)
37
 
38
+ ### Confusion Matrix Values (True Label → Predicted Label)
39
 
40
+ | | World | Sports | Business | Sci/Tech |
41
+ |-------------|-------|--------|----------|----------|
42
+ | **World** | 1812 | 13 | 43 | 32 |
43
+ | **Sports** | 7 | 1880 | 7 | 6 |
44
+ | **Business**| 39 | 9 | 1728 | 124 |
45
+ | **Sci/Tech**| 34 | 10 | 105 | 1751 |
46
 
47
+ ## How to Use
48
 
49
+ ```python
50
+ from transformers import pipeline
51
 
52
+ classifier = pipeline("text-classification", model="ShahzaibAli-1/News_Classifier-bert-base-uncased")
53
 
54
+ result = classifier("Apple reported record profits last quarter.")
55
 
56
+ print(result)
57
+ ```
58
 
59
+ ## Performance
60
 
61
+ ### Training Hyperparameters
62
 
63
+ - Learning Rate: 5e-5
64
+ - Batch Size: 8
65
+ - Epochs: 5
66
+ - Warmup Ratio: 0.1
67
+ - Max Sequence Length: 128
68
 
69
+ Final Test Accuracy: 94.36%
70
 
71
+ Final Test F1-Score (Weighted): 94.35%
72
 
73
+ ### To watch a proper demo using Gradio
74
 
75
+ ```python
76
+ from transformers import pipeline
77
 
78
+ classifier = pipeline("text-classification", model="ShahzaibAli-1/News_Classifier-bert-base-uncased")
79
 
80
+ result = classifier("Apple reported record profits last quarter.")
81
 
82
+ print(result)
83
 
84
+ import gradio as gr
85
+ from transformers import pipeline
86
 
87
+ # Load model
88
+ classifier = pipeline("text-classification", model="ShahzaibAli-1/News_Classifier-bert-base-uncased")
89
 
90
+ # Define label mapping (must match your training labels)
91
+ label_map = {
92
+ 0: "World",
93
+ 1: "Sports",
94
+ 2: "Business",
95
+ 3: "Sci/Tech"
96
+ }
97
 
98
+ def predict(text):
99
+ result = classifier(text)[0]
100
+ # Extract numerical label (e.g., "LABEL_1" -> 1)
101
+ label_num = int(result['label'].split("_")[-1])
102
+ # Get corresponding text label
103
+ label_text = label_map[label_num]
104
+ return f"{label_text} (confidence: {result['score']:.2%})"
105
 
106
+ # Create interface
107
+ iface = gr.Interface(
108
+ fn=predict,
109
+ inputs=gr.Textbox(lines=2, placeholder="Enter news text here..."),
110
+ outputs="text",
111
+ title="AG News Classifier",
112
+ description="Classify news articles into World, Sports, Business, or Sci/Tech categories"
113
+ )
114
 
115
+ iface.launch()
116
+ ```
117
 
118
+ ## Example Outputs
119
 
120
+ Here are some example outputs for various test cases:
121
 
122
+ - **Sports News**:
123
+ Prompt: `"Newzealand Won the Test Championship today"`
124
+ Output: `Sports (confidence: 99.99%)`
125
 
126
+ - **Business News**:
127
+ Prompt: `"The stock market saw a significant increase following the tech boom"`
128
+ Output: `Business (confidence: 98.50%)`
129
 
130
+ - **World News**:
131
+ Prompt: `"The political unrest in Eastern Europe has escalated this week"`
132
+ Output: `World (confidence: 97.70%)`
133
 
134
+ - **Sci/Tech News**:
135
+ Prompt: `"Scientists have developed a new battery that can last twice as long as current models"`
136
+ Output: `Sci/Tech (confidence: 96.30%)`
137
 
138
+ ## Evaluation Metrics
139
 
140
+ The following evaluation metrics were used to assess the model's performance:
141
 
142
+ - **Accuracy**: The percentage of correct predictions over the total number of predictions.
143
+ - **Precision**: The proportion of positive predictions that were actually correct.
144
+ - **Recall**: The proportion of actual positives that were correctly identified.
145
+ - **F1-Score**: The harmonic mean of precision and recall.
146
 
147
+ The model demonstrated strong performance across all metrics, particularly with an accuracy of 94.36%.
148
 
149
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
150
 
151
+ ## Citation
152
 
153
+ If you use this model in your research or projects, please cite it as follows:
154
 
155
+ ```
156
+ @article{shahzaib2025news,
157
+ title={Fine-Tuning BERT for AG News Classification},
158
+ author={Shahzaib Ali},
159
+ journal={Hugging Face Model Hub},
160
+ year={2025},
161
+ url={https://huggingface.co/ShahzaibAli-1/News_Classifier-bert-base-uncased}
162
+ }
163
+ ```
164
 
165
+ ## License
166
 
167
+ The model is released under the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0). Feel free to use it in your applications and research.
168
 
169
+ ## Contact
170
 
171
+ For any questions or suggestions, feel free to open an issue or contact the model creator at:
172
+ - **Hugging Face**: [ShahzaibAli-1](https://huggingface.co/ShahzaibAli-1)