autogpt / docs /content /index.md
kakumusic's picture
Upload folder using huggingface_hub
b225a21 verified
|
raw
history blame
5 kB

AutoGPT Documentation

Welcome to the AutoGPT Documentation.

The AutoGPT project consists of four main components:

To tie these together, we also have a CLI at the root of the project.

๐ŸŒ Server

๐Ÿ“– Setup โ€‚|โ€‚ ๐Ÿ“– Advanced Setup โ€‚|โ€‚ ๐Ÿ“– Making New Blocks

The server is the backbone of the New AutoGPT project. It provides the infrastructure for the agents to run, and the UI for you to interact with them. It integrates with the Forge, Agent, and a bespoke UI to provide a seamless experience.


๐Ÿค– Agent

๐Ÿ“– About AutoGPT โ€‚|โ€‚ ๐Ÿ”ง Setup โ€‚|โ€‚ ๐Ÿ’ป Usage

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 and find out how you can join in on the action.

* it isn't quite there yet, but that is the ultimate goal that we are still pursuing


๐ŸŽฏ Benchmark

๐Ÿ—’๏ธ Readme

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.

  • ๐Ÿ“ฆ 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 โ€‚|โ€‚ ๐Ÿš€ Quickstart

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.

๐Ÿ’ป Frontend

๐Ÿ—’๏ธ Readme

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

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!

$ ./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 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

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.