Update README.md

README.md

@@ -44,21 +44,60 @@ model-index:
 pipeline_tag: token-classification
 ---
 
-## NER model for sensitive data in the legal domain in Portuguese according to LGPD (Brazilian General Data Protection Law)
-
-**legal-bert-lgpd** is a NER model (token classification) in the legal domain in Portuguese that classifies the tokens into the following classes:
-
-| Labels   |
-| -------- |
-| NOME     |     |
-| ENDERECO |
-| CEP      |
-| CPF      |
-| TELEFONE |
-| EMAIL    |
-| RELIGIAO |
-|ORIENTACAO_SEXUAL|
-| RACA_ETNIA |
+# NER-SPD: Modelo de Reconhecimento de Dados Pessoais Sensíveis no Domínio Jurídico Brasileiro (LGPD)
+
+## Descrição do Modelo
+
+O **NER-SPD** (*Named Entity Recognition for Sensitive Personal Data*) é um modelo de Reconhecimento de Entidades Nomeadas (NER) baseado na arquitetura BERT [1], especializado para o domínio jurídico brasileiro. Sua principal função é identificar e classificar automaticamente dados pessoais, com ênfase em **dados pessoais sensíveis**, conforme definido pela Lei Geral de Proteção de Dados (LGPD) [2, 3].
+
+Este modelo é um dos resultados da dissertação de mestrado "NER-SPD: Uma Abordagem de Fine-Tuning de Modelos BERT para Reconhecimento de Dados Pessoais Sensíveis em Textos Jurídicos à Luz da LGPD" [4]. Foi desenvolvido através de uma metodologia híbrida que combina *fine-tuning*, *data augmentation* e engenharia de prompts para superar a escassez de dados jurídicos rotulados [5]. O objetivo é fornecer uma ferramenta de alta performance e computacionalmente viável para auxiliar organizações na conformidade com a LGPD [6].
+
+O modelo foi treinado em um dataset híbrido composto por **103 documentos jurídicos reais** e **9.979 textos sintéticos** gerados automaticamente, garantindo uma cobertura ampla e contextualizada das entidades-alvo [5, 7].
+
+Por motivos de privcidade de complaince com a LGPD não foram incluídos na pasta dataset os arquivos de documento reias uma vez que apesar de serem textos coletatos de processos sem segredo de justiça, este estudo não deseja exposição desnecessária de dados pessoais.
+
+## Entidades Reconhecidas
+
+O `ner-spd` foi treinado para classificar tokens nas seguintes nove categorias. As entidades marcadas com `(Dado Sensível)` recebem proteção especial sob a LGPD [8, 9].
+
+*   `NOME`: Nomes completos de pessoas físicas.
+*   `CPF`: Números do Cadastro de Pessoas Físicas.
+*   `ENDERECO`: Endereços postais completos ou parciais.
+*   `CEP`: Códigos de Endereçamento Postal.
+*   `TELEFONE`: Números de telefone.
+*   `EMAIL`: Endereços de correio eletrônico.
+*   `RELIGIAO` **(Dado Sensível)**: Convicções religiosas.
+*   `RACA_ETNIA` **(Dado Sensível)**: Origem racial ou étnica.
+*   `ORIENTACAO_SEXUAL` **(Dado Sensível)**: Orientação sexual.
+
+## Desempenho do Modelo
+
+O modelo alcançou um **F1-Score médio de 96,4%** no conjunto de teste. A performance para dados sensíveis foi particularmente robusta, validando a eficácia da metodologia de treinamento especializado [10]:
+
+| Entidade            | F1-Score |
+| ------------------- | :------: |
+| **RELIGIAO**        | 99.51%   |
+| **RACA_ETNIA**      | 98.02%   |
+| **ORIENTACAO_SEXUAL** | 94.93%   |
+| CPF                 | 98.96%   |
+| EMAIL               | 96.02%   |
+| NOME                | 94.99%   |
+| CEP                 | 89.76%   |
+| ENDERECO            | 83.51%   |
+| TELEFONE            | 56.35%   |
+
+*(Resultados obtidos com divisão simples 80/20 do dataset) *
+
+Uma característica fundamental do modelo é sua **capacidade contextual**, herdada da arquitetura Transformer. Ele consegue discernir quando uma palavra potencialmente sensível (ex: "gay", "espírita") é usada para descrever um evento ou local, em vez de um dado pessoal, evitando falsos positivos [13, 14].
+
+## Uso Pretendido
+
+Este modelo destina-se a desenvolvedores, advogados, profissionais de proteção de dados e pesquisadores que trabalham com textos jurídicos em português. Suas principais aplicações incluem:
+
+*   **Anonimização e Pseudonimização**: Automatizar a ocultação de dados pessoais e sensíveis em documentos para conformidade com a LGPD.
+*   **Análise de Documentos**: Identificar rapidamente a presença e a localização de informações sensíveis em grandes volumes de textos.
+*   **Data Discovery**: Mapear a ocorrência de dados pessoais em sistemas e bases de dados não estruturadas.
+
 
 ## Usage
 
@@ -266,4 +305,15 @@ gr.Interface(
   Instantaneous batch size per device = 8
   Total train batch size (w. parallel, distributed & accumulation) = 8
   Number of trainable parameters =  103.950
-```
+```
+
+## Citation
+
+Citação
+Se você utilizar este modelo ou a metodologia em sua pesquisa, por favor, cite a dissertação original:
+@mastersthesis{brito2025ner-spd,
+  title={{NER-SPD}: Uma Abordagem de Fine-Tuning de Modelos {BERT} para Reconhecimento de Dados Pessoais Sens{\'i}veis em Textos Jur{\'i}dicos {\`a} Luz da {LGPD}},
+  author={Brito, Alan Pinheiro},
+  school={Centro de Estudos e Sistemas Avan{\c{c}}ados do Recife (CESAR)},
+  year={2025}
+}