Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Turbo closer to Large to avoid confusing it with Tiny #3857

Merged
merged 4 commits into from
Dec 10, 2024

Conversation

googanhiem
Copy link
Contributor

@googanhiem googanhiem commented Dec 9, 2024

Move Turbo closer to Large to avoid confusing it with Tiny.

Summary by CodeRabbit

  • Documentation

    • Updated the Whisper add-on documentation for clarity on the turbo model's performance compared to large-v3.
  • Configuration

    • Updated the version number in the configuration file from 2.3.0 to 2.3.1.
    • Reordered the list of acceptable model values in the configuration file, moving turbo to the end of the list.
  • Changelog

    • Added entry for version 2.3.1, highlighting the changes made to the turbo model's position in the list.

Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve updates to the documentation and configuration of the Whisper add-on in Home Assistant. The documentation has been clarified regarding the turbo model, explicitly stating its performance as "faster than large-v3." In the whisper/config.yaml file, the order of acceptable model values has been modified, moving turbo from the beginning to the end of the list. The version number in the configuration file has also been updated from 2.3.0 to 2.3.1. No functionality or configuration options have been altered in these updates.

Changes

File Change Summary
whisper/DOCS.md Updated documentation to clarify that turbo is faster than large-v3.
whisper/config.yaml Updated version number from 2.3.0 to 2.3.1 and reordered acceptable model values, moving turbo to the end.
whisper/CHANGELOG.md Added changelog entry for version 2.3.1, noting the reordering of the turbo model.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Whisper
    participant Documentation

    User->>Documentation: Requests information on models
    Documentation-->>User: Provides model information
    User->>Whisper: Configures model selection
    Whisper-->>User: Acknowledges configuration
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a512312 and 2eefde0.

📒 Files selected for processing (2)
  • whisper/CHANGELOG.md (1 hunks)
  • whisper/config.yaml (2 hunks)

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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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 or @coderabbitai title 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

Documentation and Community

  • 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.

Copy link
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (1)
whisper/config.yaml (1)

22-22: Approve the reordering but suggest minor adjustment

The reordering of models achieves the PR objective by moving 'turbo' away from 'tiny' to reduce confusion. The new position after the 'large' variants is logical since 'turbo' is faster than 'large-v3'.

Consider this minor adjustment to maintain better grouping:

-    list(tiny-int8|tiny|tiny.en|base-int8|base|base.en|small-int8|distil-small.en|small|small.en|distil-medium.en|medium-int8|medium|medium.en|large|large-v1|distil-large-v2|large-v2|distil-large-v3|large-v3|turbo|custom)
+    list(tiny-int8|tiny|tiny.en|base-int8|base|base.en|small-int8|distil-small.en|small|small.en|distil-medium.en|medium-int8|medium|medium.en|large|large-v1|distil-large-v2|large-v2|distil-large-v3|large-v3|custom|turbo)

This places 'custom' at the end as it's a special case, making the progression from specific models to custom more logical.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 422dbf6 and a512312.

📒 Files selected for processing (2)
  • whisper/DOCS.md (1 hunks)
  • whisper/config.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • whisper/DOCS.md
🧰 Additional context used
📓 Path-based instructions (1)
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.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @googanhiem 👍

Can you also update the changelog and version? Otherwise the update will not ship.

../Frenck

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft December 10, 2024 10:13
@googanhiem
Copy link
Contributor Author

@frenck updated the version number 👍

@frenck frenck marked this pull request as ready for review December 10, 2024 10:52
@home-assistant home-assistant bot requested a review from frenck December 10, 2024 10:52
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @googanhiem 👍

../Frenck

@frenck frenck merged commit 324751d into home-assistant:master Dec 10, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants