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

document audio options #141

Merged
merged 2 commits into from
Jul 17, 2024
Merged

document audio options #141

merged 2 commits into from
Jul 17, 2024

Conversation

JarbasAl
Copy link
Member

document some more ovos-audio options

document some more ovos-audio options
@JarbasAl JarbasAl added the documentation Improvements or additions to documentation label Jul 17, 2024
Copy link
Contributor

coderabbitai bot commented Jul 17, 2024

Warning

Rate limit exceeded

@JarbasAl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 59 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 413bc7b and be0b6dc.


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@413bc7b). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff          @@
##             dev    #141   +/-   ##
=====================================
  Coverage       ?   0.00%           
=====================================
  Files          ?      10           
  Lines          ?     827           
  Branches       ?       0           
=====================================
  Hits           ?       0           
  Misses         ?     827           
  Partials       ?       0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JarbasAl JarbasAl merged commit 2930b95 into dev Jul 17, 2024
8 checks passed
@JarbasAl JarbasAl deleted the document-audio-options branch July 17, 2024 23:09
@github-actions github-actions bot mentioned this pull request Sep 2, 2024
JarbasAl added a commit that referenced this pull request Sep 3, 2024
* document transformer plugins (#93)

* derprecated util

* derprecated util

* defaults/transformer_plugins

document transformer plugins and enable utterance normalizer by default

* Increment Version to 0.0.13a1

* Update Changelog

* Create LICENSE

* update/stop_pipeline (#94)

* update/stop_pipeline

add stop to the pipeline by default

companion to OpenVoiceOS/ovos-core#391

* Update mycroft.conf

* Update mycroft.conf

* Increment Version to 0.0.13a2

* Update Changelog

* default utterance plugins (#99)

enable https://github.com/OpenVoiceOS/ovos-utterance-corrections-plugin and https://github.com/OpenVoiceOS/ovos-utterance-plugin-cancel by default if installed

* adjust adapt matcher pipeline defaults (#100)

* Increment Version to 0.0.13a3

* Increment Version to 0.0.13a4

* Update Changelog

* Update Changelog

* Update mycroft.conf (#95)

* Increment Version to 0.0.13a5

* Update Changelog

* readd low adapt matches (intent pipeline) (#101)

* readd low adapt matches

* adjust common_qa

* adjust pipeline

* Increment Version to 0.0.13a6

* Update Changelog

* Create dependabot.yml

* fix/remove_broken_patch (#107)

* fix/remove_broken_patch

patch for mycroft-era `Configuration.get`  (now `Configuration()`) is broken and causes .get to behave weirdly

```
  self.config = dict(Configuration()) # below is False, like in mycroft.conf
        self.config = Configuration() # below is None ????
        self.audio_enabled = self.config.get("enable_old_audioservice")
```

* bad test

* signal breaking change

ripping out a broken patch that we dont use anywhere, but technically a breaking change. 

who knows how many places are not actually reading config...

bumping to 0.1.0 in case anything depends on the broken behaviour

* Update version.py

* Increment Version to 0.0.13a7

* Update Changelog

* fix: "adapt_medium" before padatious (#110)

reprioritize pipeline components

* Increment Version to 0.0.13a8

* Update Changelog

* improve env vars handling (#54)

* Update meta.py

improve env vars handling

* typo

* os.env priority

* Update meta.py

* Increment Version to 0.0.13a9

* Update Changelog

* Update ovos-bus-client requirement from ~=0.0.3 to ~=0.0.8 in /requirements (#106)

Updates the requirements on [ovos-bus-client](https://github.com/OpenVoiceOS/ovos-bus-client) to permit the latest version.
- [Release notes](https://github.com/OpenVoiceOS/ovos-bus-client/releases)
- [Changelog](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/CHANGELOG.md)
- [Commits](OpenVoiceOS/ovos-bus-client@V0.0.3...V0.0.8)

---
updated-dependencies:
- dependency-name: ovos-bus-client
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Increment Version to 0.0.13a10

* Update Changelog

* Update ovos-backend-client requirement from <0.1.0 to <0.2.0 in /requirements (#104)

Updates the requirements on [ovos-backend-client](https://github.com/OpenVoiceOS/ovos-backend-client) to permit the latest version.
- [Release notes](https://github.com/OpenVoiceOS/ovos-backend-client/releases)
- [Changelog](https://github.com/OpenVoiceOS/ovos-backend-client/blob/dev/CHANGELOG.md)
- [Commits](OpenVoiceOS/ovos-backend-client@V0.0.1a4...V0.1.0)

---
updated-dependencies:
- dependency-name: ovos-backend-client
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Increment Version to 0.0.13a11

* Update Changelog

* Update mycroft.conf (#112)

remove unimplemented duck_while_listening, docs for non existing features are misleading

change default lang detect plugin to use public servers (no extra deps)

disable mpris by default in OCP, as that seems to be the cause of many issues in core 0.0.7

* Increment Version to 0.0.13a12

* Update Changelog

* move to vosk (#124)

* move to vosk

move from pocketsphinx to vosk

companion to OpenVoiceOS/ovos-dinkum-listener#113

* Update mycroft.conf

* Increment Version to 0.0.13a13

* Update Changelog

* feat/ocp_pipeline (#96)

* feat/ocp_pipeline

* feat/OCP_backends

* Update mycroft.conf

* Update mycroft.conf

* Update mycroft.conf

* Update mycroft.conf

* "adapt_low",

* Update mycroft.conf

* Update mycroft.conf

* remove deprecated flag

got rid of it OpenVoiceOS/ovos-core#491

---------

Co-authored-by: JarbasAi <jarbasai@mailfence.com>
Co-authored-by: JarbasAI <33701864+JarbasAl@users.noreply.github.com>

* Increment Version to 0.0.13a14

* Update Changelog

* fix/typo (#126)

missing an X in pocketsphinX 

#124

* Increment Version to 0.0.13a15

* Update Changelog

* Update python-dateutil requirement from ~=2.6 to ~=2.9 in /requirements (#115)

Updates the requirements on [python-dateutil](https://github.com/dateutil/dateutil) to permit the latest version.
- [Release notes](https://github.com/dateutil/dateutil/releases)
- [Changelog](https://github.com/dateutil/dateutil/blob/master/NEWS)
- [Commits](dateutil/dateutil@2.6.0...2.9.0.post0)

---
updated-dependencies:
- dependency-name: python-dateutil
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Increment Version to 0.0.13a16

* Update Changelog

* fix: unbound local var (#127)

* fix: resolve unbound local variable

Closes #118

* chore: clean up issues identified by linter

* revert rename

* tidy up workflows

* bump pytest

* Increment Version to 0.0.13a17

* Update Changelog

* better listener defaults (#133)

use instant_listen by default, avoids OpenVoiceOS/ovos-dinkum-listener#107 until fixed

enabled remove_silence by default, further making the above a better default  (as listen sound gets removed by silero vad), safe to do since OpenVoiceOS/ovos-dinkum-listener#122

* Increment Version to 0.0.13a18

* Update Changelog

* fix config set (#134)

fix #73 
fix #59

* Increment Version to 0.0.13a19

* Update Changelog

* Update mycroft.conf (#136)

* Update mycroft.conf

add adapt/padatious default values

* Update mycroft.conf

* Update mycroft.conf

* Update mycroft.conf

* Update mycroft.conf

* Increment Version to 0.0.13a20

* Update Changelog

* feat: add /usr/share as a config location (#128)

/usr/share/<application name> is becoming more and more common for
applications to store their default configuration in.
Either the application itself or distributions can use this location to
ship a config that users will not touch, and instead they are expected
to overwrite (parts of) the config in /etc/<application name>. This
means this config file can be safely updated with new required values
without having to worry about overwriting user-made change.

This is useful in general but especially in case of immutable
distributions who don't touch anything in /etc and /home

* Increment Version to 0.0.13a21

* Update Changelog

* revert to single thread (#137)

use single_thread for padatious by default

* Increment Version to 0.0.13a22

* Update Changelog

* tweak OCP defaults (#139)

default to keyword matching instead of using the new classifier (companion to OpenVoiceOS/ovos-core#502)

reduce min_score from 50 to 40 so more results are considered

* Increment Version to 0.0.13a23

* Update Changelog

* document audio options (#141)

* document audio options

document some more ovos-audio options

* Update mycroft.conf

* Increment Version to 0.0.13a24

* Update Changelog

* document "common_query" config options (#143)

* Increment Version to 0.0.13a25

* Update Changelog

* document "fake_barge_in" (#144)

document "fake_barge_in"

* Increment Version to 0.0.13a26

* Update Changelog

* deprecate/ovos_conf (#138)

* deprecate/ovos_conf

move exclusively to env vars, ovos.conf file is of very limited use, also not a standard pattern and very uncommon in other projects, it just causes confusion to users and distro packagers

(i also simply don't like it and don't want to maintain it :P )

* tests

* fix test

* Increment Version to 0.0.13a27

* Update Changelog

* Increment Version to 0.1.0

* Update Changelog

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: JarbasAI <33701864+JarbasAl@users.noreply.github.com>
Co-authored-by: JarbasAl <JarbasAl@users.noreply.github.com>
Co-authored-by: Swen Gross <25036977+emphasize@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: NeonJarbas <59943014+NeonJarbas@users.noreply.github.com>
Co-authored-by: JarbasAi <jarbasai@mailfence.com>
Co-authored-by: Mike <mike@graywind.org>
Co-authored-by: Bart Ribbers <bribbers@disroot.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant