Clarify using the latest voices with Wyoming Piper - #4601
Conversation
The Wyoming Piper code fetches from the main Huggingface "branch", not v1.0.0. Though in order to use newly available voices, one might need to update the voices list - clarify this in the docs. SEE: OHF-Voice/wyoming-piper#49
📝 WalkthroughWalkthroughDocumentation update changes the Hugging Face Piper voice model download source from a pinned version (v1.0.0) to the rolling main branch, and adds guidance for users to utilize the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@piper/DOCS.md`:
- Line 31: Rewrite the sentence in DOCS.md to use a direct, authoritative tone
by removing "may" and fronting the instruction; change "To use the latest
voices, you may need to use the `update_voices` option." to a direct imperative
such as "Use the `update_voices` option to get the latest voices." Ensure the
reference to the `update_voices` option remains exact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| Name of the Piper voice to use, such as `en_US-lessac-medium` (the default). | ||
| Voice models are automatically downloaded from https://huggingface.co/rhasspy/piper-voices/tree/v1.0.0 | ||
| Voice models are automatically downloaded from <https://huggingface.co/rhasspy/piper-voices/tree/main>. | ||
| To use the latest voices, you may need to use the `update_voices` option. |
There was a problem hiding this comment.
Use direct, authoritative tone instead of "may".
The sentence uses "may" which should be avoided. Rewrite to be more direct and authoritative.
📝 Proposed fix
-To use the latest voices, you may need to use the `update_voices` option.
+To use the latest voices, enable the **update_voices** option.As per coding guidelines: "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."
📝 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.
| To use the latest voices, you may need to use the `update_voices` option. | |
| To use the latest voices, enable the **update_voices** option. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@piper/DOCS.md` at line 31, Rewrite the sentence in DOCS.md to use a direct,
authoritative tone by removing "may" and fronting the instruction; change "To
use the latest voices, you may need to use the `update_voices` option." to a
direct imperative such as "Use the `update_voices` option to get the latest
voices." Ensure the reference to the `update_voices` option remains exact.
1 participant
The Wyoming Piper code fetches from the main Huggingface "branch", not
v1.0.0. Though in order to use newly available voices, one might need to
update the voices list - clarify this in the docs.
SEE: OHF-Voice/wyoming-piper#49
Summary by CodeRabbit
update_voicesoption to fetch the most recent voice models.