Update wyoming-whisper to 2.3.0 #3848
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces version updates for the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
whisper/CHANGELOG.md(1 hunks)whisper/build.yaml(1 hunks)whisper/config.yaml(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- whisper/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (2)
whisper/build.yaml (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
whisper/config.yaml (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🔇 Additional comments (2)
whisper/config.yaml (2)
2-2: LGTM: Version update matches PR objective
Version update to 2.3.0 is consistent with build.yaml.
22-22: Verify impact of new 'turbo' model addition
The model list has been updated to include the new 'turbo' model while maintaining all existing options. This change appears safe as it:
- Preserves backward compatibility by retaining all existing models
- Adds the new option without breaking existing configurations
✅ Verification successful
Let me gather more information about the usage and implementation of the turbo model.
Let me try a different approach to verify the model implementation.
Let me check the Whisper-specific documentation and configuration handling.
Verified: Turbo model addition is properly documented and integrated
The addition of the 'turbo' model is safe and well-integrated because:
- It's properly documented in CHANGELOG.md (version 2.3.0): "Supports model
turbofor faster processing" - The model is correctly added to the configuration schema in config.yaml
- The change maintains backward compatibility with all existing models
- The default model remains as 'tiny-int8', so existing configurations won't be affected
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the PR referenced in wyoming-faster-whisper#40 documents the turbo model
gh api \
-H "Accept: application/vnd.github+json" \
repos/rhasspy/wyoming-faster-whisper/pulls/40 | \
jq -r '.body' | grep -i turbo
# Check for any existing configurations using the default model
rg -l "model: tiny-int8" --type yaml
Length of output: 184
Script:
#!/bin/bash
# Check for any references to turbo model in the codebase
rg -l "turbo" --type python
# Check for any documentation or examples mentioning turbo model
fd README.md | xargs rg -l "turbo"
# Look for model-related configuration handling code
ast-grep --pattern 'def $_(self, model: str):'
Length of output: 142
Script:
#!/bin/bash
# Search for any Python files in the repository
fd '\.py$'
# Search for any references to model configuration or validation
rg -l "model" --type yaml
# Look for any documentation files
fd -e md -e txt
Length of output: 2030
Script:
#!/bin/bash
# Check Whisper documentation for turbo model mentions
cat whisper/DOCS.md whisper/README.md whisper/CHANGELOG.md
# Look for model validation or handling in the configuration
cat whisper/config.yaml
# Check for any model-related translations
cat whisper/translations/en.yaml
Length of output: 8261
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
whisper/DOCS.md (1)
44-44: Consider reorganizing the model list and enhancing the turbo model descriptionThe placement of
turboat the top of the list breaks the established pattern of ordering models by size/complexity. Additionally, the description "faster thanlarge-v3" lacks important details about accuracy trade-offs.Consider:
- Moving
turboto a more logical position in the list, possibly near the large models- Expanding the description to include accuracy comparisons with
large-v3-Available models: - -- `turbo` (faster than `large-v3`) -- `tiny-int8` (compressed) +Available models: + +- `tiny-int8` (compressed) ... +- `large-v3` +- `turbo` (faster processing than `large-v3` with comparable accuracy)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
whisper/DOCS.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
whisper/DOCS.md (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🔇 Additional comments (1)
whisper/DOCS.md (1)
44-44: Verify model list consistency with configuration
Let's ensure the documented models match the available options in the add-on configuration.
✅ Verification successful
Model list in documentation matches configuration options
The documented models in DOCS.md perfectly align with the available options in config.yaml. The schema in the configuration file includes all models listed in the documentation, including the turbo model. Both files maintain consistency in their model listings.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the model list in DOCS.md matches config.yaml
# Expected: The model options in config.yaml should match the documented list
# Get the model list from config.yaml
echo "Models in config.yaml:"
rg "model:" whisper/config.yaml -A 30
# Compare with documentation
echo -e "\nModels in DOCS.md:"
rg "^- \`.*\`" whisper/DOCS.md
Length of output: 1538
|
Upstream repo has been updated, so the tests can be run now. |
Bump update from rhasspy/wyoming-faster-whisper#40
Summary by CodeRabbit
New Features
turbomodel for enhanced processing speed.Version Updates
wyoming-whisperpackage to version2.3.0.faster-whisperpackage to version1.1.0.Documentation
turbomodel option and clarifications on configuration options.