mirror of
https://github.com/aljazceru/Auto-GPT.git
synced 2025-12-17 05:54:26 +01:00
24008e8741
* README.md
- Mark evo.ninja as hackathon winner and new Current Best Agent.
- Remove hackathon banner.
- Rewrite sections about Forge, Benchmark, UI, Agent Protocol.
- Add sections about Leaderboard and CLI.
- Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide.
- Remove Quickstart.
* docs.agpt.co
- Removed links to outdated pages from navbar.
- Added quick links to several pages.
- Refactored and updated titles in docs site navbar for better readability and consistency.
- Rewrite intros on homepage to be more clear and professional and less cringe-worthy.
- Fix broken links.
- Rewrote setup and usage guides for AutoGPT Agent.
- Removed mentions of Azure support, except in the Docker guide.
- Added page with general information about AutoGPT.
* CONTRIBUTING.md
- Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs.
* autogpt/README.md
- Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4.
- Add quick links for improved user navigation, including links to documentation and contributing guidelines.
- Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development.
- Update links: documentation, setup instructions.
- Remove outdated Twitter accounts section.
90 lines
3.6 KiB
Markdown
90 lines
3.6 KiB
Markdown
# AutoGPT Documentation
|
|
|
|
Welcome to the AutoGPT 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/index.md)**
|
|
 | 
|
|
**[🔧 Setup](AutoGPT/setup/index.md)**
|
|
 | 
|
|
**[💻 Usage](AutoGPT/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/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/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.
|
|
|
|
---
|
|
|
|
🤔 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.
|
|
|
|
---
|