The MIT License (MIT)
Copyright (c) 2017-2020 CNRS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
AUTHORS Ruiqing Yin Hervé Bredin - http://herve.niderb.fr
This tutorial assumes that you have already followed the data preparation tutorial, and teaches how to train, validate, and apply a speaker change detection neural network on the AMI dataset using pyannote-audio
command line tool. In particular, this should reproduce the result reported in second line of Table 2 of this introductory paper.
If you use pyannote-audio
for speaker change detection, please cite the following papers:
@inproceedings{Bredin2020,
Title = {{pyannote.audio: neural building blocks for speaker diarization}},
Author = {{Bredin}, Herv{\'e} and {Yin}, Ruiqing and {Coria}, Juan Manuel and {Gelly}, Gregory and {Korshunov}, Pavel and {Lavechin}, Marvin and {Fustes}, Diego and {Titeux}, Hadrien and {Bouaziz}, Wassim and {Gill}, Marie-Philippe},
Booktitle = {ICASSP 2020, IEEE International Conference on Acoustics, Speech, and Signal Processing},
Address = {Barcelona, Spain},
Month = {May},
Year = {2020},
}
@inproceedings{Yin2017,
Author = {Ruiqing Yin and Herv\'e Bredin and Claude Barras},
Title = {{Speaker Change Detection in Broadcast TV using Bidirectional Long Short-Term Memory Networks}},
Booktitle = {{Interspeech 2017, 18th Annual Conference of the International Speech Communication Association}},
Year = {2017},
Month = {August},
Address = {Stockholm, Sweden},
}
To ensure reproducibility, pyannote-audio
relies on a configuration file defining the experimental setup:
$ export EXP_DIR=tutorials/models/speaker_change_detection
$ cat ${EXP_DIR}/config.yml
# A speaker change detection model is trained.
# Here, training relies on 2s-long audio chunks,
# batches of 64 audio chunks, and saves model to
# disk every one (1) day worth of audio.
task:
name: SpeakerChangeDetection
params:
duration: 2.0
batch_size: 64
per_epoch: 1
# Data augmentation is applied during training.
# Here, it consists in additive noise from the
# MUSAN database, with random signal-to-noise
# ratio between 5 and 20 dB
data_augmentation:
name: AddNoise
params:
snr_min: 5
snr_max: 20
collection: MUSAN.Collection.BackgroundNoise
# Since we are training an end-to-end model, the
# feature extraction step simply returns the raw
# waveform.
feature_extraction:
name: RawAudio
params:
sample_rate: 16000
# We use the PyanNet architecture in Figure 2 of
# pyannote.audio introductory paper. More details
# about the architecture and its parameters can be
# found directly in PyanNet docstring.
architecture:
name: pyannote.audio.models.PyanNet
params:
rnn:
unit: LSTM
hidden_size: 128
num_layers: 2
bidirectional: True
ff:
hidden_size: [128, 128]
# We use a constant learning rate of 1e-2
scheduler:
name: ConstantScheduler
params:
learning_rate: 0.01
The following command will train the network using the training subset of AMI database for 1000 epochs:
$ pyannote-audio scd train --subset=train --to=1000 --parallel=4 ${EXP_DIR} AMI.SpeakerDiarization.MixHeadset
This will create a bunch of files in TRN_DIR
(defined below). One can also follow along the training process using tensorboard:
$ tensorboard --logdir=${EXP_DIR}
To get a quick idea of how the network is doing on the development set, one can use the validate
mode.
$ export TRN_DIR=${EXP_DIR}/train/AMI.SpeakerDiarization.MixHeadset.train
$ pyannote-audio scd validate --subset=development --from=200 --to=1000 --every=100 ${TRN_DIR} AMI.SpeakerDiarization.MixHeadset
It can be run while the model is still training and evaluates the model every 100 epochs. This will create a bunch of files in VAL_DIR
(defined below).
In practice, it is tuning a simple speaker change detection pipeline and stores the best hyper-parameter configuration on disk (i.e. the one that maximizes segmentation f-score):
$ export VAL_DIR = ${TRN_DIR}/validate_segmentation_fscore/AMI.SpeakerDiarization.MixHeadset.development
$ cat ${VAL_DIR}/params.yml
epoch: 700
params:
alpha: 0.14589803375031546
min_duration: 0.1
segmentation_fscore: 0.8749258217401696
See pyannote.audio.pipeline.speaker_change_detection.SpeakerChangeDetection
for details on the role of each parameter.
Now that we know how the model is doing, we can apply it on test files of the AMI database:
$ pyannote-audio scd apply --subset=test ${VAL_DIR} AMI.SpeakerDiarization.MixHeadset
Raw model output and speaker change detection results will be dumped into the following directory: ${VAL_DIR}/apply/{BEST_EPOCH}
.
For more options, see:
$ pyannote-audio --help
That's all folks!