pltobing's picture
docs: refine aligner documentation
a3b146e
Raw History Blame Contribute Delete
5 kB
{
"schema_version": "speech-text-data-aligners/config.v1",
"project": {
"name": "speech-text-data-aligners",
"version": "0.1.0",
"package": "speech_text_data_aligners",
"python": ">=3.12",
"entrypoint": "speech-text-aligners",
"license": "Apache-2.0",
"task": "forced-alignment",
"languages": [
"en"
],
"author": "Patrick Lumbantobing, VertoX-AI",
"repository": "https://huggingface.co/vertox-ai/speech-text-data-aligners"
},
"data_contract": {
"transcript_column": "en_transcript",
"source_columns": [
"line_id",
"audio_id",
"en_transcript",
"ru_translation"
],
"audio_path_template": "<audio_dir>/<audio_id>.wav",
"alignment_columns": [
"first_word_text",
"first_word_start_s",
"first_word_end_s",
"last_word_text",
"last_word_start_s",
"last_word_end_s"
],
"timestamp_unit": "seconds",
"authoritative_transcript": true
},
"backend_registry": {
"operational_selection": "mfa",
"models": {
"mfa": {
"selected": true,
"config_class": "speech_text_data_aligners.backends.mfa.config.MfaConfig",
"runtime": {
"package": "montreal-forced-aligner",
"version": "3.4.2",
"source_revision": "d2dc283bd79667e086b1f93050a1855349f63f1f",
"kaldi_version": "5.5.1172",
"kalpy_version": "0.10.5",
"openfst_version": "1.8.4"
},
"model": {
"id": "MontrealCorpusTools/english_mfa",
"revision": "1009e3c6c689f10875146a5e4e5c2233f8eaf922",
"version": "3.3.0",
"dialect": "english_us_mfa"
},
"observed_evidence": {
"model_tree_sha256": "486bf1be991b0590f3554040a16502d033237f63d5e426ca231b92b0a9829ada"
}
},
"whisperx": {
"selected": false,
"config_class": "speech_text_data_aligners.backends.whisperx.config.WhisperXConfig",
"runtime": {
"package": "whisperx",
"version": "3.8.6",
"source_revision": "3ccc17b8de34f305300f8a3fd3c9f76ba820c0d0",
"torch_version": "2.8.0",
"torchaudio_version": "2.8.0"
},
"model": {
"id": "WAV2VEC2_ASR_BASE_960H",
"revision": "torchaudio-2.8.0",
"language": "en"
},
"observed_evidence": {
"model_asset_sha256": "488fd4f16de84438ffc945334278c1b9fb9b7159a806c1080b16111a958c945d"
}
},
"nemo": {
"selected": false,
"config_class": "speech_text_data_aligners.backends.nemo.config.NemoConfig",
"runtime": {
"package": "nemo-toolkit",
"version": "3.0.0",
"source_revision": "fd6a877539710e2b98f28c43272ff81312f83417",
"align_script_sha256": "1cfaf9526b47037204b7874c4432e4d5d07364a7fca1b840052c370d46ee2f03"
},
"model": {
"id": "stt_en_fastconformer_hybrid_large_pc",
"revision": null,
"resolution": "pretrained_name_or_local_checkpoint",
"local_checkpoint_preferred": true
},
"observed_evidence": {
"model_sha256": "37afe6627816825af7646c02f9ada5dbf58fe870e7a9cc60fffbd8dd412c8b61"
}
}
}
},
"evaluation": {
"manual_gold": {
"rows": 5,
"fields": [
"first_word_text",
"first_word_end_s"
],
"unvalidated_fields": [
"first_word_start_s",
"last_word_start_s",
"last_word_end_s"
]
},
"results": [
{
"backend": "mfa",
"success": "5/5",
"exact_first_word_text": "5/5",
"first_word_end_mae_s": 0.0162,
"first_word_end_median_s": 0.0110,
"first_word_end_max_s": 0.0300,
"observed_runtime_s": 274.9569
},
{
"backend": "whisperx",
"success": "5/5",
"exact_first_word_text": "5/5",
"first_word_end_mae_s": 0.0154,
"first_word_end_median_s": 0.0140,
"first_word_end_max_s": 0.0310,
"observed_runtime_s": 28.5392
},
{
"backend": "nemo",
"success": "5/5",
"exact_first_word_text": "5/5",
"first_word_end_mae_s": 0.2210,
"first_word_end_median_s": 0.0100,
"first_word_end_max_s": 0.9200,
"observed_runtime_s": 13.7050
}
],
"full_36_pairwise_material_rows_at_0_250_s": {
"mfa_vs_whisperx": 7,
"mfa_vs_nemo": 28,
"whisperx_vs_nemo": 32
},
"canonical_output": {
"path": "results/final/final-annotated-36.csv",
"sha256": "37bcb85fc22fb142dae40453b90dd3b427bbfd657861bee7529cd433915535a8"
}
},
"documentation": {
"readme": "README.md",
"architecture": "ARCHITECTURE.md",
"configuration": "docs/CONFIGURATION.md",
"evaluation": "docs/EVALUATION.md",
"workflows": "docs/WORKFLOWS.md",
"testing": "docs/TESTING.md",
"status": "docs/PROJECT_STATUS.md"
}
}