Skip to content

Clarity updates to README.md #674

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

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Clarity updates to README.md #674

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8fcac1
Clarity updates to README.md
shruti222patel Oct 22, 2023
d4e56b0
Merge branch 'main' into patch-1
KillianLucas Oct 25, 2023
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ interpreter --local --model tiiuae/falcon-180B

You can easily modify the `max_tokens` and `context_window` (in tokens) of locally running models.

Smaller context windows will use less RAM, so we recommend trying a shorter window if GPU is failing.
Smaller context windows will use less RAM, so we recommend trying a shorter window if the GPU is failing.

```shell
interpreter --max_tokens 2000 --context_window 16000
Expand Down Expand Up @@ -241,7 +241,7 @@ In the interactive mode, you can use the below commands to enhance your experien
• `%debug [true/false]`: Toggle debug mode. Without arguments or with 'true', it
enters debug mode. With 'false', it exits debug mode.
• `%reset`: Resets the current session.
• `%undo`: Remove previous messages and their response from the message history.
• `%undo`: Remove the previous user message and the AI's response from the message history.
• `%save_message [path]`: Saves messages to a specified JSON path. If no path is
provided, it defaults to 'messages.json'.
• `%load_message [path]`: Loads messages from a specified JSON path. If no path
Expand Down Expand Up @@ -347,7 +347,7 @@ You can run `interpreter -y` or set `interpreter.auto_run = True` to bypass this

- Be cautious when requesting commands that modify files or system settings.
- Watch Open Interpreter like a self-driving car, and be prepared to end the process by closing your terminal.
- Consider running Open Interpreter in a restricted environment like Google Colab or Replit. These environments are more isolated, reducing the risks associated with executing arbitrary code.
- Consider running Open Interpreter in a restricted environment like Google Colab or Replit. These environments are more isolated, reducing the risks of executing arbitrary code.

## How Does it Work?

Expand All @@ -363,7 +363,7 @@ Please see our [Contributing Guidelines](./CONTRIBUTING.md) for more details on

## License

Open Interpreter is licensed under the MIT License. You are permitted to use, copy, modify, distribute, sublicense and sell copies of the software.
Open Interpreter is licensed under the MIT License. You are permitted to use, copy, modify, distribute, sublicense, and sell copies of the software.

**Note**: This software is not affiliated with OpenAI.

Expand Down