Create segments (mfa create_segments)#

The Montreal Forced Aligner can use Voice Activity Detection (VAD) capabilities from SpeechBrain to generate segments from a longer sound file.

Note

On Windows, if you get an OSError/WinError 1314 during the run, follow these instructions to enable symbolic link creation permissions.

Command reference#

mfa create_segments#

Create segments based on SpeechBrain’s voice activity detection (VAD) model or a basic energy-based algorithm

mfa create_segments [OPTIONS] CORPUS_DIRECTORY OUTPUT_DIRECTORY

Options

-c, --config_path <config_path>#

Path to config file to use for training.

--output_format <output_format>#

Format for aligned output files (default is long_textgrid).

Options:

long_textgrid | short_textgrid | json | csv

--speechbrain, --no_speechbrain#

Flag for using SpeechBrain’s pretrained VAD model

--cuda, --no_cuda#

Flag for using CUDA for SpeechBrain’s model

-p, --profile <profile>#

Configuration profile to use, defaults to “global”

-t, --temporary_directory <temporary_directory>#

Set the default temporary directory, default is /home/docs/Documents/MFA

-j, --num_jobs <num_jobs>#

Set the number of processes to use by default, defaults to 3

--clean, --no_clean#

Remove files from previous runs, default is False

-v, --verbose, -nv, --no_verbose#

Output debug messages, default is False

-q, --quiet, -nq, --no_quiet#

Suppress all output messages (overrides verbose), default is False

--overwrite, --no_overwrite#

Overwrite output files when they exist, default is False

--use_mp, --no_use_mp#

Turn on/off multiprocessing. Multiprocessing is recommended will allow for faster executions.

-d, --debug, -nd, --no_debug#

Run extra steps for debugging issues, default is False

--use_postgres, --no_use_postgres#

Use postgres instead of sqlite for extra functionality, default is False

--single_speaker#

Single speaker mode creates multiprocessing splits based on utterances rather than speakers.

--textgrid_cleanup, --no_textgrid_cleanup#

Turn on/off post-processing of TextGrids that cleans up silences and recombines compound words and clitics.

-h, --help#

Show this message and exit.

Arguments

CORPUS_DIRECTORY#

Required argument

OUTPUT_DIRECTORY#

Required argument

Configuration reference#

API reference#