-
Notifications
You must be signed in to change notification settings - Fork 2
/
ferramenta.html
344 lines (273 loc) · 11.8 KB
/
ferramenta.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!DOCTYPE html>
<html lang="pt-br">
<head>
<meta charset="UTF-8">
<title>DeepBond by mtreviso</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="shortcut icon" type="image/x-icon" href="favicons/favicon.ico">
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section id="page-header" class="page-header">
<div id="bg-header"></div>
<canvas id="demo-canvas"></canvas>
<div class="main-title">
<h1 class="project-name"><span><a href="index.html">DeepBonDD</a></span></h1>
<!-- <h2 class="project-tagline">Sentence Boundary Detection using Deep Learning</h2> -->
<h2 class="project-tagline">Deep neural approach to Boundary and Disfluency Detection</h2>
<!-- <a href="https://github.com/mtreviso/deepbond" class="btn">Ver no GitHub</a> -->
<div class="dropdown">
<a href="projeto.html" class="btn">O Projeto</a>
<div class="dropdown-content">
<a href="projeto.html#introducao">Introdução</a>
<a href="projeto.html#hipoteses">Hipóteses</a>
<a href="projeto.html#objetivos">Objetivos</a>
<a href="projeto.html#metodologia">Metodologia</a>
</div>
</div>
<div class="dropdown">
<a href="ferramenta.html" class="btn">A Ferramenta</a>
<div class="dropdown-content">
<a href="ferramenta.html#instalacao">Como instalar</a>
<a href="ferramenta.html#uso">Como usar</a>
<a href="ferramenta.html#treinamento">Como treinar um modelo</a>
</div>
</div>
<a href="recursos.html" class="btn">Recursos</a>
<a href="pesquisadores.html" class="btn">Pesquisadores</a>
<a href="publicacoes.html" class="btn">Publicações</a>
<a href="contato.html" class="btn">Contato</a>
</div>
</section>
<section class="main-content">
<h1>A Ferramenta</h1>
<p>
O DeepBonDD é uma ferramenta para recuperar limites de sentenças e detectar disfluências em transcrições de fala. O DeepBonDD foi originalmente criado para lidar com transcrições de fala de idosos com potenciais comprometimentos cognitivos. Em nosso córpus, os limites de sentenças foram anotados de forma binária, ou seja, não há distinção entre tipos de sinais de pontuação. Já as disfluências foram divididas em preenchimentos e disfluências de edição, categorizando cada uma em seus subtipos. Os modelos finais disponíveis na <a href="http://fw.nilc.icmc.usp.br:23680/" target="_blank">interface online</a> foram treinados de forma binária, ou seja, é possível detectar as disfluências mas não o seu tipo.
</p>
<p>
Entretanto, é possível expandir a ferramenta para lidar com qualquer tipo de textos e detectar qualquer tipo limite de sentença e disfluência desde que essas informações estejam anotadas no córpus de treinamento.
</p>
<p>
A ferramenta foi implementada puramente em Python (v3) com o objetivo de ser flexível para o treinamento de novos modelos. Veja abaixo as intruções de instalação e configuração.
</p>
<h2 id="instalacao">Como instalar</h2>
Antes de tudo, sugerimos a criação um ambiente virtual com <code>virtualenv</code>. Após criar e ativar o seu ambiente virtual, clone o repositório e entre no diretório:
<pre class="highlight">git clone https://github.com/mtreviso/deepbond.git
cd deepbond/</pre>
Instale as dependências usando <code>pip</code>:
<pre>pip install -r requirements.txt</pre>
Após instalar com sucesso as dependências basta rodar o comando de instalação do pacote:
<pre>python3 setup.py install</pre>
Observação: assegure-se que todos os comandos acima (<code>pip</code> e <code>python</code>) se referenciem a versão 3 do Python.
<h2 id="uso">Como usar</h2>
O DeepBonDD pode ser usado de duas maneiras diferentes. Como módulo e de maneira stand-alone (não é preciso rodar o comando de instalação anterior). Vejamos primeiramente como usá-lo como módulo.
<p>Os recursos necessários devem extraídos e colocados no diretório <code>data/</code> (crie-o caso não exista)
<a href="http://fw.nilc.icmc.usp.br:23680/files/resources.zip">resources.zip</a>:</p>
<pre>mkdir data
wget -c http://fw.nilc.icmc.usp.br:23680/files/resources.zip
unzip resources.zip
mv resources/* data/</pre>
<p>Alternativamente, você pode baixar cada recurso separadamente <a href="recursos.html">aqui</a>.</p>
<p>Faça o <i>import</i> dos detectores de cada tarefa:</p>
<pre>from deepbond.task import SentenceBoundaryDetector, FillerDetector, EditDisfDetector</pre>
<p>Instancie e faça o load do modelo treinado (e.g. para detectar limites de sentenças): </p>
<pre>sbd = SentenceBoundaryDetector(l_model='rcnn')
sbd.set_model_id('SENTENCE_BOUNDARY_MODEL_FOR_CINDERELA')</pre>
<p>Rode o detector para obter as predições binárias:</p>
<pre>preds = sbd.detect(texts=['isso é um texto de exemplo', 'esse é outro texto de exemplo'])</pre>
<p><code>preds</code> irá conter uma lista de predições para cada texto de exemplo.</p>
<h3>Aplicando todas as tarefas em conjunto: </h3>
Importe o submódulo <code>Pipeline:</code>
<pre>from deepbond import Pipeline</pre>
E instancie/carregue os detectores de cada tarefa:
<pre>sbd = SentenceBoundaryDetector(l_model='rcnn')
sbd.set_model_id('SENTENCE_BOUNDARY_MODEL_FOR_CINDERELA')
fd = FillerDetector(l_model='rcnn')
fd.set_model_id('FILLERS_MODEL_FOR_CINDERELA')
fd.restrict_wordset()
edd = EditDisfDetector(l_model='rcnn')
edd.set_model_id('EDITDISFS_MODEL_FOR_CINDERELA')</pre>
E então passe eles como parâmetros e rode o Pipeline:
<pre>p = Pipeline(sbd, fd, edd)
preds = p.fit(texts=['isso é um texto de exemplo', 'esse é outro texto de exemplo'])</pre>
<h2 id="treinamento">Como treinar um modelo</h2>
Você pode importar a ferramenta como <a href="https://github.com/mtreviso/deepbond/blob/master/example_train.py" target="_blank">nesse exemplo</a>, ou rodá-la de modo stand-alone passando argumentos para a configuração do treinamento:
<pre>python3 -m deepbond --id YOUR_MODEL_ID --dataset-dir path/to/dataset</pre>
O dataset precisa estar disposto através de arquivos em um diretório, onde cada arquivo é um exemplo de treinamento do dataset. Com isso, o DeepBonDD irá treinar um modelo e salvá-lo com o nome <code>YOUR_MODEL_ID</code> no diretório <code>data/models/</code>, sobreescrevendo modelos já salvos.
Os seguintes argumentos podem ser passados para alterar configurações do treinamento:
<br><br>
<table> <thead> <tr>
<th width="28%">Option</th>
<th width="14%">Default</th>
<th>Description</th>
</tr> </thead> <tbody>
<tr>
<td>
<code>-h</code> <code>--help</code>
</td>
<td></td>
<td>Show this help message and exit</td>
</tr>
<!-- general -->
<tr>
<td>
<code>--id</code>
</td>
<td></td>
<td>Name of configuration file in <code>configs/</code> folder (required)</td>
</tr>
<tr>
<td><code>--task</code></td>
<td><code>ss</code></td>
<td>Select the desired task:
<br><code>ss</code> for sentence boundaries
<br><code>dd_fillers</code> for fillers
<br><code>dd_editdisfs</code> for edit disfluencies</td>
</tr>
<tr>
<td><code>--models</code></td>
<td><code>rcnn rcnn</code></td>
<td>A model for lexical info and another model for prosodic info. Options are:
<code>rcnn, rcnn_crf, cnn, rnn, mlp, crf, none</code>. Set <code>none</code> for not use a model
</tr>
<!-- io -->
<tr>
<td><code>-l</code> <code>--load</code></td>
<td><code>None</code></td>
<td>Load a trained model for the specified <code>id</code></td>
</tr>
<tr>
<td><code>-s</code> <code>--save</code></td>
<td><code>None</code></td>
<td>Save the trained model for the specified <code>id</code></td>
</tr>
<tr>
<td><code>--gpu</code></td>
<td></td>
<td>Run on GPU instead of on CPU</td>
</tr>
<tr>
<td><code>--model-dir</code></td>
<td><code>data/models/:id:</code></td>
<td>Directory to save/load data, model, log, etc.</td>
</tr>
<tr>
<td><code>--save-predictions</code></td>
<td></td>
<td>Path to save train and validation predictions in <code>data/saves/</code></td>
</tr>
<!-- hyperparams -->
<tr>
<td><code>--window-size</code></td>
<td><code>7</code></td>
<td>Size of the sliding window</td>
</tr>
<tr>
<td><code>--split-ratio</code></td>
<td><code>0.6</code></td>
<td>Ratio [0,1] to split the dataset into train/test</td>
</tr>
<tr>
<td><code>--train-strategy</code></td>
<td><code>bucket</code></td>
<td>Strategy for training: <code>bucket, window, padding, dicted</code></td>
</tr>
<tr>
<td><code>--epochs</code></td>
<td><code>20</code></td>
<td>Number of epochs</td>
</tr>
<tr>
<td><code>--batch-size</code></td>
<td><code>32</code></td>
<td>Size of data batches</td>
</tr>
<tr>
<td><code>--kfold</code></td>
<td><code>5</code></td>
<td>Number of folds to evaluate the model</td>
</tr>
<tr>
<td><code>--val-split</code></td>
<td><code>0.0</code></td>
<td>Ratio [0,1] to split the train dataset into train/validation (if 0 then alpha will be calculated using training data)</td>
</tr>
<tr>
<td><code>--dataset</code></td>
<td></td>
<td>One of: <code>constituicao, constituicao_mini, pucrs_usp, pucrs_constituicao, controle, ccl, da</code><br></td>
</tr>
<tr>
<td><code>--dataset-dir</code></td>
<td></td>
<td>Path to a corpus directory where each file is a sample</td>
</tr>
<tr>
<td><code>--extra-data</code></td>
<td></td>
<td>Add extra dataset as extension for training</td>
</tr>
<!-- pos -->
<tr>
<td><code>--pos-type</code></td>
<td><code>nlpnet</code></td>
<td>Tagger used POS features: nlpnet or pickled tagger</td>
</tr>
<tr>
<td><code>--pos-file</code></td>
<td><code>data/resource/pos-pt/</code></td>
<td>Path to pos tagger (can be a pickled object) resources</td>
</tr>
<tr>
<td><code>--without-pos</code></td>
<td></td>
<td>Do not use POS features</td>
</tr>
<!-- embeddings -->
<tr>
<td><code>--emb-type</code></td>
<td><code>word2vec</code></td>
<td>Method used to induce embeddings: word2vec/wang2vec/fasttext/glove/fonseca</td>
</tr>
<tr>
<td><code>--emb-file</code></td>
<td></td>
<td>Path to a binary embedding model file</td>
</tr>
<tr>
<td><code>--without-emb</code></td>
<td></td>
<td>Do not use embeddings</td>
</tr>
<!-- handcrafted -->
<tr>
<td><code>--use-handcrafted</code></td>
<td></td>
<td>Use handcrafted features (useful for detecting edit disfluencies)</td>
</tr>
<!-- prosodic -->
<tr>
<td><code>--prosodic-type</code></td>
<td><code>principal</code></td>
<td>Method used for select phones of a word: <code>principal</code> or <code>padding</code></td>
</tr>
<tr>
<td><code>--prosodic-classify</code></td>
<td></td>
<td>Classify prosodic info according to consonants</td>
</tr>
</tbody>
</table>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/mtreviso/deepbond">DeepBond</a> is maintained by <a href="https://github.com/mtreviso">mtreviso</a>.</span>
<a href="http://icmc.usp.br/" title="Instituto de Ciências Matemáticas e de Computação (ICMC)" target="_blank"> <img src="img/icmc.png" border="0" height="42"> </a>
<a href="http://nilc.icmc.usp.br/" title="Núcleo Interinstitucional de Linguística Computacional (NILC)" target="_blank"> <img src="img/nilc.png" border="0" height="42"> </a>
<div class="cleaner"></div>
</footer>
</section>
<script src="js/animheader.js"></script>
</body>
</html>