Rafaelvieira432 commited on
Commit
d0f66d3
·
verified ·
1 Parent(s): cdf01bc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +118 -39
README.md CHANGED
@@ -2,65 +2,144 @@
2
  library_name: transformers
3
  license: apache-2.0
4
  base_model: Comunidade-Synapse-BR/Synapse-Guard-v1
 
5
  language:
6
- - pt
 
7
  pipeline_tag: text-classification
 
8
  tags:
9
- - portuguese
10
- - text-classification
11
- - spam-detection
12
- - toxicity-detection
13
- - adult-content
14
- - lightweight
15
- - bert
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ---
17
 
18
- # Synapse-Guard-v1.1
19
 
20
- Synapse-Guard-v1.1 is a lightweight Portuguese text classification model developed by Comunidade Synapse BR.
21
 
22
- It classifies text into four categories:
23
 
24
- - neutro
25
- - spam
26
- - toxico
27
- - adulto
28
 
29
- This version is a fine-tuned improvement over Synapse-Guard-v1 using a larger and corrected training dataset.
30
 
31
- ## Labels
32
 
33
- - neutro
34
- - spam
35
- - toxico
36
- - adulto
37
 
38
- ## Training
 
 
 
 
39
 
40
- - Base model: Synapse-Guard-v1
41
- - Language: Portuguese
42
- - Training examples: ~365,000
43
- - Validation examples: 50,000
44
 
45
- ## Evaluation
 
 
46
 
47
- During training, the model achieved near-perfect results on the validation split used for fine-tuning.
48
 
49
- External manual evaluations with unseen sentences produced lower scores, indicating that real-world performance depends on the similarity between the input data and the training distribution.
50
 
51
- ## Intended use
52
 
53
- - Spam detection
54
- - Toxic content moderation
55
- - Adult content filtering
56
- - Lightweight on-device inference
57
 
58
- ## License
59
 
60
- Apache-2.0
 
 
61
 
62
- ## Disclaimer
63
 
64
- This model is provided for research and development purposes.
65
 
66
- The authors are not responsible for decisions or actions taken based on the model's predictions. Users are responsible for validating the model for their own applications.
 
2
  library_name: transformers
3
  license: apache-2.0
4
  base_model: Comunidade-Synapse-BR/Synapse-Guard-v1
5
+
6
  language:
7
+ - pt
8
+
9
  pipeline_tag: text-classification
10
+
11
  tags:
