API Reference

Python API documentation.

The recommended way to use pstrain programmatically is via the pstrain.api module, which provides all public functions for project setup, validation, model creation, and training workflows.

• Library API
  • Public API
  • Project Setup
  • Project Validation
  • Configuration
  • Data Structures
  • Models
  • Native Worker
  • Guarded Logmath Wrapper
• Alignment API
  • AlignmentCoverage
  • align_corpus()
  • alignment_coverage()
  • collect_phone_report()
  • load_transcripts()
  • save_ctm()
  • save_textgrid()
• Checkpoint recovery API
  • list_checkpoints()
  • restore_checkpoint()
• Configuration API
  • generate_markdown_docs()
  • generate_rst_docs()
  • get_schema()
  • get_user_config()
  • list_parameters()
  • list_profiles()
  • migrate_project()
  • resolve_config()
  • CURRENT_CONFIG_VERSION
  • User settings
• Corpus API
  • split_is_external()
  • train_test_split()
  • validate_external_split()
• Diagnostics API
  • fp_contract_policy()
  • learning_curves()
  • load_bw_telemetry()
  • native_library_available()
  • resolve_binary()
  • PSTRAIN_BINARIES
• Dictionary API
  • default_cmudict_cache()
  • fetch_cmudict()
  • CMUDictSource
• Language model API
  • build_lm()
  • build_lm_from_file()
  • load_transcripts()
• One-command Training API
  • PromptFormatError
  • identity_difference()
  • input_identity()
  • installed_corpus_identity()
  • validate_inputs()
  • write_training_transcription()
  • write_validation_reports()
  • PROMPT_FORMATS
• Packaging API
  • create_noisedict()
  • package_model()
  • validate_package_destination()
• Pipeline API
  • PipelineContext
  • UnknownTargetError
  • build_pipeline()
  • create_pipeline_context()
  • run_pipeline()
  • TARGETS
  • DEFAULT_TARGET
  • DEFAULT_CONFIGS
• Training Steps API
  • CDHMMUntiedStep
  • CIHMMStep
  • FeaturesStep
  • Step
  • StepContext
  • StepDefinition
  • run_build_lm()
  • run_step_cd_hmm_untied()
  • run_step_ci_hmm()
  • run_step_features()
  • step_cd_hmm_untied()
  • step_ci_hmm()
  • step_features()
  • features_step
  • ci_hmm_step
  • cd_hmm_untied_step
• Testing API
  • check_pocketsphinx()
  • create_report()
  • load_transcripts()
  • test_model()
• Timings API
  • format_summary()
  • load_document()
• Tutorial API
  • copy_tutorial()
  • TUTORIAL_FILENAME
• CLI API
  • JSON output
• Data Utilities
  • get_data_file()
  • get_data_path()
  • get_sample_audio()
  • get_sample_file()
  • get_sample_path()
  • get_sample_transcript()
• Configuration Reference
  • alignment
  • description
  • features
  • runner
  • sharding
  • split
  • training