User Guide
API Reference
CDModel
CIModel
CMUDict
CMUDictSource
Dictionary
FeatureConfig
FileType
Model
ModelCompareResult
Phoneset
Profile
PstrainPaths
TrainingConfig
TutorialExistsError
TutorialResult
ValidationReport
build_lm()
build_lm_from_file()
compare_auto()
compare_features()
compare_gaussians()
compare_mixw()
compare_models()
compare_tmat()
copy_tutorial()
create_model()
default_cmudict_cache()
describe_file()
detect_file_type()
extract_features()
fetch_cmudict()
get_fileids()
get_model_class()
get_paths()
init_flat_model()
package_model()
parse_transcription_file()
print_stats()
resolve_config()
run_build_lm()
run_step_cd_hmm_untied()
run_step_ci_hmm()
run_step_features()
setup_project()
step_cd_hmm_untied()
step_ci_hmm()
step_features()
strip_dictionary_stress()
strip_stress()
validate_file_type()
validate_package_destination()
validate_project()
TUTORIAL_FILENAME
AlignmentCoverage
AlignmentCoverage.__init__()
AlignmentCoverage.format()
AlignmentCoverage.lost_phones
AlignmentCoverage.lost_triphones
AlignmentCoverage.n_duration_unknown
AlignmentCoverage.n_flags
AlignmentCoverage.outcomes
AlignmentCoverage.phone_carriers
AlignmentCoverage.phones
AlignmentCoverage.phones_from_alignment
AlignmentCoverage.retry_only_phones
AlignmentCoverage.retry_only_triphones
AlignmentCoverage.run_failure_rate
AlignmentCoverage.seconds
AlignmentCoverage.speakers
AlignmentCoverage.speakers_without_aligned_audio
AlignmentCoverage.thin_min_carriers
AlignmentCoverage.thin_phones
AlignmentCoverage.thin_rate_ratio
AlignmentCoverage.thin_tokens
AlignmentCoverage.to_dict()
AlignmentCoverage.triphones
AlignmentCoverage.unexpanded_words
AlignmentCoverage.utterances
align_corpus()
alignment_coverage()
collect_phone_report()
load_transcripts()
save_ctm()
save_textgrid()
list_checkpoints()
restore_checkpoint()
generate_markdown_docs()
generate_rst_docs()
get_schema()
get_user_config()
list_parameters()
list_profiles()
migrate_project()
CURRENT_CONFIG_VERSION
split_is_external()
train_test_split()
validate_external_split()
fp_contract_policy()
learning_curves()
load_bw_telemetry()
native_library_available()
resolve_binary()
PSTRAIN_BINARIES
PromptFormatError
identity_difference()
input_identity()
installed_corpus_identity()
validate_inputs()
write_training_transcription()
write_validation_reports()
PROMPT_FORMATS
create_noisedict()
PipelineContext
PipelineContext.__init__()
PipelineContext.all_fileids()
PipelineContext.all_transcription
PipelineContext.architecture_dir
PipelineContext.audio_dir
PipelineContext.audio_fileids()
PipelineContext.config_name
PipelineContext.description
PipelineContext.dist_dir
PipelineContext.etc_dir
PipelineContext.experiment
PipelineContext.experiment_dir
PipelineContext.feat
PipelineContext.features_dir
PipelineContext.filler_dict
PipelineContext.filler_dict_path
PipelineContext.fingerprint_payload()
PipelineContext.from_config()
PipelineContext.lm_dir
PipelineContext.model_dir()
PipelineContext.model_files()
PipelineContext.models_dir
PipelineContext.project_dir
PipelineContext.provenance_document()
PipelineContext.provenance_path()
PipelineContext.provenance_payload()
PipelineContext.read_fileids()
PipelineContext.reports_dir
PipelineContext.resolved_config
PipelineContext.runner
PipelineContext.sharding
PipelineContext.shared_dir
PipelineContext.split
PipelineContext.train
PipelineContext.trees_dir
PipelineContext.validate_training_features()
UnknownTargetError
build_pipeline()
create_pipeline_context()
run_pipeline()
TARGETS
DEFAULT_TARGET
DEFAULT_CONFIGS
CDHMMUntiedStep
CDHMMUntiedStep.add_arguments()
CDHMMUntiedStep.default_params
CDHMMUntiedStep.description
CDHMMUntiedStep.execute()
CDHMMUntiedStep.get_inputs()
CDHMMUntiedStep.get_outputs()
CDHMMUntiedStep.name
CDHMMUntiedStep.script
CIHMMStep
CIHMMStep.add_arguments()
CIHMMStep.default_params
CIHMMStep.description
CIHMMStep.execute()
CIHMMStep.get_inputs()
CIHMMStep.get_outputs()
CIHMMStep.get_params_from_args()
CIHMMStep.name
CIHMMStep.script
FeaturesStep
FeaturesStep.add_arguments()
FeaturesStep.default_params
FeaturesStep.description
FeaturesStep.execute()
FeaturesStep.get_inputs()
FeaturesStep.get_outputs()
FeaturesStep.name
FeaturesStep.script
Step
Step.add_arguments()
Step.default_params
Step.description
Step.execute()
Step.get_definition()
Step.get_inputs()
Step.get_outputs()
Step.get_params()
Step.get_params_from_args()
Step.main()
Step.name
Step.run()
Step.script
Step.to_dict()
StepContext
StepContext.__init__()
StepContext.blank()
StepContext.comment()
StepContext.config
StepContext.copy()
StepContext.dry_run
StepContext.etc_dir
StepContext.experiment
StepContext.experiment_dir
StepContext.flat_dir()
StepContext.hmm_dir()
StepContext.log()
StepContext.log_comment()
StepContext.mkdir()
StepContext.model_dir()
StepContext.project_dir
StepContext.run_cmd()
StepContext.shared_dir
StepContext.symlink()
StepDefinition
StepDefinition.__init__()
StepDefinition.description
StepDefinition.inputs
StepDefinition.name
StepDefinition.outputs
StepDefinition.params
StepDefinition.script
features_step
ci_hmm_step
cd_hmm_untied_step
check_pocketsphinx()
create_report()
test_model()
format_summary()
load_document()
Command
CommandContext
CommandResult
ModelCommand
ProjectCommand
main()
get_data_file()
get_data_path()
get_sample_audio()
get_sample_file()
get_sample_path()
get_sample_transcript()
Design Notes
steps/train.py
steps/split.py
steps/cd_untied.py
steps/trees.py
steps/tiestate.py
contained-all-operations
etc/all.transcription
shared/dictionary.dict
shared/phoneset.txt
Benchmarks and Evidence
Contributing
Package data access utilities.
Return the path to a specific data file.
name (str)
Path
Return the path to the package data directory.
Return the path to the sample audio file.
Return the path to a specific sample file.
Return the path to the sample data directory.
Return the path to the sample transcript file.