You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Note**: The machine where the AIOS kernel (AIOS) is installed must also have the AIOS SDK (Cerebrum) installed. Installing AIOS kernel will install the AIOS SDK automatically by default. If you are using the Local Kernel mode, i.e., you are running AIOS and agents on the same machine, then simply install both AIOS and Cerebrum on that machine. If you are using Remote Kernel mode, i.e., running AIOS on Machine 1 and running agents on Machine 2 and the agents remotely interact with the kernel, then you need to install both AIOS kernel and AIOS SDK on Machine 1, and install the AIOS SDK alone on Machine 2. Please follow the guidelines at [Cerebrum](https://github.com/agiresearch/Cerebrum) regarding how to install the SDK.
191
+
192
+
### Quickstart
193
+
Before launching AIOS, it is required to set up configurations. AIOS provides two ways of setting up configurations, one is to set up by directly modifying the configuration file, another is to set up interactively.
194
+
195
+
#### Set up configuration file directly (Recommended)
131
196
You need API keys for services like OpenAI, Anthropic, Groq and HuggingFace. The simplest way to configure them is to edit the `aios/config/config.yaml`.
132
197
133
198
> [!TIP]
@@ -204,10 +269,9 @@ You can configure HuggingFace models with specific GPU memory allocation:
204
269
eval_device: "cuda:0" # Device for model evaluation
205
270
```
206
271
207
-
##### Detailed Setup Instructions
208
-
For detailed instructions on setting up API keys and configuration files, see [Environment Variables Configuration](https://app.gitbook.com/o/6h6b4xbBVMu2pFXdNM0D/s/5h7XvlMFgKMtRboLGG1i/~/diff/~/changes/73/getting-started/environment-variables-configuration).
272
+
#### Set up interactively
209
273
210
-
Alternatively, you can set them as environment variables directly:
274
+
Alternatively, you can set up aios configurations interactively by using the following command.
211
275
212
276
- `aios env list`: Show current environment variables, or show available API keys if no variables are set
213
277
- `aios env set`: Show current environment variables, or show available API keys if no variables are set
@@ -224,72 +288,6 @@ When no environment variables are set, the following API keys will be shown:
224
288
- `HF_AUTH_TOKEN`: HuggingFace authentication token for accessing models
225
289
- `HF_HOME`: Optional path to store HuggingFace models
226
290
227
-
228
-
229
-
#### Installation from source
230
-
231
-
##### Step 1: Install AIOS Kernel
232
-
Git clone AIOS kernel
233
-
```bash
234
-
git clone https://github.com/agiresearch/AIOS.git
235
-
```
236
-
Create venv environment
237
-
```bash
238
-
python3.x -m venv venv # Only support for Python 3.10 and 3.11
239
-
source venv/bin/activate
240
-
```
241
-
or create conda environment
242
-
```bash
243
-
conda create -n venv python=3.x # Only support for Python 3.10 and 3.11
244
-
conda activate venv
245
-
```
246
-
247
-
> [!TIP]
248
-
> We strongly recommend using [uv](https://github.com/astral-sh/uv) for faster and more reliable package installation.
**Note**: The machine where the AIOS kernel (AIOS) is installed must also have the AIOS SDK (Cerebrum) installed. Installing AIOS kernel will install the AIOS SDK automatically by default. If you are using the Local Kernel mode, i.e., you are running AIOS and agents on the same machine, then simply install both AIOS and Cerebrum on that machine. If you are using Remote Kernel mode, i.e., running AIOS on Machine 1 and running agents on Machine 2 and the agents remotely interact with the kernel, then you need to install both AIOS kernel and AIOS SDK on Machine 1, and install the AIOS SDK alone on Machine 2. Please follow the guidelines at [Cerebrum](https://github.com/agiresearch/Cerebrum) regarding how to install the SDK.
290
-
291
-
### Quickstart
292
-
293
291
#### Launch AIOS
294
292
After you setup your keys or environment parameters, then you can follow the instructions below to start.
0 commit comments