12
+ - bert
13
+ - portuguese
14
+ - pt-br
15
+ - text-classification
16
+ - content-moderation
17
+ - spam-detection
18
+ - toxicity-detection
19
+ - adult-content
20
+ - lightweight
21
+ ---
22
+
23
+ # 🛡️ Synapse-Guard v1.1
24
+
25
+ O **Synapse-Guard v1.1** é um modelo leve baseado em **BERT** para classificação de conteúdo em português brasileiro, desenvolvido pela **Comunidade Synapse BR**.
26
+
27
+ Esta versão representa uma evolução do **Synapse-Guard v1**, sendo refinada com um conjunto de treinamento maior e revisado para melhorar a qualidade da classificação.
28
+
29
+ O modelo foi desenvolvido para aplicações de moderação automática de conteúdo, oferecendo inferência rápida e baixo consumo de recursos.
30
+
31
+ > **Importante:** este modelo **não gera conteúdo**. Ele apenas classifica textos em categorias de moderação.
32
+
33
+ ---
34
+
35
+ # 📖 Visão Geral
36
+
37
+ O Synapse-Guard v1.1 foi projetado para auxiliar sistemas de moderação automática na identificação de conteúdos potencialmente inadequados.
38
+
39
+ O foco desta versão foi melhorar a qualidade do treinamento mantendo uma arquitetura leve, adequada para aplicações em produção.
40
+
41
+ ---
42
+
43
+ # 🏷️ Classes
44
+
45
+ | Classe | Descrição |
46
+ |--------|-----------|
47
+ | 🟢 Neutro | Conversas comuns e conteúdo considerado seguro. |
48
+ | 📢 Spam | Publicidade abusiva, golpes, phishing e mensagens promocionais. |
49
+ | 🔴 Tóxico | Linguagem ofensiva, insultos e conteúdo abusivo. |
50
+ | 🔞 Adulto | Conteúdo sexual explícito ou voltado ao público adulto. |
51
+
52
+ ---
53
+
54
+ # 🎯 Casos de Uso
55
+
56
+ O modelo é indicado para:
57
+
58
+ - Moderação automática
59
+ - Chatbots
60
+ - Assistentes de IA
61
+ - Redes sociais
62
+ - Fóruns
63
+ - Sistemas de comentários
64
+ - Detecção de spam
65
+ - Filtragem de conteúdo adulto
66
+ - Aplicações embarcadas com recursos limitados
67
+
68
+ ---
69
+
70
+ # 🏋️ Treinamento
71
+
72
+ Esta versão foi refinada a partir do:
73
+
74
+ - **Modelo base:** Synapse-Guard v1
75
+
76
+ Conjunto de treinamento:
77
+
78
+ - Aproximadamente **365.000 exemplos**
79
+ - Aproximadamente **50.000 exemplos de validação**
80
+ - Textos em português brasileiro
81
+
82
+ ---
83
+
84
+ # ⚡ Exemplo de Uso
85
+
86
+ ```python
87
+ from transformers import pipeline
88
+
89
+ classifier = pipeline(
90
+ "text-classification",
91
+ model="Comunidade-Synapse-BR/Synapse-Guard-v1.1"
92
+ )
93
+
94
+ resultado = classifier("Você é um idiota.")
95
+
96
+ print(resultado)
97
+ ```
98
+
99
  ---
100
 
101
+ # 📊 Avaliação
102
 
103
+ Durante o treinamento, o modelo apresentou excelente desempenho no conjunto de validação utilizado durante o fine-tuning.
104
 
105
+ Entretanto, avaliações realizadas com exemplos inéditos mostraram que o desempenho pode variar conforme o domínio, estilo de escrita e distribuição dos dados de entrada.
106
 
107
+ Como qualquer modelo supervisionado, sua qualidade depende da semelhança entre os dados utilizados em produção e aqueles presentes durante o treinamento.
 
 
 
108
 
109
+ ---
110
 
111
+ # ⚠️ Limitações
112
 
113
+ Embora apresente bom desempenho para moderação de conteúdo em português, o modelo pode apresentar dificuldades em situações como:
 
 
 
114
 
115
+ - Ironias
116
+ - Sarcasmo
117
+ - Conteúdo ambíguo
118
+ - Textos muito curtos
119
+ - Mensagens que dependem fortemente do contexto
120
 
121
+ Para aplicações críticas, recomenda-se utilizar revisão humana como camada adicional de segurança.
 
 
 
122
 
123
+ ---
124
+
125
+ # 📜 Licença
126
 
127
+ Este modelo é distribuído sob a licença **Apache License 2.0**.
128
 
129
+ Consulte o repositório para informações adicionais.
130
 
131
+ ---
132
 
133
+ # ⚖️ Aviso
 
 
 
134
 
135
+ Este modelo foi desenvolvido para pesquisa, desenvolvimento e integração em aplicações de moderação de conteúdo.
136
 
137
+ As previsões do modelo não devem ser consideradas decisões definitivas. Os desenvolvedores são responsáveis por validar seu desempenho antes da utilização em ambientes de produção.
138
+
139
+ ---
140
 
141
+ # 🤝 Sobre a Comunidade Synapse BR
142
 
143
+ A **Comunidade Synapse BR** é uma iniciativa brasileira dedicada ao desenvolvimento de modelos de inteligência artificial, datasets e ferramentas de código aberto para a comunidade de língua portuguesa.
144
 
145
+ Nossa missão é tornar a inteligência artificial mais acessível por meio de soluções leves, eficientes e abertas, contribuindo para fortalecer o ecossistema brasileiro de IA.