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

feat: models from upstream plugin #9

Merged
merged 7 commits into from
Sep 13, 2024
Merged

Conversation

mikejgray
Copy link
Contributor

@mikejgray mikejgray commented May 23, 2024

chore: better model error handling

Newer versions of faster-whisper offer a function to display available models. Using that is more robust than trying to keep a manual list up-to-date.

Tested in https://hub.docker.com/repository/docker/mjgray84/ovos-stt-server-fasterwhisper-cuda/general

Summary by CodeRabbit

  • New Features

    • Enhanced validation for model configuration in speech recognition and language classification.
    • Introduced a comprehensive suite of unit tests for improved reliability of functionalities.
  • Bug Fixes

    • Improved error handling for invalid model configurations, ensuring defaults are set.
  • Chores

    • Updated GitHub Actions workflows for better performance and security.
    • Expanded .gitignore to include more unnecessary files for cleaner version control.

Includes better error handling and logging around model choice
FasterWhisper doesn't support Python 3.7
@JarbasAl JarbasAl added the enhancement New feature or request label May 23, 2024
Copy link

codecov bot commented May 23, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Copy link

coderabbitai bot commented Sep 13, 2024

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 50 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between ffd2d73 and e934f9c.

Walkthrough

The pull request introduces several updates to GitHub Actions workflows, enhancing the configuration files for license testing and unit testing. It includes upgrades to various actions, modifications to the .gitignore file to exclude additional patterns, and improvements in the ovos_stt_plugin_fasterwhisper module for model validation. Furthermore, a new test suite is added to ensure the functionality of speech-to-text and language classification features, providing comprehensive coverage for the updated code.

Changes

Files Change Summary
.github/workflows/license_tests.yml Updated GitHub Actions: checkout to v4, setup-python to v5, and pilosus/action-pip-license-checker to v2. Reformatted parameters and modified exclude list to exclude additional packages.
.github/workflows/unit_tests.yml Updated GitHub Actions: checkout to v4, setup-python to v5, and codecov-action to v4. Reformatted ignored paths and modified the Python version matrix to support Python 3.11, while changing the coverage report directory.
.gitignore Expanded to include a comprehensive list of patterns and directories related to Python files, frameworks, tools, and dependency management, ensuring unnecessary files are ignored.
ovos_stt_plugin_fasterwhisper/__init__.py Enhanced model validation in FasterWhisperLangClassifier and FasterWhisperSTT classes, logging warnings for invalid models and defaulting to "small". Updated MODELS to retrieve available models dynamically.
test/test_plugin.py Introduced a suite of unit tests for the FasterWhisperSTT and FasterWhisperLangClassifier classes, validating functionalities such as audio data handling, STT execution, language detection, and model configuration handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubActions
    participant LicenseChecker
    participant UnitTests
    participant FasterWhisper

    User->>GitHubActions: Trigger workflow
    GitHubActions->>LicenseChecker: Run license checks
    LicenseChecker-->>GitHubActions: Return results
    GitHubActions->>UnitTests: Run unit tests
    UnitTests-->>GitHubActions: Return test results
    GitHubActions->>FasterWhisper: Validate model configuration
    FasterWhisper-->>GitHubActions: Return validation status
    GitHubActions-->>User: Provide workflow summary
Loading

🐰 In the garden, where changes bloom,
Actions updated, dispelling the gloom.
Models validated, tests in a row,
Clean paths in .gitignore, watch them grow!
With every commit, our code sings,
Hopping along, embracing new things! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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 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.

@JarbasAl JarbasAl merged commit 2a32cc7 into OpenVoiceOS:dev Sep 13, 2024
6 checks passed
@github-actions github-actions bot added feature and removed feature labels Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants