feat: implement configuration gui

maciejmajek commented 2 weeks ago

Purpose

RAI's configuration is mostly dictated by the config.toml file.

Proposed Changes

This PR introduces a gui for configuring the following parts of RAI:

Models
Tracing
ASR (not yet honored by RAI_ASR)
TTS (not yet honored by RAI_TTS)
Additional features

Issues

Links to relevant issues

Testing

streamlit run src/rai/rai/utils/configurator.py

Summary by CodeRabbit

New Features
- Introduced a Streamlit-based configuration wizard for setting up an AI environment, guiding users through model selection, tracing, speech recognition, and more.
- Added new sections for automatic speech recognition (ASR) and text-to-speech (TTS) in the configuration, enhancing functionality.
- Added a new section in the README for configuring RAI with updated setup instructions.
- Included a new dependency for enhanced project management.
Bug Fixes
- Improved error handling in the configuration wizard to ensure necessary environment variables are present before saving configurations.
Refactor
- Updated the function for tracing callbacks to allow optional parameters for more flexible configuration.
Documentation
- Enhanced the README to clarify setup processes and limitations of the RAI framework, including resource usage concerns.

maciejmajek commented 2 weeks ago

@coderabbit pause

coderabbitai[bot] commented 1 week ago

Walkthrough

This pull request introduces several enhancements to the RAI framework documentation and configuration files. The README.md file now includes a "Configure RAI" section and an expanded "Limitations" section. The config.toml file has been updated with new sections for automatic speech recognition (ASR) and text-to-speech (TTS) configurations, along with changes to vendor models. A new configuration wizard has been implemented in configurator.py using Streamlit. Additionally, the pyproject.toml file adds a new dependency, and modifications to the get_tracing_callbacks function in model_initialization.py improve flexibility in tracing configurations.

Changes

File	Change Summary
README.md	- Added "Configure RAI" section with configuration tool instructions. - Expanded "Limitations" section to address resource usage.
config.toml	- Updated `[vendor]` section to change `embeddings_model` and added new `[asr]` and `[tts]` sections with specific parameters.
pyproject.toml	- Added dependency: `tomli-w = "^1.1.0"` in `[tool.poetry.dependencies]`.
src/rai/rai/utils/configurator.py	- Introduced a configuration wizard with multiple steps for AI environment setup, including error handling and testing functionalities.
src/rai/rai/utils/model_initialization.py	- Updated `get_tracing_callbacks` function to include `override_use_langfuse` and `override_use_langsmith` parameters for enhanced flexibility.

Possibly related PRs

306: The changes in README.md for the "Embodied AI Community Group update" PR also involve modifications to the README.md file, enhancing clarity and accessibility, similar to the updates made in the main PR regarding configuration and limitations.

Suggested reviewers

adamdbrw
boczekbartek

Poem

🐇 In the land of code where rabbits play,
New sections bloom, guiding the way.
Configuration tools, oh what a delight,
With ASR and TTS, our future is bright!
So hop along, let’s set it right,
Together we’ll code, through day and night! 🐰✨

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

RobotecAI / rai