Update README.md

README.md

@@ -1,199 +1,141 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- legal
+- licitação
+- editais
+license: apache-2.0
+language:
+- pt
+metrics:
+- accuracy
+- f1
+- precision
+- recall
+- perplexity
+base_model:
+- google-bert/bert-base-uncased
+pipeline_tag: fill-mask
 ---
 
-# Model Card for Model ID
+# HelBERT: Modelo BERT para Contratações Públicas
 
-<!-- Provide a quick summary of what the model is/does. -->
+O **HelBERT** é um modelo de linguagem baseado na arquitetura BERT, pré-treinado com mais de **1,4 bilhão de tokens** extraídos de **editais de licitação, contratos públicos e legislações brasileiras**, com foco exclusivo no domínio jurídico de **contratações públicas**.
 
+Foi desenvolvido para superar modelos genéricos e jurídicos existentes em tarefas específicas do setor público, como **classificação de objetos de contratação** e **identificação de indícios de fraude em editais**.
 
+---
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
+## 🧠 Detalhes do Modelo
 
+- **Arquitetura:** BERT-Base (12 camadas, 110M parâmetros)
+- **Tarefa de pré-treinamento:** Masked Language Modeling (MLM)
+- **Tokenizador:** WordPiece especializado em domínio jurídico
+- **Corpora:** Comprasnet, TCE-PI, PNCP, Leis de Licitação
+- **Tamanho do vocabulário:** 33 mil subpalavras
+- **Precisão:** 95.87% F1 na classificação de objetos e 91.65% F1 na detecção de fraudes
 
+---
 
-## Model Examination [optional]
+## 🧪 Avaliação
 
-<!-- Relevant interpretability work for the model goes here -->
+| Tarefa                                   | F1-Weighted | Accuracy |
+|-----------------------------------------|-------------|----------|
+| Classificação de objetos de contratação | 95.87%      | 95.87%   |
+| Classificação de indícios de fraude     | 91.65%      | 86.08%   |
 
-[More Information Needed]
+### Outras métricas:
 
-## Environmental Impact
+- **Perplexidade:** 3.4–3.5 nos datasets jurídicos
+- **Fertilidade do tokenizador:** 1.17–1.18 (baixo número de subpalavras por palavra)
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+---
 
-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).
+## ✅ Como usar
 
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+```python
+from transformers import AutoTokenizer, AutoModelForMaskedLM
 
-## Technical Specifications [optional]
+tokenizer = AutoTokenizer.from_pretrained("seu-usuario/helbert")
+model = AutoModelForMaskedLM.from_pretrained("seu-usuario/helbert")
 
-### Model Architecture and Objective
+input_text = "A proposta será avaliada com base no critério do [MASK]."
+inputs = tokenizer(input_text, return_tensors="pt")
+outputs = model(**inputs)
+```
 
-[More Information Needed]
+## 📚 Dados de Treinamento
 
-### Compute Infrastructure
+- **Documentos utilizados:** mais de 460 mil, incluindo editais de licitação, contratos administrativos, termos de referência, atas e legislações.
+- **Fontes:** COMPRASNET, Portal Nacional de Contratações Públicas (PNCP), Tribunal de Contas do Estado do Piauí (TCE-PI) e portais de transparência do governo.
+- **Total de tokens:** aproximadamente 1,49 bilhão.
+- **Conjunto de treino:** 9,7 milhões de amostras.
+- **Conjunto de validação:** 100 mil amostras.
+- **Pré-processamento aplicado:**
+  - Remoção de ruído estrutural (headers, URLs, assinaturas).
+  - Padronização de entidades como CNPJs, números, datas e e-mails.
+  - Normalização de vocabulário e unificação de sinônimos.
+  - Segmentação de sentenças com o NLTK.
 
-[More Information Needed]
+---
 
-#### Hardware
+## ⚙️ Configuração de Treinamento
 
-[More Information Needed]
+- **Épocas de pré-treinamento:** 6
+- **Batch total:** 128 (32 por etapa × 4 de accumulation)
+- **Max length por sequência:** 128 tokens
+- **Otimizador:** AdamW (β₁=0.9, β₂=0.999, ε=1e−6)
+- **Weight decay:** 0.01
+- **Taxa de aprendizado:** 1e-4
+- **Precisão:** FP16 (mixed precision)
+- **Tempo total de treinamento:** ~72 horas
+- **Hardware:** GPU Quadro RTX 4000 (8 GB)
 
-#### Software
+---
 
-[More Information Needed]
+## 📌 Aplicações Recomendadas
 
-## Citation [optional]
+### 🧩 Uso Direto (sem fine-tuning)
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+- Preenchimento de lacunas em textos jurídicos (MLM)
+- Geração de embeddings especializados para domínios públicos
+- Suporte a tarefas de recuperação de informação jurídica
 
-**BibTeX:**
+### 🏷️ Ajuste Fino (downstream tasks)
 
-[More Information Needed]
+- Classificação do tipo de objeto em editais de licitação
+- Detecção automática de indícios de fraude ou risco em contratações públicas
+- Análise de cláusulas contratuais e segmentação semântica
 
-**APA:**
+---
 
-[More Information Needed]
+## ❗ Limitações
 
-## Glossary [optional]
+- O modelo foi treinado exclusivamente com documentos do setor público, podendo apresentar viés ao ser aplicado fora desse domínio (como contratos privados ou sentenças judiciais).
+- Linguagem com forte padrão normativo e técnico pode dificultar a generalização para contextos mais informais.
+- Restrições computacionais limitaram o número de épocas e a variedade de batch sizes testados.
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+---
 
-[More Information Needed]
+## 🌱 Impacto Ambiental
 
-## More Information [optional]
+Estimativas aproximadas baseadas na ferramenta [Machine Learning CO2 Impact](https://mlco2.github.io/impact#compute):
 
-[More Information Needed]
+- **Tipo de hardware:** GPU Quadro RTX 4000 (8GB)
+- **Tempo de uso:** ~72 horas
+- **Região de computação:** Local (Brasil)
+- **Emissão estimada de CO₂eq:** ~21.6 kg
 
-## Model Card Authors [optional]
+---
 
-[More Information Needed]
+<!-- ## 📜 Citação
 
-## Model Card Contact
+Se este modelo for útil para você, por favor, cite da seguinte forma:
 
-[More Information Needed]
+```bibtex
+@misc{ribeiro2025helbert,
+  title={HelBERT: Um Modelo de Linguagem pré-treinado para o domínio de Contratações Públicas},
+  author={Victor Ribeiro da Silva and Ricardo de Andrade Lira Rabelo},
+  year={2025},
+  howpublished={\url{https://huggingface.co/seu-usuario/helbert}}
+} -->