106 lines
5.0 KiB
Markdown
106 lines
5.0 KiB
Markdown
# AutoGPT: build & use AI agents
|
||
|
||
[](https://discord.gg/autogpt)  
|
||
[](https://twitter.com/Auto_GPT)  
|
||
[](https://opensource.org/licenses/MIT)
|
||
|
||
**AutoGPT** is a generalist LLM based AI agent that can autonomously accomplish minor tasks.
|
||
|
||
**Examples**:
|
||
|
||
- Look up and summarize this research paper
|
||
- Write a marketing for food supplements
|
||
- Write a blog post detailing the news in AI
|
||
|
||
Our mission is to provide the tools, so that you can focus on what matters:
|
||
|
||
- 🏗️ **Building** - Lay the foundation for something amazing.
|
||
- 🧪 **Testing** - Fine-tune your agent to perfection.
|
||
- 🤝 **Delegating** - Let AI work for you, and have your ideas come to life.
|
||
|
||
Be part of the revolution! **AutoGPT** is here to stay, at the forefront of AI innovation.
|
||
|
||
**📖 [Documentation](https://docs.agpt.co)**
|
||
 | 
|
||
**🚀 [Contributing](CONTRIBUTING.md)**
|
||
 | 
|
||
**🛠️ [Build your own Agent - Quickstart](FORGE-QUICKSTART.md)**
|
||
|
||
## 🧱 Building blocks
|
||
|
||
### 🏗️ Forge
|
||
|
||
**Forge your own agent!** – Forge is a ready-to-go template for your agent application. All the boilerplate code is already handled, letting you channel all your creativity into the things that set *your* agent apart. All tutorials are located [here](https://medium.com/@aiedge/autogpt-forge-e3de53cc58ec). Components from the [`forge.sdk`](/forge/forge/sdk) can also be used individually to speed up development and reduce boilerplate in your agent project.
|
||
|
||
🚀 [**Getting Started with Forge**](https://github.com/Significant-Gravitas/AutoGPT/blob/master/forge/tutorials/001_getting_started.md) –
|
||
This guide will walk you through the process of creating your own agent and using the benchmark and user interface.
|
||
|
||
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/forge) about Forge
|
||
|
||
### 🎯 Benchmark
|
||
|
||
**Measure your agent's performance!** The `agbenchmark` can be used with any agent that supports the agent protocol, and the integration with the project's [CLI] makes it even easier to use with AutoGPT and forge-based agents. The benchmark offers a stringent testing environment. Our framework allows for autonomous, objective performance evaluations, ensuring your agents are primed for real-world action.
|
||
|
||
<!-- TODO: insert visual demonstrating the benchmark -->
|
||
|
||
📦 [`agbenchmark`](https://pypi.org/project/agbenchmark/) on Pypi
|
||
 | 
|
||
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/blob/master/benchmark) about the Benchmark
|
||
|
||
### 💻 UI
|
||
|
||
**Makes agents easy to use!** The `frontend` gives you a user-friendly interface to control and monitor your agents. It connects to agents through the [agent protocol](#-agent-protocol), ensuring compatibility with many agents from both inside and outside of our ecosystem.
|
||
|
||
<!-- TODO: insert screenshot of front end -->
|
||
|
||
The frontend works out-of-the-box with all agents in the repo. Just use the [CLI] to run your agent of choice!
|
||
|
||
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/frontend) about the Frontend
|
||
|
||
### ⌨️ CLI
|
||
|
||
[CLI]: #-cli
|
||
|
||
To make it as easy as possible to use all of the tools offered by the repository, a CLI is included at the root of the repo:
|
||
|
||
```shell
|
||
$ ./run
|
||
Usage: cli.py [OPTIONS] COMMAND [ARGS]...
|
||
|
||
Options:
|
||
--help Show this message and exit.
|
||
|
||
Commands:
|
||
agent Commands to create, start and stop agents
|
||
benchmark Commands to start the benchmark and list tests and categories
|
||
setup Installs dependencies needed for your system.
|
||
```
|
||
|
||
Just clone the repo, install dependencies with `./run setup`, and you should be good to go!
|
||
|
||
## 🤔 Questions? Problems? Suggestions?
|
||
|
||
### Get help - [Discord 💬](https://discord.gg/autogpt)
|
||
|
||
[](https://discord.gg/autogpt)
|
||
|
||
To report a bug or request a feature, create a [GitHub Issue](https://github.com/Significant-Gravitas/AutoGPT/issues/new/choose). Please ensure someone else hasn’t created an issue for the same topic.
|
||
|
||
## 🤝 Sister projects
|
||
|
||
### 🔄 Agent Protocol
|
||
|
||
To maintain a uniform standard and ensure seamless compatibility with many current and future applications, AutoGPT employs the [agent protocol](https://agentprotocol.ai/) standard by the AI Engineer Foundation. This standardizes the communication pathways from your agent to the frontend and benchmark.
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<a href="https://star-history.com/#Significant-Gravitas/AutoGPT">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" />
|
||
</picture>
|
||
</a>
|
||
</p>
|