Skip to content

[Docs] Repair audio API examples and add workflow selection guidance #2162

Description

@lbliii

Parent tracker: #2118

Goal

Repair stale audio API examples and add task-oriented guidance that helps users choose the correct 26.06 audio workflow.

Problems found

The new audio-tagging and long-form-cutting tutorials are sound, but they link into older supporting pages containing 27 stale import occurrences, principally:

  • nemo_curator.stages.audio.inference.asr_nemo
  • nemo_curator.stages.audio.metrics.get_wer

The current implementations live under inference.asr.asr_nemo and metrics.wer, and some helpers referenced by older pages no longer exist.

The landing pages also list several similar workflows without explaining when to choose basic ASR curation, AudioDataFilterStage, audio tagging, ALM fixed-window construction, or long-form physical cutting and WebDataset packaging.

Timing

Broken imports are release scope and should be corrected before the 26.06 docs publication tag. The workflow-selection presentation can land in the same PR because it is small and directly supports the two new tutorials.

Acceptance criteria

  • Inventory every audio code block and replace removed module paths and symbols with current APIs.
  • Verify examples in getting started, loading, ASR, quality assessment, text integration, and tutorial pages.
  • Add a concise workflow comparison to the audio overview or process-data overview.
  • Distinguish metadata/window construction from physical snippet extraction and packaging.
  • Preserve cross-links to [codex] docs: add audio tagging pipeline guide #2135 and #2136 content after their integration conflict is resolved.
  • Run static import checks, fern check, and the generated-reference broken-link job.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationneeds-follow-upIssue needs follow-upr1.3.0Pick this label for auto cherry-picking into r1.3.0

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions