-
Notifications
You must be signed in to change notification settings - Fork 44.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Kaitlyn Barnard
authored and
Kaitlyn Barnard
committed
Oct 24, 2024
1 parent
e908068
commit f300a34
Showing
51 changed files
with
674 additions
and
604 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
# AutoGPT Agent | ||
|
||
[🔧 **Setup**](setup/index.md) | ||
 |  | ||
[💻 **User guide**](./usage.md) | ||
 |  | ||
[🐙 **GitHub**](https://github.com/Significant-Gravitas/AutoGPT/tree/master/autogpt) | ||
|
||
**Location:** `classic/original_autogpt/` in the GitHub repo | ||
|
||
AutoGPT was conceived when OpenAI published their GPT-4 model accompanied by a paper | ||
outlining the advanced reasoning and task-solving abilities of the model. The concept | ||
was (and still is) fairly simple: let an LLM decide what to do over and over, while | ||
feeding the results of its actions back into the prompt. This allows the program to | ||
iteratively and incrementally work towards its objective. | ||
|
||
The fact that this program is able to execute actions on behalf of its user makes | ||
it an **agent**. In the case of AutoGPT, the user still has to authorize every action, | ||
but as the project progresses we'll be able to give the agent more autonomy and only | ||
require consent for select actions. | ||
|
||
AutoGPT is a **generalist agent**, meaning it is not designed with a specific task in | ||
mind. Instead, it is designed to be able to execute a wide range of tasks across many | ||
disciplines, as long as it can be done on a computer. | ||
|
||
## Coming soon | ||
* How does AutoGPT work? | ||
* What can I use AutoGPT for? | ||
* What does the future of AutoGPT look like? | ||
|
||
# AutoGPT Classic Documentation | ||
|
||
Welcome to the AutoGPT Classic Documentation. | ||
|
||
The AutoGPT project consists of four main components: | ||
|
||
- The [Agent](#agent) – also known as just "AutoGPT" | ||
- The [Benchmark](#benchmark) – AKA `agbenchmark` | ||
- The [Forge](#forge) | ||
- The [Frontend](#frontend) | ||
|
||
To tie these together, we also have a [CLI] at the root of the project. | ||
|
||
## 🤖 Agent | ||
|
||
**[📖 About AutoGPT](#autogpt-agent)** | ||
 |  | ||
**[🔧 Setup](setup/index.md)** | ||
 |  | ||
**[💻 Usage](./usage.md)** | ||
|
||
The heart of AutoGPT, and the project that kicked it all off: a semi-autonomous agent powered by LLMs to execute any task for you*. | ||
|
||
We continue to develop this project with the goal of providing access to AI assistance to the masses, and building the future transparently and together. | ||
|
||
- 💡 **Explore** - See what AI can do and be inspired by a glimpse of the future. | ||
|
||
- 🚀 **Build with us** - We welcome any input, whether it's code or ideas for new features or improvements! Join us on [Discord](https://discord.gg/autogpt) and find out how you can join in on the action. | ||
|
||
<small>* it isn't quite there yet, but that is the ultimate goal that we are still pursuing</small> | ||
|
||
--- | ||
|
||
## 🎯 Benchmark | ||
|
||
**[🗒️ Readme](https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/benchmark/README.md)** | ||
|
||
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 | ||
|
||
- 🔌 **Agent Protocol Standardization** - AutoGPT uses the agent protocol from the AI Engineer Foundation to ensure compatibility with many agents, both from within and outside the project. | ||
|
||
--- | ||
|
||
## 🏗️ Forge | ||
|
||
**[📖 Introduction](../forge/get-started.md)** | ||
 |  | ||
**[🚀 Quickstart](https://github.com/Significant-Gravitas/AutoGPT/blob/master/QUICKSTART.md)** | ||
|
||
<!-- TODO: have the guides all in one place --> | ||
|
||
Forge your own agent! The 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. | ||
|
||
- 🛠️ **Building with Ease** - We've set the groundwork so you can focus on your agent's personality and capabilities. Comprehensive tutorials are available [here](https://aiedge.medium.com/autogpt-forge-e3de53cc58ec). | ||
|
||
--- | ||
|
||
## 💻 Frontend | ||
|
||
**[🗒️ Readme](https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/frontend/README.md)** | ||
|
||
An easy-to-use and open source frontend for any Agent Protocol-compliant agent. | ||
|
||
- 🎮 **User-Friendly Interface** - Manage your agents effortlessly. | ||
|
||
- 🔄 **Seamless Integration** - Smooth connectivity between your agent and our benchmarking system. | ||
|
||
--- | ||
|
||
## 🔧 CLI | ||
[CLI]: #cli | ||
|
||
The project CLI makes it easy to use all of the components in the repo, separately or | ||
together. To install its dependencies, simply run `./run setup`, and you're ready to go! | ||
|
||
```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. | ||
``` | ||
|
||
Common commands: | ||
|
||
* `./run agent start autogpt` – [runs](./usage.md#serve-agent-protocol-mode-with-ui) the AutoGPT agent | ||
* `./run agent create <name>` – creates a new Forge-based agent project at `agents/<name>` | ||
* `./run benchmark start <agent>` – benchmarks the specified agent | ||
|
||
--- | ||
|
||
🤔 Join the AutoGPT Discord server for any queries: | ||
[discord.gg/autogpt](https://discord.gg/autogpt) | ||
|
||
### Glossary of Terms | ||
|
||
- **Repository**: Space where your project resides. | ||
- **Forking**: Copying a repository under your account. | ||
- **Cloning**: Making a local copy of a repository. | ||
- **Agent**: The AutoGPT you'll create and develop. | ||
- **Benchmarking**: Testing your agent's skills in the Forge. | ||
- **Forge**: The template for building your AutoGPT agent. | ||
- **Frontend**: The UI for tasks, logs, and task history. |
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
docs/content/server/advanced_setup.md → docs/content/platform/advanced_setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.