Skip to content

Add license info about tts models from OpenVoiceOS - #2530

Merged
csukuangfj merged 2 commits into
k2-fsa:masterfrom
csukuangfj:openvoiceos-models
Aug 25, 2025
Merged

csukuangfj merged 2 commits into
k2-fsa:masterfrom
csukuangfj:openvoiceos-models

Conversation

@csukuangfj

@csukuangfj csukuangfj commented Aug 25, 2025 •

Copy link
Copy Markdown
Collaborator

See also #2480

Screenshot 2025-08-26 at 07 17 59

CC @JarbasAl

Summary by CodeRabbit

  • New Features

    • Expanded English model availability to include both US and GB variants, offering more options.
  • Documentation

    • Generated READMEs for many language models now include a CC BY-NC-SA 4.0 licensing section with non-commercial use guidance, redistribution requirements, and note about possible future relaxation.
    • License notes added consistently across multiple locales (e.g., en_US, en_GB, es_ES, fr_FR, it_IT, nl_NL, pt_PT, de_DE).

@coderabbitai

coderabbitai Bot commented Aug 25, 2025 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

get_en_models() now returns the concatenation of en_GB and en_US models. Many language README entries now include a standardized license block referencing Sherpa-ONNX PR 2480 and CC BY‑NC‑SA 4.0; one spot uses "README" instead of "README.md". No public API signatures changed.

Changes

Cohort / File(s) Summary
English models aggregation
scripts/piper/generate.py
get_en_models() now returns en_gb + en_us (concatenated lists) rather than only en_us.
README license insertion (multi-language)
scripts/piper/generate.py
Inserts a standardized license section into generated READMEs for many languages (e.g., es_ES, fr_FR, it_IT, nl_NL, pt_PT, en_GB, en_US, de_DE, ...), mentioning Sherpa‑ONNX PR #2480, CC BY‑NC‑SA 4.0, usage bullets, and a redistribution requirement.
Minor textual inconsistency
scripts/piper/generate.py
One location writes "README" while others use "README.md".
API surface
scripts/piper/generate.py
No changes to function signatures or exported/public declarations.

Sequence Diagram(s)

sequenceDiagram
  actor Caller
  participant Gen as scripts/piper/generate.py
  participant EN_US as en_US list
  participant EN_GB as en_GB list

  Caller->>Gen: get_en_models()
  Gen->>EN_US: retrieve en_US models
  Gen->>EN_GB: retrieve en_GB models
  Gen->>Gen: concatenate en_GB + en_US
  Gen-->>Caller: return combined English models
Loading
sequenceDiagram
  actor Generator
  participant Gen as scripts/piper/generate.py
  participant Writer as README builder

  Generator->>Gen: build language entries
  loop for each language section
    Gen->>Writer: write model metadata
    Note right of Writer: Append license block:\n• License header\n• Link to PR #2480\n• CC BY‑NC‑SA 4.0 note\n• Usage bullets\n• Redistribution requirement
  end
  Gen-->>Generator: completed README content
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I hop through lines and splice the strings,
GB joins US — two flags on my springs.
License notes tucked in every readme bed,
I tidy the burrow and wiggle my head.
Hoppity-hop, the patch is fed. 🥕🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 99e042e and a108b34.

📒 Files selected for processing (1)
  • scripts/piper/generate.py (14 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Aug 25, 2025
@csukuangfj
csukuangfj merged commit f45cd87 into k2-fsa:master Aug 25, 2025
@csukuangfj
csukuangfj deleted the openvoiceos-models branch August 25, 2025 23:24

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between eaf2eb2 and 99e042e.

📒 Files selected for processing (1)
  • scripts/piper/generate.py (14 hunks)
🔇 Additional comments (15)
scripts/piper/generate.py (15)

266-272: License information added consistently across models.

The standardized CC BY-NC-SA 4.0 license blocks are being correctly added to the OpenVoiceOS model READMEs with proper formatting and clear usage guidelines.


427-433: License information added consistently.

The license block follows the same format as other models with proper CC BY-NC-SA 4.0 licensing information.


579-585: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


608-614: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


849-855: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


878-884: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1079-1085: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1108-1114: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1140-1146: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1169-1175: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1637-1643: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1666-1672: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1718-1724: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.


1748-1748: English model expansion implemented correctly.

The function now returns a combination of both en_GB and en_US models, expanding the available English model set as intended.


1875-1881: License information added consistently.

The license block follows the same format with proper CC BY-NC-SA 4.0 licensing information.

Comment thread scripts/piper/generate.py Outdated
@coderabbitai coderabbitai Bot mentioned this pull request Sep 1, 2025
@JarbasAl JarbasAl mentioned this pull request Sep 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant