Skip to content

Commit 4e97cd7

Browse files
committedApr 22, 2024
update docs from config to profiles
1 parent e1da1cd commit 4e97cd7

File tree

7 files changed

+53
-57
lines changed

7 files changed

+53
-57
lines changed
 

‎docs/NCU_MIGRATION_GUIDE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ All stateless LLM attributes have been moved to `interpreter.llm`:
3838
- `interpreter.api_version``interpreter.llm.api_version`
3939
- `interpreter.api_base``interpreter.llm.api_base`
4040

41-
This is reflected **1)** in Python applications using Open Interpreter and **2)** in your configuration file for OI's terminal interface, which can be edited via `interpreter --config`.
41+
This is reflected **1)** in Python applications using Open Interpreter and **2)** in your profiles file for OI's terminal interface, which can be edited via `interpreter --profiles`.
4242

4343
## New Static Messages Structure
4444

‎docs/guides/basic-usage.mdx

+7-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Basic Usage
33
---
44

5-
65
<CardGroup>
76

87
<Card
@@ -102,15 +101,19 @@ interpreter.messages = messages
102101

103102
### Configure Default Settings
104103

105-
We save default settings to a configuration file which can be edited by running the following command:
104+
We save default settings to a profile file which can be edited by running the following command:
106105

107106
```shell
108-
interpreter --config
107+
interpreter --profiles
109108
```
110109

111110
You can use this to set your default language model, system message (custom instructions), max budget, etc.
112111

113-
<Info>**Note:** The Python library will also inherit settings from this config file, but you can only change it by running `interpreter --config` or navigating to `<your application directory>/Open Interpreter/config.yaml` and editing it manually.</Info>
112+
<Info>
113+
**Note:** The Python library will also inherit settings from the default
114+
profile file. You can change it by running `interpreter --profiles` and
115+
editing `default.yaml`.
116+
</Info>
114117

115118
---
116119

‎docs/telemetry/telemetry.mdx

+6-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Use the `--disable_telemetry` flag:
2727
interpreter --disable_telemetry
2828
```
2929

30-
### Configuration File
30+
### Profile
3131

3232
Set `disable_telemetry` to `true`. This will persist to future terminal sessions:
3333

@@ -61,4 +61,8 @@ To view the list of events we track, you may reference the **[code](https://gith
6161

6262
We use **[Posthog](https://posthog.com/)** to store and visualize telemetry data.
6363

64-
<Info>Posthog is an open source platform for product analytics. Learn more about Posthog on **[posthog.com](https://posthog.com/)** or **[github.com/posthog](https://github.com/posthog/posthog)**</Info>
64+
<Info>
65+
Posthog is an open source platform for product analytics. Learn more about
66+
Posthog on **[posthog.com](https://posthog.com/)** or
67+
**[github.com/posthog](https://github.com/posthog/posthog)**
68+
</Info>

‎docs/usage/examples.mdx

+8-4
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,19 @@ interpreter.messages = messages
102102

103103
### Configure Default Settings
104104

105-
We save default settings to a configuration file which can be edited by running the following command:
105+
We save default settings to a profile file which can be edited by running the following command:
106106

107107
```shell
108-
interpreter --config
108+
interpreter --profiles
109109
```
110110

111111
You can use this to set your default language model, system message (custom instructions), max budget, etc.
112112

113-
<Info>**Note:** The Python library will also inherit settings from this config file, but you can only change it by running `interpreter --config` or navigating to `<your application directory>/Open Interpreter/config.yaml` and editing it manually.</Info>
113+
<Info>
114+
**Note:** The Python library will also inherit settings from the default
115+
profile file. You can change it by running `interpreter --profiles` and
116+
editing `default.yaml`.
117+
</Info>
114118

115119
---
116120

@@ -147,4 +151,4 @@ In Python, set the model on the object:
147151
interpreter.llm.model = "gpt-3.5-turbo"
148152
```
149153

150-
[Find the appropriate "model" string for your language model here.](https://docs.litellm.ai/docs/providers/)
154+
[Find the appropriate "model" string for your language model here.](https://docs.litellm.ai/docs/providers/)

‎docs/usage/python/settings.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Settings
33
---
44

5-
Default settings will be inherited from a configuration file in your application directory. **This is true for python and for the terminal interface.**
5+
Default settings will be inherited from a profile in your application directory. **This is true for python and for the terminal interface.**
66

77
To open the file, run:
88

99
```bash
10-
interpreter --config
11-
```
10+
interpreter --profiles
11+
```

‎docs/usage/terminal/arguments.mdx

+10-25
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: Arguments
1212

1313
**[Configuration](/docs/usage/terminal/arguments#Configuration)**
1414

15-
`--config`, `--config_file`, `--custom_instructions`, `--system_message`.
15+
`--profiles`, `--profile`, `--custom_instructions`, `--system_message`.
1616

1717
**[Options](/docs/usage/terminal/arguments#options)**
1818

@@ -230,14 +230,12 @@ llm_supports_functions: true
230230
```
231231

232232
</CodeGroup>
233-
#### `--no-llm_supports_functions`
233+
#### `--no-llm_supports_functions`
234234

235235
Inform Open Interpreter that the language model you're using does not support function calling.
236236

237237
<CodeGroup>
238-
```bash Terminal
239-
interpreter --no-llm_supports_functions
240-
```
238+
```bash Terminal interpreter --no-llm_supports_functions ```
241239
</CodeGroup>
242240

243241
#### `--llm_supports_vision` or `-lsv`
@@ -259,24 +257,24 @@ llm_supports_vision: true
259257

260258
## Configuration
261259

262-
#### `--config`
260+
#### `--profiles`
263261

264-
Opens the configuration yaml file in your default editor.
262+
Opens the directory containing all profiles. They can be edited in your default editor.
265263

266264
<CodeGroup>
267265
```bash Terminal
268-
interpreter --config
266+
interpreter --profilees
269267
```
270268

271269
</CodeGroup>
272270

273-
#### `--config_file` or `-cf`
271+
#### `--profile` or `-p`
274272

275-
Optionally set a custom config file to use.
273+
Optionally set a profile to use.
276274

277275
<CodeGroup>
278276
```bash Terminal
279-
interpreter --config_file "/config.yaml"
277+
interpreter --profile "default.yaml"
280278
```
281279

282280
</CodeGroup>
@@ -298,7 +296,7 @@ custom_instructions: "This is a custom instruction."
298296

299297
#### `--system_message` or `-s`
300298

301-
We don't recommend modifying the system message, as doing so opts you out of future updates to the system message. Use `--custom_instructions` instead, to add relevant information to the system message. If you must modify the system message, you can do so by using this argument, or by opening the config file using `--config`.
299+
We don't recommend modifying the system message, as doing so opts you out of future updates to the system message. Use `--custom_instructions` instead, to add relevant information to the system message. If you must modify the system message, you can do so by using this argument, or by opening the profile using `--profiles`.
302300

303301
<CodeGroup>
304302
```bash Terminal
@@ -309,19 +307,6 @@ interpreter --system_message "You are Open Interpreter..."
309307
system_message: "You are Open Interpreter..."
310308
```
311309

312-
</CodeGroup>
313-
314-
#### `--reset_config`
315-
316-
Resets the config file to the default settings.
317-
318-
<CodeGroup>
319-
```bash Terminal
320-
interpreter --reset_config
321-
```
322-
323-
</CodeGroup>
324-
325310
## Options
326311

327312
#### `--safe_mode`

‎docs/usage/terminal/settings.mdx

+18-18
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
title: Settings
33
---
44

5-
Default settings can be edited via a configuration file. To open the file, run:
5+
Default settings can be edited via a profile. To open the file, run:
66

77
```bash
8-
interpreter --config
8+
interpreter --profiles
99
```
1010

11-
| Key | Value |
12-
|-------------------------|------------------|
13-
| `llm_model` | String ["openai/gpt-4", "openai/local", "azure/gpt-3.5"] |
14-
| `llm_temperature` | Float [0.0 -> 1.0] |
15-
| `llm_supports_vision` | Boolean [True/False] |
16-
| `llm_supports_functions`| Boolean [True/False] |
17-
| `llm_context_window` | Integer [3000] |
18-
| `llm_max_tokens` | Integer [3000] |
19-
| `llm_api_base` | String ["http://ip_address:port", "https://openai.com"] |
20-
| `llm_api_key` | String ["sk-Your-Key"] |
21-
| `llm_api_version` | String ["version-number"] |
22-
| `llm_max_budget` | Float [0.01] #USD $0.01 |
23-
| `offline` | Boolean [True/False] |
24-
| `vision` | Boolean [True/False] |
25-
| `auto_run` | Boolean [True/False] |
26-
| `verbose` | Boolean [True/False] |
11+
| Key | Value |
12+
| ------------------------ | -------------------------------------------------------- |
13+
| `llm_model` | String ["openai/gpt-4", "openai/local", "azure/gpt-3.5"] |
14+
| `llm_temperature` | Float [0.0 -> 1.0] |
15+
| `llm_supports_vision` | Boolean [True/False] |
16+
| `llm_supports_functions` | Boolean [True/False] |
17+
| `llm_context_window` | Integer [3000] |
18+
| `llm_max_tokens` | Integer [3000] |
19+
| `llm_api_base` | String ["http://ip_address:port", "https://openai.com"] |
20+
| `llm_api_key` | String ["sk-Your-Key"] |
21+
| `llm_api_version` | String ["version-number"] |
22+
| `llm_max_budget` | Float [0.01] #USD $0.01 |
23+
| `offline` | Boolean [True/False] |
24+
| `vision` | Boolean [True/False] |
25+
| `auto_run` | Boolean [True/False] |
26+
| `verbose` | Boolean [True/False] |

0 commit comments

Comments
 (0)
Please sign in to comment.