Skip to content

Commit cfdc266

Browse files
TPLin22qew21
authored andcommitted
docs: update llm setting guidance and "REASONING_THINK_RM" description (#943)
* update llm setting guidance and "REASONING_THINK_RM" description * remove deprecated backend in readme
1 parent 74ed7a4 commit cfdc266

File tree

2 files changed

+17
-28
lines changed

2 files changed

+17
-28
lines changed

README.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -151,41 +151,24 @@ Ensure the current user can run Docker commands **without using sudo**. You can
151151
- json_mode
152152
- embedding query
153153

154-
- For example: If you are using the `OpenAI API`, you have to configure your GPT model in the `.env` file like this.
155-
```bash
156-
cat << EOF > .env
157-
OPENAI_API_KEY=<replace_with_your_openai_api_key>
158-
# EMBEDDING_MODEL=text-embedding-3-small
159-
CHAT_MODEL=gpt-4-turbo
160-
EOF
161-
```
162-
- However, not every API services support these features by default. For example: `AZURE OpenAI`, you have to configure your GPT model in the `.env` file like this.
163-
```bash
164-
cat << EOF > .env
165-
USE_AZURE=True
166-
EMBEDDING_OPENAI_API_KEY=<replace_with_your_azure_openai_api_key>
167-
EMBEDDING_AZURE_API_BASE=<replace_with_your_azure_endpoint>
168-
EMBEDDING_AZURE_API_VERSION=<replace_with_the_version_of_your_azure_openai_api>
169-
EMBEDDING_MODEL=text-embedding-3-small
170-
CHAT_OPENAI_API_KEY=<replace_with_your_azure_openai_api_key>
171-
CHAT_AZURE_API_BASE=<replace_with_your_azure_endpoint>
172-
CHAT_AZURE_API_VERSION=<replace_with_the_version_of_your_azure_openai_api>
173-
CHAT_MODEL=<replace_it_with_the_name_of_your_azure_chat_model>
174-
EOF
175-
```
154+
You can set your Chat Model and Embedding Model in the following ways:
176155

177-
- We now support LiteLLM as a backend for integration with multiple LLM providers. If you use LiteLLM Backend to use models, you can configure as follows:
156+
- **Using LiteLLM (Recommended)**: We now support LiteLLM as a backend for integration with multiple LLM providers. You can configure as follows:
178157
```bash
179158
cat << EOF > .env
180159
BACKEND=rdagent.oai.backend.LiteLLMAPIBackend
181-
# It can be modified to any model supported by LiteLLM.
182-
CHAT_MODEL=gpt-4o
160+
# Set to any model supported by LiteLLM.
161+
CHAT_MODEL=gpt-4o
183162
EMBEDDING_MODEL=text-embedding-3-small
184-
# The backend api_key fully follow the convention of litellm.
163+
# Then configure the environment variables required by your chosen model in the convention of LiteLLM here.
185164
OPENAI_API_KEY=<replace_with_your_openai_api_key>
186165
```
187-
188-
- For more configuration information, please refer to the [documentation](https://rdagent.readthedocs.io/en/latest/installation_and_configuration.html).
166+
Notice: If you are using reasoning models that include thought processes in their responses (such as \<think> tags), you need to set the following environment variable:
167+
```bash
168+
REASONING_THINK_RM=True
169+
```
170+
171+
- You can also use a deprecated backend if you only use `OpenAI API` or `Azure OpenAI` directly. For this deprecated setting and more configuration information, please refer to the [documentation](https://rdagent.readthedocs.io/en/latest/installation_and_configuration.html).
189172
190173
### 🚀 Run the Application
191174

docs/installation_and_configuration.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ For example, if you are using a DeepSeek model, you need to set as follows:
5151
CHAT_MODEL=deepseek/deepseek-chat
5252
DEEPSEEK_API_KEY=<replace_with_your_deepseek_api_key>
5353
54+
Besides, when you are using reasoning models, the response might include the thought process. For this case, you need to set the following environment variable:
55+
56+
.. code-block:: Properties
57+
58+
REASONING_THINK_RM=True
59+
5460
For more details on LiteLLM requirements, refer to the `official LiteLLM documentation <https://docs.litellm.ai/docs>`_.
5561

5662

0 commit comments

Comments
 (0)