MfaModel#

class montreal_forced_aligner.abc.MfaModel[source]#

Bases: ABC

Abstract class for MFA models

abstract add_meta_file(trainer)[source]#

Add metadata to the model

abstract classmethod generate_path(root, name, enforce_existence=True)[source]#

Generate a path from a root directory

classmethod get_available_models()[source]#

Get a list of available models for a given model type

Returns:

List of model names

Return type:

list[str]

classmethod get_pretrained_path(name, enforce_existence=True)[source]#

Generate a path to a pretrained model based on its name and model type

Parameters:

  • name (str) – Name of model

  • enforce_existence (bool) – Flag to return None if the path doesn’t exist, defaults to True

Returns:

Path to model

Return type:

Path

abstract property meta#

Metadata for the model

classmethod pretrained_directory()[source]#

Directory that pretrained models are saved in

abstract pretty_print()[source]#

Print the model’s meta data

abstract classmethod valid_extension(filename)[source]#

Check whether a file has a valid extensions