Skip to content

Add doc for FireRedASR v2 models#808

Merged
csukuangfj merged 2 commits intomasterfrom
doc-fire-red-asr-v2
Mar 5, 2026
Merged

Add doc for FireRedASR v2 models#808
csukuangfj merged 2 commits intomasterfrom
doc-fire-red-asr-v2

Conversation

@csukuangfj
Copy link
Collaborator

@csukuangfj csukuangfj commented Mar 5, 2026

Fixes k2-fsa/sherpa-onnx#3228

See https://k2-fsa.github.io/sherpa/onnx/FireRedAsr/index.html

Screenshot 2026-03-05 at 12 21 08

Summary by CodeRabbit

Release Notes

  • Documentation

    • Expanded FireRedAsr model documentation with separate guides for v1 and v2 variants
    • Added comprehensive usage examples and code snippets for model configuration and inference workflows
    • Updated documentation structure with clearer model versioning and variant information
    • Fixed navigation link in Moonshine documentation
  • Chores

    • Updated GitHub Actions workflow schedule configuration

@csukuangfj csukuangfj merged commit 9d10017 into master Mar 5, 2026
1 check was pending
@csukuangfj csukuangfj deleted the doc-fire-red-asr-v2 branch March 5, 2026 04:22
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly updates the documentation for FireRedASR models, introducing detailed guides for the new and improved v2 versions. The changes aim to provide users with clearer instructions and better insights into the capabilities and performance enhancements of these advanced speech recognition models, ultimately improving the user experience and accessibility of the latest features.

Highlights

  • New FireRedASR v2 Model Documentation: Added comprehensive documentation for the new FireRedASR v2 models, including both CTC and Attention-Encoder-Decoder (AED) variants, detailing their features, download instructions, and usage examples.
  • Documentation Structure Refinement: Refactored the pretrained.rst file to clearly distinguish between FireRedASR v1 and v2 models, improving navigation and clarity for users.
  • Performance and Language Support: Highlighted that FireRedASR v2 models offer a very fast CTC model and a much faster AED model compared to v1, with expanded support for over 20 Chinese dialects in addition to Chinese and English.
  • Updated Android APK Link: Corrected an outdated link for Android streaming APK documentation in the Moonshine model template.
Changelog
  • docs/source/onnx/FireRedAsr/code/2026-02-25-ctc-long.txt
    • Added example output for long audio file decoding using FireRedASR v2 CTC with VAD.
  • docs/source/onnx/FireRedAsr/code/2026-02-25-ctc.txt
    • Added example output for single audio file decoding using FireRedASR v2 CTC.
  • docs/source/onnx/FireRedAsr/code/2026-02-26-aed-long.txt
    • Added example output for long audio file decoding using FireRedASR v2 AED with VAD.
  • docs/source/onnx/FireRedAsr/code/2026-02-26-aed.txt
    • Added example output for single audio file decoding using FireRedASR v2 AED.
  • docs/source/onnx/FireRedAsr/pretrained.rst
    • Updated to remove old v1 documentation and include references to new v1-aed, v2-aed, and v2-ctc files.
    • Added introductory notes distinguishing between v1 and v2 models.
  • docs/source/onnx/FireRedAsr/v1-aed.rst
    • Added new documentation file for the FireRedASR v1 AED model, including download and decoding examples.
  • docs/source/onnx/FireRedAsr/v2-aed.rst
    • Added new detailed documentation for the FireRedASR v2 AED model, covering language support, download, and various decoding scenarios.
  • docs/source/onnx/FireRedAsr/v2-ctc.rst
    • Added new detailed documentation for the FireRedASR v2 CTC model, including Android APK links, language support, download, and various decoding scenarios.
  • docs/source/onnx/moonshine/tpl/model_v2.rst
    • Updated the Android streaming APK documentation URL.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/build-doc.yml
Activity
  • Addressed issue #3228, which likely requested documentation for the new FireRedASR v2 models.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1c479a1e-3f2e-4d62-ad50-426954224b1b

📥 Commits

Reviewing files that changed from the base of the PR and between 2be6983 and 7659d27.

📒 Files selected for processing (10)
  • .github/workflows/build-doc.yml
  • docs/source/onnx/FireRedAsr/code/2026-02-25-ctc-long.txt
  • docs/source/onnx/FireRedAsr/code/2026-02-25-ctc.txt
  • docs/source/onnx/FireRedAsr/code/2026-02-26-aed-long.txt
  • docs/source/onnx/FireRedAsr/code/2026-02-26-aed.txt
  • docs/source/onnx/FireRedAsr/pretrained.rst
  • docs/source/onnx/FireRedAsr/v1-aed.rst
  • docs/source/onnx/FireRedAsr/v2-aed.rst
  • docs/source/onnx/FireRedAsr/v2-ctc.rst
  • docs/source/onnx/moonshine/tpl/model_v2.rst

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for FireRedASR v2 models (CTC and AED variants) with new documentation files for both v1 and v2 variants, restructures the pretrained models guide, provides code examples, and updates a GitHub Actions workflow schedule.

