vic35get commited on
Commit
abe7f5f
·
verified ·
1 Parent(s): ab8f1f5

Add detailed Model Card with metrics

Browse files
Files changed (1) hide show
  1. README.md +112 -167
README.md CHANGED
@@ -1,199 +1,144 @@
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
+ license: mit
3
+ language:
4
+ - pt
5
  library_name: transformers
6
+ tags:
7
+ - text-classification
8
+ - binary-classification
9
+ - modernbert
10
+ - pytorch
11
+ - transformers
12
+ datasets:
13
+ - tcepi/mbp_pas_dataset
14
+ metrics:
15
+ - accuracy
16
+ - f1
17
+ - precision
18
+ - recall
19
+ - roc_auc
20
+ base_model: answerdotai/ModernBERT-base
21
+ pipeline_tag: text-classification
22
+ model-index:
23
+ - name: mbp_pas_model
24
+ results:
25
+ - task:
26
+ type: text-classification
27
+ name: Binary Text Classification
28
+ dataset:
29
+ name: tcepi/mbp_pas_dataset
30
+ type: tcepi/mbp_pas_dataset
31
+ split: test
32
+ metrics:
33
+ - name: Accuracy
34
+ type: accuracy
35
+ value: 0.9861
36
+ - name: F1
37
+ type: f1
38
+ value: 0.9863
39
+ - name: Precision
40
+ type: precision
41
+ value: 0.9796
42
+ - name: Recall
43
+ type: recall
44
+ value: 0.9931
45
+ - name: ROC-AUC
46
+ type: roc_auc
47
+ value: 0.9988
48
  ---
49
 
50
+ # MBP PAS Classification Model
51
 
52
+ Este modelo é um fine-tune do [ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base) para classificação binária, treinado no dataset [tcepi/mbp_pas_dataset](https://huggingface.co/datasets/tcepi/mbp_pas_dataset).
53
 
54
+ ## Descrição do Modelo
55
 
56
+ - **Modelo Base:** answerdotai/ModernBERT-base
57
+ - **Tarefa:** Classificação Binária de Texto
58
+ - **Linguagem:** Português (pt)
59
+ - **Framework:** PyTorch + Transformers
60
 
61
+ ## Métricas de Performance
62
 
63
+ ### Conjunto de Teste
64
 
65
+ | Métrica | Valor |
66
+ |---------|-------|
67
+ | **Accuracy** | 0.9861 |
68
+ | **F1-Score** | 0.9863 |
69
+ | **Precision** | 0.9796 |
70
+ | **Recall** | 0.9931 |
71
+ | **ROC-AUC** | 0.9988 |
72
+ | **Specificity** | 0.9789 |
73
 
74
+ ### Matriz de Confusão
75
 
76
+ | | Predito Negativo | Predito Positivo |
77
+ |--|-----------------|-----------------|
78
+ | **Real Negativo** | 139 (TN) | 3 (FP) |
79
+ | **Real Positivo** | 1 (FN) | 144 (TP) |
 
 
 
80
 
81
+ ### Relatório de Classificação
82
 
83
+ ```
84
+ precision recall f1-score support
85
 
86
+ Negativo 0.9929 0.9789 0.9858 142
87
+ Positivo 0.9796 0.9931 0.9863 145
 
88
 
89
+ accuracy 0.9861 287
90
+ macro avg 0.9862 0.9860 0.9861 287
91
+ weighted avg 0.9862 0.9861 0.9861 287
92
 
93
+ ```
94
 
95
+ ## Uso
96
 
97
+ ```python
98
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
99
+ import torch
100
 
101
+ # Carregar modelo e tokenizer
102
+ tokenizer = AutoTokenizer.from_pretrained("tcepi/mbp_pas_model")
103
+ model = AutoModelForSequenceClassification.from_pretrained("tcepi/mbp_pas_model")
104
 
105
+ # Classificar texto
106
+ text = "Seu texto aqui"
107
+ inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=512)
108
 
109
+ with torch.no_grad():
110
+ outputs = model(**inputs)
111
+ predictions = torch.softmax(outputs.logits, dim=-1)
112
+ predicted_class = torch.argmax(predictions, dim=-1).item()
113
 
114
+ print(f"Classe predita: {model.config.id2label[predicted_class]}")
115
+ print(f"Probabilidades: {predictions.tolist()}")
116
+ ```
117
 
118
+ ## Treinamento
119
 
120
+ ### Hiperparâmetros
121
 
122
+ - **Épocas:** 5
123
+ - **Learning Rate:** 2e-5
124
+ - **Batch Size:** 8
125
+ - **Weight Decay:** 0.01
126
+ - **Warmup Ratio:** 0.1
127
+ - **Mixed Precision:** FP16
128
+ - **Optimizer:** AdamW
129
 
130
+ ### Informações de Treinamento
131
 
132
+ - **Tempo Total:** 186.64 segundos
133
+ - **Samples/segundo:** 55.19
134
+ - **Loss Final:** 0.1391
135
 
136
+ ## Dataset
137
 
138
+ O modelo foi treinado usando o dataset [tcepi/mbp_pas_dataset](https://huggingface.co/datasets/tcepi/mbp_pas_dataset).
139
 
140
+ ## Limitações
141
 
142
+ - O modelo foi treinado especificamente para o domínio do dataset MBP/PAS
143
+ - Performance pode variar em textos de outros domínios
144
+ - Recomenda-se avaliar o modelo antes de usar em produção