Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,80 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
-
tags: []
|
4 |
---
|
5 |
|
6 |
-
# Model Card for
|
7 |
-
|
8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
9 |
-
|
10 |
-
|
11 |
|
12 |
## Model Details
|
13 |
|
14 |
### Model Description
|
15 |
|
16 |
-
|
17 |
|
18 |
-
|
19 |
-
|
20 |
-
- **
|
21 |
-
- **
|
22 |
-
- **
|
23 |
-
- **
|
24 |
-
- **
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
|
28 |
### Model Sources [optional]
|
29 |
|
30 |
-
|
|
|
|
|
31 |
|
32 |
-
|
33 |
-
- **Paper [optional]:** [More Information Needed]
|
34 |
-
- **Demo [optional]:** [More Information Needed]
|
35 |
|
36 |
## Uses
|
37 |
|
38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
39 |
-
|
40 |
### Direct Use
|
41 |
|
42 |
-
|
43 |
-
|
44 |
-
|
45 |
|
46 |
### Downstream Use [optional]
|
47 |
|
48 |
-
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
|
52 |
### Out-of-Scope Use
|
53 |
|
54 |
-
|
|
|
55 |
|
56 |
-
|
57 |
|
58 |
## Bias, Risks, and Limitations
|
59 |
|
60 |
-
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
|
64 |
### Recommendations
|
65 |
|
66 |
-
|
|
|
67 |
|
68 |
-
|
69 |
|
70 |
## How to Get Started with the Model
|
71 |
|
72 |
-
Use
|
73 |
-
|
74 |
-
[More Information Needed]
|
75 |
-
|
76 |
-
## Training Details
|
77 |
-
|
78 |
-
### Training Data
|
79 |
-
|
80 |
-
<!-- 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. -->
|
81 |
-
|
82 |
-
[More Information Needed]
|
83 |
-
|
84 |
-
### Training Procedure
|
85 |
-
|
86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
87 |
-
|
88 |
-
#### Preprocessing [optional]
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
96 |
-
|
97 |
-
#### Speeds, Sizes, Times [optional]
|
98 |
-
|
99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
100 |
-
|
101 |
-
[More Information Needed]
|
102 |
-
|
103 |
-
## Evaluation
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
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).
|
146 |
-
|
147 |
-
- **Hardware Type:** [More Information Needed]
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
-
|
153 |
-
## Technical Specifications [optional]
|
154 |
-
|
155 |
-
### Model Architecture and Objective
|
156 |
-
|
157 |
-
[More Information Needed]
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## More Information [optional]
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
|
193 |
-
|
|
|
194 |
|
195 |
-
|
|
|
|
|
196 |
|
197 |
-
|
|
|
|
|
|
|
|
|
198 |
|
199 |
-
|
|
|
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
+
tags: [text-classification, ModernBERT, customer-support, Portuguese]
|
4 |
---
|
5 |
|
6 |
+
# Model Card for ModernBERT Domain Classifier
|
|
|
|
|
|
|
|
|
7 |
|
8 |
## Model Details
|
9 |
|
10 |
### Model Description
|
11 |
|
12 |
+
Este modelo é baseado no `ModernBERT-base` e foi ajustado (fine-tuned) para realizar a classificação de textos em dois rótulos: "Transferir" e "Não transferir". Ele foi projetado para auxiliar sistemas de atendimento automatizado, ajudando a decidir se uma interação precisa ser transferida para um atendente humano.
|
13 |
|
14 |
+
- **Developed by:** Lailson Henrique
|
15 |
+
- **Funded by [optional]:**
|
16 |
+
- **Shared by [optional]:** Lailson Henrique
|
17 |
+
- **Model type:** Modelo de classificação de texto baseado em Transformers.
|
18 |
+
- **Language(s) (NLP):** Português.
|
19 |
+
- **License:** Apache 2.0
|
20 |
+
- **Finetuned from model [optional]:** `answerdotai/ModernBERT-base`
|
|
|
|
|
21 |
|
22 |
### Model Sources [optional]
|
23 |
|
24 |
+
- **Repository:**
|
25 |
+
- **Paper [optional]:**
|
26 |
+
- **Demo [optional]:**
|
27 |
|
28 |
+
---
|
|
|
|
|
29 |
|
30 |
## Uses
|
31 |
|
|
|
|
|
32 |
### Direct Use
|
33 |
|
34 |
+
Este modelo pode ser usado diretamente para classificar interações entre clientes e sistemas automatizados em dois rótulos:
|
35 |
+
- **Transferir**: Quando a interação deve ser encaminhada para um atendente humano.
|
36 |
+
- **Não transferir**: Quando o sistema automatizado pode lidar com a interação.
|
37 |
|
38 |
### Downstream Use [optional]
|
39 |
|
40 |
+
Pode ser integrado em sistemas de call centers ou atendimento por chat para otimizar a transferência para atendentes humanos.
|
|
|
|
|
41 |
|
42 |
### Out-of-Scope Use
|
43 |
|
44 |
+
- Não recomendado para uso fora do idioma português.
|
45 |
+
- Não adequado para sistemas críticos ou decisões sensíveis sem supervisão humana.
|
46 |
|
47 |
+
---
|
48 |
|
49 |
## Bias, Risks, and Limitations
|
50 |
|
51 |
+
- O modelo pode apresentar vieses baseados nos dados usados para treinamento.
|
52 |
+
- Não é garantido que o modelo funcione corretamente em textos ambíguos ou fora do domínio.
|
|
|
53 |
|
54 |
### Recommendations
|
55 |
|
56 |
+
- Realize testes rigorosos antes da implantação em produção.
|
57 |
+
- Supervisione manualmente interações críticas ou sensíveis.
|
58 |
|
59 |
+
---
|
60 |
|
61 |
## How to Get Started with the Model
|
62 |
|
63 |
+
Use o código abaixo para começar:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
64 |
|
65 |
+
```python
|
66 |
+
from transformers import AutoModelForSequenceClassification, AutoTokenizer
|
67 |
|
68 |
+
# Carregar o modelo
|
69 |
+
model = AutoModelForSequenceClassification.from_pretrained("seu-usuario/modernbert-domain-classifier")
|
70 |
+
tokenizer = AutoTokenizer.from_pretrained("seu-usuario/modernbert-domain-classifier")
|
71 |
|
72 |
+
# Fazer a predição
|
73 |
+
inputs = tokenizer("Preciso falar com um humano", return_tensors="pt")
|
74 |
+
outputs = model(**inputs)
|
75 |
+
logits = outputs.logits
|
76 |
+
predicted_class = logits.argmax().item()
|
77 |
|
78 |
+
# Mapear para os rótulos
|
79 |
+
label_map = {0: "Não transferir", 1: "Transferir"}
|
80 |
+
print(f"Predição: {label_map[predicted_class]}")
|