A Ferramenta

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 interface online foram treinados de forma binária, ou seja, é possível detectar as disfluências mas não o seu tipo.

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.

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.

Como instalar

Antes de tudo, sugerimos a criação um ambiente virtual com virtualenv. Após criar e ativar o seu ambiente virtual, clone o repositório e entre no diretório: 
git clone https://github.com/mtreviso/deepbond.git
cd deepbond/
Instale as dependências usando pip: 
pip install -r requirements.txt
Após instalar com sucesso as dependências basta rodar o comando de instalação do pacote: 
python3 setup.py install
Observação: assegure-se que todos os comandos acima (pip e python) se referenciem a versão 3 do Python.

Como usar

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.

Os recursos necessários devem extraídos e colocados no diretório data/ (crie-o caso não exista) resources.zip:

mkdir data
wget -c http://fw.nilc.icmc.usp.br:23680/files/resources.zip
unzip resources.zip
mv resources/* data/

Alternativamente, você pode baixar cada recurso separadamente aqui.

Faça o import dos detectores de cada tarefa:

from deepbond.task import SentenceBoundaryDetector, FillerDetector, EditDisfDetector

Instancie e faça o load do modelo treinado (e.g. para detectar limites de sentenças): 

sbd = SentenceBoundaryDetector(l_model='rcnn')
sbd.set_model_id('SENTENCE_BOUNDARY_MODEL_FOR_CINDERELA')

Rode o detector para obter as predições binárias:

preds = sbd.detect(texts=['isso é um texto de exemplo', 'esse é outro texto de exemplo'])

preds irá conter uma lista de predições para cada texto de exemplo.

Aplicando todas as tarefas em conjunto:

Importe o submódulo Pipeline: 
from deepbond import Pipeline
E instancie/carregue os detectores de cada tarefa: 
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')
E então passe eles como parâmetros e rode o Pipeline: 
p = Pipeline(sbd, fd, edd)
preds = p.fit(texts=['isso é um texto de exemplo', 'esse é outro texto de exemplo'])

Como treinar um modelo

Você pode importar a ferramenta como nesse exemplo, ou rodá-la de modo stand-alone passando argumentos para a configuração do treinamento: 
python3 -m deepbond --id YOUR_MODEL_ID --dataset-dir path/to/dataset
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 YOUR_MODEL_ID no diretório data/models/, sobreescrevendo modelos já salvos. Os seguintes argumentos podem ser passados para alterar configurações do treinamento:

Option Default Description
-h --help Show this help message and exit
--id Name of configuration file in configs/ folder (required)
--task ss Select the desired task:
ss for sentence boundaries
dd_fillers for fillers
dd_editdisfs for edit disfluencies
--models rcnn rcnn A model for lexical info and another model for prosodic info. Options are: rcnn, rcnn_crf, cnn, rnn, mlp, crf, none. Set none for not use a model
-l --load None Load a trained model for the specified id
-s --save None Save the trained model for the specified id
--gpu Run on GPU instead of on CPU
--model-dir data/models/:id: Directory to save/load data, model, log, etc.
--save-predictions Path to save train and validation predictions in data/saves/
--window-size 7 Size of the sliding window
--split-ratio 0.6 Ratio [0,1] to split the dataset into train/test
--train-strategy bucket Strategy for training: bucket, window, padding, dicted
--epochs 20 Number of epochs
--batch-size 32 Size of data batches
--kfold 5 Number of folds to evaluate the model
--val-split 0.0 Ratio [0,1] to split the train dataset into train/validation (if 0 then alpha will be calculated using training data)
--dataset One of: constituicao, constituicao_mini, pucrs_usp, pucrs_constituicao, controle, ccl, da
--dataset-dir Path to a corpus directory where each file is a sample
--extra-data Add extra dataset as extension for training
--pos-type nlpnet Tagger used POS features: nlpnet or pickled tagger
--pos-file data/resource/pos-pt/ Path to pos tagger (can be a pickled object) resources
--without-pos Do not use POS features
--emb-type word2vec Method used to induce embeddings: word2vec/wang2vec/fasttext/glove/fonseca
--emb-file Path to a binary embedding model file
--without-emb Do not use embeddings
--use-handcrafted Use handcrafted features (useful for detecting edit disfluencies)
--prosodic-type principal Method used for select phones of a word: principal or padding
--prosodic-classify Classify prosodic info according to consonants