Inference Tutorial for Streaming ASR Pipelines

[naymaraq]

Important

The Update branch button must only be pressed in very rare occassions.
An outdated branch is never blocking the merge of a PR.
Please reach out to the automation team before pressing that button.

What does this PR do ?

• Introduces the ASR Inference Pipeline API for building real-time streaming speech recognition systems
• Covers core abstractions: Frame, Stream, Pipeline, and TranscribeStepOutput
• Demonstrates how to construct pipelines for:
  • Buffered inference (CTC, RNNT, TDT)
  • Cache-aware streaming models (CTC, RNNT)
• Explores advanced features, including:
  • Continuous batching
  • Per-stream options
  • End-of-Utterance detection
  • Word timestamps
  • Inverse Text Normalization
  • Streaming speech translation

Collection: [ASR]

Changelog

• Add specific line by line info of high level changes in this PR.

Usage

• You can potentially add a usage example below

# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

• Make sure you read and followed Contributor guidelines
• Did you write any new necessary tests?
• Did you add or update any necessary documentation?
• Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
  • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

• New Feature
• Bugfix
• Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

• Related to # (issue)

[naymaraq]

/claude review

[pzelasko]

IMO the structure of the notebook should be reversed - start with the cabalities and high level APIs first, and later have a section about "Implementation Details" where you explain concepts like Frame etc. Otherwise looks good to me

[naymaraq]

start with the cabalities and high level APIs first, and later have a section about "Implementation Details" where you explain concepts like Frame etc. Otherwise looks good to me

That makes sense. Will change the order

[naymaraq]

/claude review

[claude]

LGTM

[Ssofja]

LGTM

[lilithgrigoryan]

Looks very good to me. See minor comment above

[github-actions]

[🤖]: Hi @naymaraq 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully.

So it might be time to merge this PR or get some approvals.