Wendong-Fan commited on
Commit
9f7283a
·
1 Parent(s): ea2d224

update readme for enviroment variable setting

Browse files
Files changed (3) hide show
  1. README.md +38 -8
  2. README_zh.md +39 -7
  3. owl/.env_template +1 -1
README.md CHANGED
@@ -181,17 +181,47 @@ pip install -r requirements.txt
181
  conda deactivate
182
  ```
183
 
184
- ## **Setup Environment Variables**
185
 
186
- In the `owl/.env_template` file, you will find all the necessary API keys along with the websites where you can register for each service. To use these API services, follow these steps:
187
 
188
- 1. *Copy and Rename*: Duplicate the `.env_template` file and rename the copy to `.env`.
189
- ```bash
190
- cp owl/.env_template .env
191
- ```
192
- 2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields. (For the minimal example (`run_mini.py`), you only need to configure the LLM API key (e.g., OPENAI_API_KEY).)
193
- 3. *For using more other models*: please refer to our CAMEL models docs:https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
194
 
 
195
 
196
  > **Note**: For optimal performance, we strongly recommend using OpenAI models. Our experiments show that other models may result in significantly lower performance on complex tasks and benchmarks.
197
 
 
181
  conda deactivate
182
  ```
183
 
184
+ ## **Setup Environment Variables**
185
 
186
+ OWL requires various API keys to interact with different services. The `owl/.env_template` file contains placeholders for all necessary API keys along with links to the services where you can register for them.
187
 
188
+ ### Option 1: Using a `.env` File (Recommended)
189
+
190
+ 1. **Copy and Rename the Template**:
191
+ ```bash
192
+ cd owl
193
+ cp .env_template .env
194
+ ```
195
+
196
+ 2. **Configure Your API Keys**:
197
+ Open the `.env` file in your preferred text editor and insert your API keys in the corresponding fields.
198
+
199
+ > **Note**: For the minimal example (`run_mini.py`), you only need to configure the LLM API key (e.g., `OPENAI_API_KEY`).
200
+
201
+ ### Option 2: Setting Environment Variables Directly
202
+
203
+ Alternatively, you can set environment variables directly in your terminal:
204
+
205
+ - **macOS/Linux (Bash/Zsh)**:
206
+ ```bash
207
+ export OPENAI_API_KEY="your-openai-api-key-here"
208
+ ```
209
+
210
+ - **Windows (Command Prompt)**:
211
+ ```batch
212
+ set OPENAI_API_KEY="your-openai-api-key-here"
213
+ ```
214
+
215
+ - **Windows (PowerShell)**:
216
+ ```powershell
217
+ $env:OPENAI_API_KEY = "your-openai-api-key-here"
218
+ ```
219
+
220
+ > **Note**: Environment variables set directly in the terminal will only persist for the current session.
221
+
222
+ ### Additional Models
223
 
224
+ For information on configuring other AI models beyond OpenAI, please refer to our [CAMEL models documentation](https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel).
225
 
226
  > **Note**: For optimal performance, we strongly recommend using OpenAI models. Our experiments show that other models may result in significantly lower performance on complex tasks and benchmarks.
227
 
README_zh.md CHANGED
@@ -1,6 +1,6 @@
1
  <h1 align="center">
2
  🦉 OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation
3
- 🦉 OWL: 优化劳动力学习的通用智能体,用于处理现实世界的自动化任务
4
  </h1>
5
 
6
 
@@ -180,15 +180,47 @@ pip install -r requirements.txt
180
  conda deactivate
181
  ```
182
 
183
- ## **设置环境变量**
184
 
185
- `owl/.env_template` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作:
186
 
187
- 1. *复制并重命名*: 复制 `.env_template` 文件,并将副本重命名为 `.env`。
188
- 2. *填写你的密钥*: 打开 `.env` 文件,在相应字段中填入你的 API 密钥。
189
- 3. *如需使用更多其他模型*:请参考我们CAMEL的models文档:https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel
190
 
191
- > **注意**:为获得最佳性能,我们强烈建议使用 OpenAI 模型。我们通过测试发现,其他模型在处理复杂任务和基准测试时可能会导致性能显著降低。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
192
 
193
  ## **使用Docker运行**
194
 
 
1
  <h1 align="center">
2
  🦉 OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation
3
+ 🦉 OWL: 优化劳动力学习的通用智能体,用于处理现实世界的自动化任务
4
  </h1>
5
 
6
 
 
180
  conda deactivate
181
  ```
182
 
183
+ ## **设置环境变量**
184
 
185
+ OWL 需要各种 API 密钥来与不同的服务进行交互。`owl/.env_template` 文件包含了所有必要 API 密钥的占位符,以及可以注册这些服务的链接。
186
 
187
+ ### 选项 1:使用 `.env` 文件(推荐)
 
 
188
 
189
+ 1. **复制并重命名模板**:
190
+ ```bash
191
+ cd owl
192
+ cp .env_template .env
193
+ ```
194
+
195
+ 2. **配置你的 API 密钥**:
196
+ 在你喜欢的文本编辑器中打开 `.env` 文件,并在相应字段中插入你的 API 密钥。
197
+
198
+ > **注意**:对于最小示例(`run_mini.py`),你只需要配置 LLM API 密钥(例如,`OPENAI_API_KEY`)。
199
+
200
+ ### 选项 2:直接设置环境变量
201
+
202
+ 或者,你可以直接在终端中设置环境变量:
203
+
204
+ - **macOS/Linux (Bash/Zsh)**:
205
+ ```bash
206
+ export OPENAI_API_KEY="你的-openai-api-密钥"
207
+ ```
208
+
209
+ - **Windows (命令提示符)**:
210
+ ```batch
211
+ set OPENAI_API_KEY="你的-openai-api-密钥"
212
+ ```
213
+
214
+ - **Windows (PowerShell)**:
215
+ ```powershell
216
+ $env:OPENAI_API_KEY = "你的-openai-api-密钥"
217
+ ```
218
+
219
+ > **注意**:直接在终端中设置的环境变量仅在当前会话中有效。
220
+
221
+ ### 其他模型
222
+
223
+ 有关配置 OpenAI 以外的其他 AI 模型的信息,请参阅我们的 [CAMEL 模型文档](https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel)。
224
 
225
  ## **使用Docker运行**
226
 
owl/.env_template CHANGED
@@ -1,7 +1,7 @@
1
  # MODEL & API (See https://docs.camel-ai.org/key_modules/models.html#)
2
 
3
  # OPENAI API
4
- OPENAI_API_KEY= ""
5
  # OPENAI_API_BASE_URL=""
6
 
7
  # Qwen API (https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key)
 
1
  # MODEL & API (See https://docs.camel-ai.org/key_modules/models.html#)
2
 
3
  # OPENAI API
4
+ # OPENAI_API_KEY= ""
5
  # OPENAI_API_BASE_URL=""
6
 
7
  # Qwen API (https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key)