NVIDIA-NeMo / NVIDIA-NeMo/Curator

[Docs] Add an audio tagging, quality-metrics, normalization, and LLM PnC guide

Open
#2,123 0 comments 0 reactions 1 assignee View on GitHub

@lbliii is already working on this.

Since Jun 29, 2026.

documentation tutorials
Dominant language
Python
Stars
1.8k
Forks
328
Avg merge
4d 5h
Merged PRs (30d)
30

Description

Context

Child of #2118. #1863 added a substantial audio-tagging pipeline, but its only Fern change was to the speaker-separation page. The main guidance remains in tutorials/audio/tagging/README.md.

APIs to cover

  • PNCwithvLLMInferenceStage / CleanLLMOutputStage
  • Reusable VLLMInference lifecycle
  • WER, CER, SQUIM, and bandwidth stages
  • PrepareModuleSegmentsStage
  • ITN, Arabic diacritic removal, and Chinese conversion
  • ASR and TTS pipeline configurations

Requirements

  • Explain stage ordering, expected manifest schema, columns added/removed, and model/dependency setup.
  • Document first-pass/second-pass PnC, CER validation, fallback behavior, and operational limits.
  • Include an end-to-end runnable example and a configuration reference for both ASR and TTS paths.
  • Cross-link speaker diarization/separation and audio quality filtering.

Acceptance criteria

  • User-facing Fern documentation exists beyond the GitHub tutorial README
  • Pipeline diagram and stage table match the merged implementation
  • Dependencies/extras and vLLM constraints are explicit
  • Inputs, outputs, defaults, and failure behavior are documented
  • Page is in audio navigation and cross-linked from text integration/quality pages
  • Fern checks pass

Related PR: #1863

Supplemental code-freeze attribution

#1679 introduced the foundational audio tagging pipeline, including resampling, PyAnnote diarization, WhisperX VAD, NeMo ASR alignment, segment merging, YAML configuration, and the initial tutorial. Treat #1679 and #1863 as one implementation history and document the final API on main.

Related PRs: #1679, #1863

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.