docs: update and standardize README.md with metrics, hardware and citations

README.md

@@ -7,22 +7,37 @@ language:
 metrics:
 - f1
 - accuracy
-base_model:
-- PORTULAN/albertina-100m-portuguese-ptbr
+base_model: PORTULAN/albertina-100m-portuguese-ptbr-encoder
 pipeline_tag: text-classification
 license: mit
 tags:
 - fake-news
+- sequence-classification
+- text-classification
 - portuguese
 - brazil
 - elections
-- deberta
+- transformers
 - albertina
+- deberta
+model-index:
+- name: albertina-100m-portuguese-ptbr-fakerecogna2-extrativa-elections
+  results:
+  - task:
+      type: text-classification
+      name: Fake News Detection
+    dataset:
+      name: fakerecogna2-extrativa-elections
+      type: HenriqueLz/fakerecogna2-extrativa-elections
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.9967
 ---
 
 # Albertina 100M PT-BR — Detecção de Fake News (Eleições BR)
 
-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).
+Fine-tune do [`PORTULAN/albertina-100m-portuguese-ptbr-encoder`](https://huggingface.co/PORTULAN/albertina-100m-portuguese-ptbr-encoder) (DeBERTa) para classificação binária de notícias falsas em português brasileiro, treinado no corpus eleitoral [`HenriqueLz/fakerecogna2-extrativa-elections`](https://huggingface.co/datasets/HenriqueLz/fakerecogna2-extrativa-elections).
 
 ## Uso rápido
 
@@ -34,68 +49,86 @@ classifier = pipeline(
     model="HenriqueLz/albertina-100m-portuguese-ptbr-fakerecogna2-extrativa-elections",
 )
 
-result = classifier("A OMS confirmou que a vacina causa autismo em crianças.")
-# [{'label': 'FALSA', 'score': 0.9999}]
+# Exemplo de texto
+texto = "Ministério da Saúde divulga calendário oficial de vacinação para o próximo ano."
+resultado = classifier(texto)
+print(resultado)
+# [{'label': 'VERDADEIRA', 'score': 0.99...}]
 ```
 
-Ou carregando manualmente:
+### Carregamento manual com PyTorch:
 
 ```python
-from transformers import AutoTokenizer, AutoModelForSequenceClassification
 import torch
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
 
 model_id = "HenriqueLz/albertina-100m-portuguese-ptbr-fakerecogna2-extrativa-elections"
 tokenizer = AutoTokenizer.from_pretrained(model_id)
 model = AutoModelForSequenceClassification.from_pretrained(model_id)
 
-inputs = tokenizer("Texto a classificar", return_tensors="pt", truncation=True)
+inputs = tokenizer("Notícia para classificação...", return_tensors="pt", truncation=True, max_length=512)
 with torch.no_grad():
     logits = model(**inputs).logits
-pred = logits.argmax(-1).item()
-print(model.config.id2label[pred])  # "VERDADEIRA" ou "FALSA"
+
+predicted_class_id = logits.argmax(-1).item()
+label = model.config.id2label[predicted_class_id]
+print(f"Classe predita: {label}")  # "VERDADEIRA" ou "FALSA"
 ```
 
 ## Labels
 
 | ID | Label | Descrição |
-|----|-------|-----------|
-| 0 | `VERDADEIRA` | Notícia verdadeira / conteúdo factual |
-| 1 | `FALSA` | Notícia falsa / desinformação |
+|:---:|:---:|:---|
+| `0` | `VERDADEIRA` | Notícia verdadeira / conteúdo factual |
+| `1` | `FALSA` | Notícia falsa / desinformação |
+
+## Resultados de Avaliação
+
+Avaliado no split de teste do dataset [`HenriqueLz/fakerecogna2-extrativa-elections`](https://huggingface.co/datasets/HenriqueLz/fakerecogna2-extrativa-elections).
+
+| Métrica | Valor |
+|---------|-------|
+| F1 Score (Macro) | **0.9967** |
+| Acurácia | **99.67%** |
 
 ## Detalhes de Treinamento
 
 ### Dados
 
-- **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)
+- **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)
 - **Train:** 42.031 exemplos
 - **Test:** 10.504 exemplos (2.326 FALSA · 8.178 VERDADEIRA)
-- **Domínio:** Notícias sobre eleições brasileiras
+- **Domínio:** Notícias sobre eleições brasileiras (split temporal com data de corte em 30/10/2021)
 
-### Hiperparâmetros
+### Hiperparâmetros & Hardware
 
-| Parâmetro | Valor |
-|-----------|-------|
-| Learning rate | 1e-5 |
-| Batch size | 16 |
+| Parâmetro / Configuração | Valor |
+|--------------------------|-------|
 | Épocas | 5 |
+| Learning rate | 1e-5 |
 | Weight decay | 0.01 |
-| Precisão | fp16 |
+| Precisão | FP16 (Mixed Precision) |
+| Batch size | 16 (com DataCollatorWithPadding) |
 | Otimizador | AdamW |
 | Scheduler | Linear com warmup |
-| Hardware | NVIDIA Tesla P100 (Kaggle) |
+| Hardware | NVIDIA GeForce GTX 1070 (8 GB VRAM) local |
 
 ### Modelo base
 
-[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.
+[`PORTULAN/albertina-100m-portuguese-ptbr-encoder`](https://huggingface.co/PORTULAN/albertina-100m-portuguese-ptbr-encoder) — Modelo de 100M parâmetros baseado na arquitetura DeBERTa, pré-treinado para a variante brasileira do português pela PORTULAN CLARIN.
 
 ## Limitações
 
-- **Domínio restrito:** Treinado exclusivamente em notícias do contexto eleitoral brasileiro.
-- **Corte temporal:** O corpus reflete padrões linguísticos de um período eleitoral específico.
-- **Viés de dataset:** A distribuição de classes reflete o corpus coletado.
+- **Domínio eleitoral e jornalístico:** Treinado em notícias do contexto eleitoral brasileiro; pode apresentar desempenho inferior em textos excessivamente informais, gírias regionais de redes sociais ou outros idiomas.
+- **Corte temporal:** O corpus reflete padrões linguísticos e temporais pré e pós eleitorais com data de corte em 30/10/2021.
+- **Equilíbrio de classes e viés:** A distribuição de classes reflete o corpus coletado e rotulado no FakeRecogna 2.0.
+- **Uso responsável:** Como classificador probabilístico, deve ser utilizado como ferramenta auxiliar e de apoio à checagem de fatos, e não como árbitro único e definitivo da verdade.
 
 ## Citações
 
+Caso utilize este modelo em sua pesquisa, cite o dataset base FakeRecogna 2.0 e o modelo Albertina:
+
+### FakeRecogna 2.0 (PROPOR 2024):
 ```bibtex
 @inproceedings{garcia-etal-2024-text,
     title = "Text Summarization and Temporal Learning Models Applied to {P}ortuguese Fake News Detection in a Novel {B}razilian Corpus Dataset",
@@ -119,21 +152,16 @@ print(model.config.id2label[pred])  # "VERDADEIRA" ou "FALSA"
     url = "https://aclanthology.org/2024.propor-1.9/",
     pages = "86--96"
 }
+```
 
-@inproceedings{rodrigues-etal-2023-advancing,
-    title = "Advancing Neural Encoding of {P}ortuguese with {T}ransformer {A}lbertina {PT}-*",
-    author = "Rodrigues, Jo{\~a}o  and
-      Gomes, Lu{\'\i}s  and
-      Silva, Jo{\~a}o  and
-      Branco, Ant{'o}nio  and
-      Santos, Rodrigo  and
-      Cardoso, Henrique Lopes  and
-      Os{'o}rio, Tom{'a}s",
-    booktitle = "Progress in Artificial Intelligence: 22nd EPIA Conference on Artificial Intelligence (EPIA 2023)",
-    month = sep,
-    year = "2023",
-    address = "Faial Island, Portugal",
-    publisher = "Springer Nature Switzerland",
-    pages = "441--453"
+### Albertina PT-* (EMNLP 2023):
+```bibtex
+@inproceedings{rodrigues2023advancing,
+  title     = "Advancing {N}eural {L}anguage {M}odeling for {P}ortuguese with {A}lbertina {PT}-*",
+  author    = "Rodrigues, Jo{\~a}o and Gomes, Lu{'\i}s and Silva, Jo{\~a}o and de Melo, Ant{'o}nio and Lopes, Lu{'\i}s and Branco, Ant{'o}nio",
+  booktitle = "Proceedings of the 2023 Conference on Empirical Methods in Natural Language Processing",
+  year      = "2023",
+  pages     = "13426--13437",
+  url       = "https://aclanthology.org/2023.emnlp-main.832/"
 }
 ```