Skip to content

Update README to include a ROS2 project using sherpa-onnx - #2672

Merged
csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:update-readme
Oct 10, 2025
Merged

csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:update-readme

Conversation

@csukuangfj

@csukuangfj csukuangfj commented Oct 10, 2025 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added a new "elderly-companion" project entry highlighting real-time speech recognition in ROS2 with RK NPU using sherpa-onnx.
    • Added a brief description to the existing Flet ASR/STT component based on sherpa-onnx.
    • Applied minor formatting tweaks in the README for improved readability.

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Oct 10, 2025
@coderabbitai

coderabbitai Bot commented Oct 10, 2025 •

Copy link
Copy Markdown

Walkthrough

Added a new "elderly-companion" project entry to README and a brief description line under the existing "flet_sherpa_onnx" header, with minor spacing/formatting adjustments. No code or API changes.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "elderly-companion" project entry referencing sherpa-onnx Python API for real-time ASR in ROS2 with RK NPU; appended a descriptive line for "flet_sherpa_onnx"; minor formatting (blank lines) preserved around the section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

I hop through docs with gentle cheer,
New friends appear—companions near!
A flet-ful line, a tidy space,
README paths in perfect place.
Ears perked high, I stamp and grin—
Small edits made; let reviews begin! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the primary change, namely updating the README to include a ROS2 project that uses sherpa-onnx, and matches the content of the changeset without extraneous detail or ambiguity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ecfbc9a and e75b2b6.

📒 Files selected for processing (1)
  • README.md (1 hunks)

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.

@csukuangfj
csukuangfj merged commit 57ebfc1 into k2-fsa:master Oct 10, 2025
1 check passed
@csukuangfj
csukuangfj deleted the update-readme branch October 10, 2025 07:37
@coderabbitai coderabbitai Bot mentioned this pull request Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant