HenriqueLz commited on
Commit
e8f0a28
·
verified ·
1 Parent(s): f0d0aef

Update and standardize README.md with FakeRecogna 2.0 and Albertina citations

Browse files
Files changed (1) hide show
  1. README.md +127 -195
README.md CHANGED
@@ -6,202 +6,134 @@ language:
6
  - pt
7
  metrics:
8
  - f1
 
9
  base_model:
10
- - PORTULAN/albertina-100m-portuguese-ptbr-encoder
11
  pipeline_tag: text-classification
 
 
 
 
 
 
 
 
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
-
19
-
20
- ## Model Details
21
-
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
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
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- 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).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
-
207
- [More Information Needed]
 
6
  - pt
7
  metrics:
8
  - f1
9
+ - accuracy
10
  base_model:
11
+ - PORTULAN/albertina-100m-portuguese-ptbr
12
  pipeline_tag: text-classification
13
+ license: mit
14
+ tags:
15
+ - fake-news
16
+ - portuguese
17
+ - brazil
18
+ - elections
19
+ - deberta
20
+ - albertina
21
  ---
22
 
23
+ # Albertina 100M PT-BR — Detecção de Fake News (Eleições BR)
24
+
25
+ Fine-tune do [Albertina 100M PT-BR](https://huggingface.co/PORTULAN/albertina-100m-portuguese-ptbr) (DeBERTa) para classificação binária de notícias falsas em português brasileiro, treinado no corpus eleitoral [fakerecogna2-extrativa-elections](https://huggingface.co/datasets/HenriqueLz/fakerecogna2-extrativa-elections).
26
+
27
+ ## Uso rápido
28
+
29
+ ```python
30
+ from transformers import pipeline
31
+
32
+ classifier = pipeline(
33
+ "text-classification",
34
+ model="HenriqueLz/albertina-100m-portuguese-ptbr-fakerecogna2-extrativa-elections",
35
+ )
36
+
37
+ result = classifier("A OMS confirmou que a vacina causa autismo em crianças.")
38
+ # [{'label': 'FALSA', 'score': 0.9999}]
39
+ ```
40
+
41
+ Ou carregando manualmente:
42
+
43
+ ```python
44
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
45
+ import torch
46
+
47
+ model_id = "HenriqueLz/albertina-100m-portuguese-ptbr-fakerecogna2-extrativa-elections"
48
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
49
+ model = AutoModelForSequenceClassification.from_pretrained(model_id)
50
+
51
+ inputs = tokenizer("Texto a classificar", return_tensors="pt", truncation=True)
52
+ with torch.no_grad():
53
+ logits = model(**inputs).logits
54
+ pred = logits.argmax(-1).item()
55
+ print(model.config.id2label[pred]) # "VERDADEIRA" ou "FALSA"
56
+ ```
57
+
58
+ ## Labels
59
+
60
+ | ID | Label | Descrição |
61
+ |----|-------|-----------|
62
+ | 0 | `VERDADEIRA` | Notícia verdadeira / conteúdo factual |
63
+ | 1 | `FALSA` | Notícia falsa / desinformação |
64
+
65
+ ## Detalhes de Treinamento
66
+
67
+ ### Dados
68
+
69
+ - **Dataset base:** [recogna-nlp/fakerecogna2-extrativa](https://huggingface.co/datasets/recogna-nlp/fakerecogna2-extrativa) / [HenriqueLz/fakerecogna2-extrativa-elections](https://huggingface.co/datasets/HenriqueLz/fakerecogna2-extrativa-elections)
70
+ - **Train:** 42.031 exemplos
71
+ - **Test:** 10.504 exemplos (2.326 FALSA · 8.178 VERDADEIRA)
72
+ - **Domínio:** Notícias sobre eleições brasileiras
73
+
74
+ ### Hiperparâmetros
75
+
76
+ | Parâmetro | Valor |
77
+ |-----------|-------|
78
+ | Learning rate | 1e-5 |
79
+ | Batch size | 16 |
80
+ | Épocas | 5 |
81
+ | Weight decay | 0.01 |
82
+ | Precisão | fp16 |
83
+ | Otimizador | AdamW |
84
+ | Scheduler | Linear com warmup |
85
+ | Hardware | NVIDIA Tesla P100 (Kaggle) |
86
+
87
+ ### Modelo base
88
+
89
+ [Albertina 100M PT-BR](https://huggingface.co/PORTULAN/albertina-100m-portuguese-ptbr) — Modelo baseado na arquitetura DeBERTa (100M parâmetros) pré-treinado em português brasileiro pela PORTULAN CLARIN.
90
+
91
+ ## Limitações
92
+
93
+ - **Domínio restrito:** Treinado exclusivamente em notícias do contexto eleitoral brasileiro.
94
+ - **Corte temporal:** O corpus reflete padrões linguísticos de um período eleitoral específico.
95
+ - **Viés de dataset:** A distribuição de classes reflete o corpus coletado.
96
+
97
+ ## Citações
98
+
99
+ ```bibtex
100
+ @inproceedings{garcia-etal-2024-text,
101
+ title = "Text Summarization and Temporal Learning Models Applied to {P}ortuguese Fake News Detection in a Novel {B}razilian Corpus Dataset",
102
+ author = "Garcia, Gabriel Lino and
103
+ Paiola, Pedro Henrique and
104
+ Jodas, Danilo Samuel and
105
+ Sugi, Luis Afonso and
106
+ Papa, Jo{\~a}o Paulo",
107
+ editor = "Gamallo, Pablo and
108
+ Claro, Daniela and
109
+ Teixeira, Ant{'o}nio and
110
+ Real, Livy and
111
+ Garcia, Marcos and
112
+ Oliveira, Hugo Gon{\c{c}}alo and
113
+ Amaro, Raquel",
114
+ booktitle = "Proceedings of the 16th International Conference on Computational Processing of Portuguese - Vol. 1",
115
+ month = mar,
116
+ year = "2024",
117
+ address = "Santiago de Compostela, Galicia/Spain",
118
+ publisher = "Association for Computational Lingustics",
119
+ url = "https://aclanthology.org/2024.propor-1.9/",
120
+ pages = "86--96"
121
+ }
122
+
123
+ @inproceedings{rodrigues-etal-2023-advancing,
124
+ title = "Advancing Neural Encoding of {P}ortuguese with {T}ransformer {A}lbertina {PT}-*",
125
+ author = "Rodrigues, Jo{\~a}o and
126
+ Gomes, Lu{\'\i}s and
127
+ Silva, Jo{\~a}o and
128
+ Branco, Ant{'o}nio and
129
+ Santos, Rodrigo and
130
+ Cardoso, Henrique Lopes and
131
+ Os{'o}rio, Tom{'a}s",
132
+ booktitle = "Progress in Artificial Intelligence: 22nd EPIA Conference on Artificial Intelligence (EPIA 2023)",
133
+ month = sep,
134
+ year = "2023",
135
+ address = "Faial Island, Portugal",
136
+ publisher = "Springer Nature Switzerland",
137
+ pages = "441--453"
138
+ }
139
+ ```