Conversation
Summary of ChangesHello, 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
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe 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
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 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
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
📝 WalkthroughWalkthroughThis 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
Possibly related issues
Poem
🎯 2 (Simple) | ⏱️ ~10 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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"> |
There was a problem hiding this comment.
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.
| <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>`_ |
There was a problem hiding this comment.
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.
| 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"> |
There was a problem hiding this comment.
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.
| <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>`_ |
Fixes k2-fsa/sherpa-onnx#3228
See https://k2-fsa.github.io/sherpa/onnx/FireRedAsr/index.html
Summary by CodeRabbit
Release Notes
Documentation
Chores