Changes

Cohort / File(s) Summary
Workflow Configuration
.github/workflows/build-doc.yml
Updated cron schedule from 50 23 to 35 23 in the nightly build trigger.
FireRedASR Documentation Structure
docs/source/onnx/FireRedAsr/pretrained.rst, docs/source/onnx/FireRedAsr/v1-aed.rst, docs/source/onnx/FireRedAsr/v2-aed.rst, docs/source/onnx/FireRedAsr/v2-ctc.rst
Restructured pretrained models guide to split v1 and v2 documentation into separate sub-documents with explicit hyperlinks; added new v1 AED guide with download/decode instructions; added v2 AED documentation covering zh_en-int8 model with dialects, VAD, and real-time usage; added v2 CTC documentation for zh_en-int8 model with decoding examples.
FireRedASR Code Examples
docs/source/onnx/FireRedAsr/code/2026-02-25-ctc-long.txt, docs/source/onnx/FireRedAsr/code/2026-02-25-ctc.txt, docs/source/onnx/FireRedAsr/code/2026-02-26-aed-long.txt, docs/source/onnx/FireRedAsr/code/2026-02-26-aed.txt
Added four new example code/output files demonstrating CTC and AED recognizer configurations, runtime initialization sequences, transcribed segments with timestamps, and performance metrics.
Moonshine Documentation
docs/source/onnx/moonshine/tpl/model_v2.rst
Updated Android usage link to reference the simulate-streaming-asr page.

Possibly related issues

  • #3228: Directly addressed—this PR adds complete documentation for FireRedASR v2 (both CTC and AED models) to the pretrained models guide as requested, with separate versioned documentation files and examples.

Poem

🐰 A rabbit hops through docs so bright,
FireRed v2 shines with new light,
From CTC to AED's embrace,
Examples bloom in every space!
Whiskers twitch with joy untold,
Carrot-worthy docs, pure gold! 🥕✨


🎯 2 (Simple) | ⏱️ ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch doc-fire-red-asr-v2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for the FireRedASR v2 models, which is a great improvement. The documentation is well-structured, separating v1 and v2 models, and further dividing v2 into AED and CTC variants. I've found a few minor issues, mainly typos and inconsistencies in file paths and links, and have provided suggestions for correction. Overall, the changes are clear and enhance the project's documentation.

<td>lei-jun-test.wav</td>
<td>
<audio title="lei-jun-test.wav" controls="controls">
<source src="/sherpa/_static/sense-voice/lei-jun-test.wav" type="audio/wav">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The audio source path /sherpa/_static/sense-voice/lei-jun-test.wav appears to be a copy-paste from another document. To improve clarity and avoid confusion, it would be better to use a path that is specific to fire-red-asr. For example, you could place the audio file in a fire-red-asr directory within _static.

Suggested change
<source src="/sherpa/_static/sense-voice/lei-jun-test.wav" type="audio/wav">
<source src="/sherpa/_static/fire-red-asr/lei-jun-test.wav" type="audio/wav">

Real-time/streaming speech recognition on Android
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Pease visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk.html>`_

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a typo "Pease" which should be "Please". Also, since this section is about simulated streaming ASR, the link should point to apk-simulate-streaming-asr.html instead of apk.html for consistency with other parts of the documentation.

Suggested change
Pease visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk.html>`_
Please visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk-simulate-streaming-asr.html>`_

<td>lei-jun-test.wav</td>
<td>
<audio title="lei-jun-test.wav" controls="controls">
<source src="/sherpa/_static/sense-voice/lei-jun-test.wav" type="audio/wav">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The audio source path /sherpa/_static/sense-voice/lei-jun-test.wav appears to be a copy-paste from another document. To improve clarity and avoid confusion, it would be better to use a path that is specific to fire-red-asr. For example, you could place the audio file in a fire-red-asr directory within _static.

Suggested change
<source src="/sherpa/_static/sense-voice/lei-jun-test.wav" type="audio/wav">
<source src="/sherpa/_static/fire-red-asr/lei-jun-test.wav" type="audio/wav">

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Pease visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk.html>`_
Pease visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk-simulate-streaming-asr.html>`_

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a typo "Pease". It should be "Please".

Suggested change
Pease visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk-simulate-streaming-asr.html>`_
Please visit `<https://k2-fsa.github.io/sherpa/onnx/android/apk-simulate-streaming-asr.html>`_

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Help wanted] Add doc about FireRedASR v2

1 participant