Skip to content

docs: add Tuning Engines LiteLLM config #1419

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.

Sign up for GitHub

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

Open
cerebrixos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Tuning Engines LiteLLM config #1419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,17 @@ More details can be found in the [development setup](https://rdagent.readthedocs
OPENAI_API_KEY=<replace_with_your_openai_api_key>
```

*Configuration Example: `Tuning Engines` Setup :*

```bash
cat << EOF > .env
# Route chat and embedding calls through the Tuning Engines OpenAI-compatible endpoint.
CHAT_MODEL=openai/<your_chat_model_alias>
EMBEDDING_MODEL=openai/<your_embedding_model_alias>
OPENAI_API_BASE=https://api.tuningengines.com/v1
OPENAI_API_KEY=<replace_with_your_tuning_engines_inference_key>
```

*Configuration Example: `Azure OpenAI` Setup :*

> Before using this configuration, please confirm in advance that your `Azure OpenAI API key` supports `embedded models`.
Expand Down
12 changes: 11 additions & 1 deletion docs/installation_and_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ Option 1: Unified API base for both models
OPENAI_API_BASE=<your_unified_api_base>
OPENAI_API_KEY=<replace_with_your_openai_api_key>

Configuration Example: Tuning Engines Setup
-------------------------------------------

.. code-block:: Properties

# Route chat and embedding calls through the Tuning Engines OpenAI-compatible endpoint.
CHAT_MODEL=openai/<your_chat_model_alias>
EMBEDDING_MODEL=openai/<your_embedding_model_alias>
OPENAI_API_BASE=https://api.tuningengines.com/v1
OPENAI_API_KEY=<replace_with_your_tuning_engines_inference_key>

Option 2: Separate API bases for Chat and Embedding models
----------------------------------------------------------

Expand Down Expand Up @@ -443,4 +454,3 @@ However, this feature is not enabled by default for other scripts. We recommend
export $(grep -v '^#' .env | xargs)

- If you want to change the default environment variables, you can refer to the above configuration and edith the `.env` file.

Loading