Skip to content

docs: add OpenInterview to projects using sherpa-onnx#3517

Open
yuuuuuuan wants to merge 2 commits intok2-fsa:masterfrom
yuuuuuuan:master
Open

docs: add OpenInterview to projects using sherpa-onnx#3517
yuuuuuuan wants to merge 2 commits intok2-fsa:masterfrom
yuuuuuuan:master

Conversation

@yuuuuuuan
Copy link
Copy Markdown

@yuuuuuuan yuuuuuuan commented Apr 16, 2026

Hi, thanks for your great work on sherpa-onnx.

I’m using sherpa-onnx in my project OpenInterview, and this PR adds it to the “Projects using sherpa-onnx” section in the README. The main users are from the Chinese community, so I also added a Chinese description to make the project easier to understand for that audience.

If you feel this project fits well in the showcase section, I’d really appreciate your consideration. Thanks again for maintaining sherpa-onnx and making it available to the community.

Summary by CodeRabbit

  • Documentation

    • Added OpenInterview project entry to the community projects list, showcasing an AI-powered interview assistant leveraging real-time speech recognition.
  • Chores

    • Exposed package version at the module level for programmatic access.

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Apr 16, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

Two straightforward additions: documenting a new OpenInterview project using sherpa-onnx in the README, and introducing an explicit __version__ constant in the Python package's __init__.py file.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added OpenInterview project entry to "Projects using sherpa-onnx" section with GitHub URL and description of AI-driven interview assistant using real-time speech recognition.
Version Constant
sherpa-onnx/python/sherpa_onnx/__init__.py
Defined package-level __version__ variable set to '1.12.38' for explicit runtime version exposure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

size:XS

Suggested reviewers

  • csukuangfj

Poem

🐰 A version now hops into sight,
With OpenInterview shining bright,
Simple additions, clean and neat,
Making sherpa-onnx complete!

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: adding OpenInterview to the README's project showcase section, which aligns with the primary modification in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Copy Markdown

@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 the OpenInterview project to the README and introduces a version attribute to the Python package. A review comment suggests using the existing version import from the native library instead of hardcoding the version string to ensure consistency and reduce maintenance.

from .offline_recognizer import OfflineRecognizer
from .online_recognizer import OnlineRecognizer
from .utils import text2token
__version__ = '1.12.38'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Hardcoding the version string creates a maintenance burden and can lead to inconsistencies between the Python package and the core library. Since version is already imported from the native library on line 85, it should be used to define __version__. Additionally, this code change appears unrelated to the documentation update described in the pull request title.

Suggested change
__version__ = '1.12.38'
__version__ = version

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@sherpa-onnx/python/sherpa_onnx/__init__.py`:
- Line 94: The file defines a hardcoded __version__ while also importing version
from the compiled library; to avoid drift, replace the hardcoded string by
aliasing the imported symbol (set __version__ equal to version) so there is a
single runtime source of truth (refer to the imported name version and the
__version__ assignment location).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c0ac3289-ba0c-4584-9144-4b69b20635fa

📥 Commits

Reviewing files that changed from the base of the PR and between f9375be and 9e405ba.

📒 Files selected for processing (2)
  • README.md
  • sherpa-onnx/python/sherpa_onnx/__init__.py

from .offline_recognizer import OfflineRecognizer
from .online_recognizer import OnlineRecognizer
from .utils import text2token
__version__ = '1.12.38'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Potential version drift: __version__ duplicates existing version import.

The module already imports version from the compiled library at Line 85. Adding a hardcoded __version__ string creates two version sources that could diverge during releases.

Consider either:

  • Aliasing the existing runtime version: __version__ = version
  • Or removing the imported version if __version__ should be the single source of truth

This ensures version consistency and reduces maintenance burden.

♻️ Proposed fix to alias existing version
 from .display import Display
 from .keyword_spotter import KeywordSpotter
 from .offline_recognizer import OfflineRecognizer
 from .online_recognizer import OnlineRecognizer
 from .utils import text2token
-__version__ = '1.12.38'
+
+__version__ = version
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
__version__ = '1.12.38'
from .display import Display
from .keyword_spotter import KeywordSpotter
from .offline_recognizer import OfflineRecognizer
from .online_recognizer import OnlineRecognizer
from .utils import text2token
__version__ = version
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@sherpa-onnx/python/sherpa_onnx/__init__.py` at line 94, The file defines a
hardcoded __version__ while also importing version from the compiled library; to
avoid drift, replace the hardcoded string by aliasing the imported symbol (set
__version__ equal to version) so there is a single runtime source of truth
(refer to the imported name version and the __version__ assignment location).

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