Skip to content

Commit

Permalink
docs(README): minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Aug 20, 2024
1 parent 16d3acb commit c43cc8a
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,13 @@ You can find more demos on the [Demos page](https://erik.bjareholt.com/gptme/doc
## 🌟 Features

- 💻 Code execution
- Directly execute code (shell and Python) in your local environment.
- Executed code maintains state in a REPL-like manner.
- Executes code in your local environment with bash and IPython tools.
- 🧩 Read, write, and change files
- Supports making incremental changes with a patch mechanism.
- Makes incremental changes with a patch mechanism.
- 🌐 Search and browse the web.
- Equipped with a browser via Playwright.
- 👀 Vision
- Can see images whose paths you reference in prompts.
- Can see images whose paths are referenced in prompts.
- 🔄 Self-correcting
- Output is fed back to the assistant, allowing it to respond and self-correct.
- 🤖 Support for several LLM providers
Expand All @@ -158,7 +157,7 @@ You can find more demos on the [Demos page](https://erik.bjareholt.com/gptme/doc
- Passing a filename as an argument will read the file and include it as context.
- 💬 Optional basic Web UI and REST API

🛠 Developer perks:
### 🛠 Developer perks

- 🧰 Easy to extend
- Most functionality is implemented as [tools](https://erik.bjareholt.com/gptme/docs/tools.html), making it easy to add new features.
Expand All @@ -168,7 +167,7 @@ You can find more demos on the [Demos page](https://erik.bjareholt.com/gptme/doc
- Operates in this repo! (see [#18](https://github.com/ErikBjare/gptme/issues/18) for example)
- Runs entirely in GitHub Actions.

🚧 In progress:
### 🚧 In progress

- 📝 Handle long contexts intelligently through summarization, truncation, pinning, and subagents.
- 🌐 Interact with and automate the web.
Expand Down Expand Up @@ -315,12 +314,9 @@ If fine-tuned, I would expect improvements in:
- how it structures commands
- how it recovers from errors
- reducing the length of the system prompt
- reducing refusals
- and more...

### 📦 Running in a sandbox

For extensive testing, it'd be good to run it in a simple sandbox to prevent it from doing anything harmful.

## 🔀 Alternatives

Looking for other similar projects? Check out [Are Copilots Local Yet?](https://github.com/ErikBjare/are-copilots-local-yet)
Expand Down

0 comments on commit c43cc8a

Please sign in to comment.