mirror of
https://github.com/Significant-Gravitas/Auto-GPT.git
synced 2025-01-09 04:19:02 +08:00
Restructuring The Docs (#5441)
* Adding More Info To The Docs * Start of main page rebuild and adding new folders * Starting to move the AutoGPT(agent) Docs to a subfolder and start setup forge's subfolder * small fixes in links * fix file name * added the benchmakrs page * added front-end page * re-aranging the layout * moved the config section to be under the AutoGPT folder * fix image link * moved "Share Logs" and "Testing" to be under the AutoGPT folder * index.md: fix broken links on home page * Index.md: Testing Something with the links * index.md: Added the Benchmarks section * small fix for Frontend * Added a chat ai to the docs for testing as part of #5694 * index.md: sepetating the sections and making it easier to read * index.md: Added discord Link * index.md: Added better info to each section from @Yash-Ambekar * index.md: trying to fix the layout * Index.md: updating layout * Move Docker Setup To Its Own File * small fix * seperating the installation setups to there own page for making things clear * small fix in links * fix links again * change nav titles color to help make things clear * fix css * mv custom.css * fix for css not working * rm custom css as it didnt work * fix img * update image url * update nav * index.md: improving layout and wordings * index.md: testing line breaks * index.md: Fixed the line breaks * setup/docker-setp.md: small fix * Docker-setup.md update link to correct memory page * docker-setup.md: added note about docker install being broken * Docker-Setup.md: Updating the warning * Docker-Setup.md : Test * docker-setup.md: fix * docker-setup.md: fix * docker-setup.md final update to the warning * Docker-Setup.md * Updates to mkdocs.yml and docker-setup based on the feedback * fix to docker-setup.md * docker-setup.md fix * introduction.md: fix * Update docs/content/AutoGPT/Setups/Docker-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * docker-setup.md update link * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * nogit-setup.md: updated links * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * setup.md: added extra info about the docker insall * setup.md small changs to clean things up * removed emojis from forge get-started.md * get-started.md - small changes * Update AutoGPT intro in index.md --------- Co-authored-by: sohamtembhurne <sohamatembhurne@outlook.com> Co-authored-by: Yash-Ambekar <yashambekar03@gmail.com> Co-authored-by: Nicholas Tindle <nicholas.tindle@agpt.co> Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> Co-authored-by: Reinier van der Leer <pwuts@agpt.co>
This commit is contained in:
Bently
GitHub
parent
0719780c91
commit
bcdc8d46f5
@ -1,38 +1,13 @@
|
||||
# Setting up AutoGPT
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
Choose an environment to run AutoGPT in (pick one):
|
||||
|
||||
- [Docker](https://docs.docker.com/get-docker/) (*recommended*)
|
||||
- Python 3.10 or later (instructions: [for Windows](https://www.tutorialspoint.com/how-to-install-python-in-windows))
|
||||
- [VSCode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
|
||||
|
||||
|
||||
## 🗝️ Getting an API key
|
||||
|
||||
Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
|
||||
|
||||
!!! attention
|
||||
To use the OpenAI API with AutoGPT, we strongly recommend **setting up billing**
|
||||
(AKA paid account). Free accounts are [limited][openai/api limits] to 3 API calls per
|
||||
minute, which can cause the application to crash.
|
||||
|
||||
You can set up a paid account at [Manage account > Billing > Overview](https://platform.openai.com/account/billing/overview).
|
||||
|
||||
[openai/api limits]: https://platform.openai.com/docs/guides/rate-limits/overview#:~:text=Free%20trial%20users,RPM%0A40%2C000%20TPM
|
||||
|
||||
!!! important
|
||||
It's highly recommended that you keep track of your API costs on [the Usage page](https://platform.openai.com/account/usage).
|
||||
You can also set limits on how much you spend on [the Usage limits page](https://platform.openai.com/account/billing/limits).
|
||||
|
||||
|
||||
|
||||
|
||||
## Setting up AutoGPT
|
||||
|
||||
### Set up with Docker
|
||||
|
||||
!!! important "Docker Setup Issue"
|
||||
We are addressing a known issue with the Docker setup related to Poetry.
|
||||
|
||||
[**We have an open PR if you'd like to take a look**](https://github.com/python-poetry/poetry/issues/8548)
|
||||
|
||||
Please keep this in mind. We apologize for any inconvenience, and thank you for your patience.
|
||||
|
||||
|
||||
1. Make sure you have Docker installed, see [requirements](#requirements)
|
||||
2. Create a project directory for AutoGPT
|
||||
|
||||
@ -74,8 +49,6 @@ Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](htt
|
||||
docker pull significantgravitas/auto-gpt
|
||||
```
|
||||
|
||||
6. Continue to [Run with Docker](#run-with-docker)
|
||||
|
||||
!!! note "Docker only supports headless browsing"
|
||||
AutoGPT uses a browser in headless mode by default: `HEADLESS_BROWSER=True`.
|
||||
Please do not change this setting in combination with Docker, or AutoGPT will crash.
|
||||
@ -83,37 +56,6 @@ Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](htt
|
||||
[Docker Hub]: https://hub.docker.com/r/significantgravitas/auto-gpt
|
||||
[repository]: https://github.com/Significant-Gravitas/AutoGPT
|
||||
|
||||
|
||||
### Set up with Git
|
||||
|
||||
!!! important
|
||||
Make sure you have [Git](https://git-scm.com/downloads) installed for your OS.
|
||||
|
||||
!!! info "Executing commands"
|
||||
To execute the given commands, open a CMD, Bash, or Powershell window.
|
||||
On Windows: press ++win+x++ and pick *Terminal*, or ++win+r++ and enter `cmd`
|
||||
|
||||
1. Clone the repository
|
||||
|
||||
```shell
|
||||
git clone https://github.com/Significant-Gravitas/AutoGPT.git
|
||||
```
|
||||
|
||||
2. Navigate to the directory where you downloaded the repository
|
||||
|
||||
```shell
|
||||
cd AutoGPT/autogpts/autogpt
|
||||
```
|
||||
|
||||
### Set up without Git/Docker
|
||||
|
||||
!!! warning
|
||||
We recommend to use Git or Docker, to make updating easier. Also note that some features such as Python execution will only work inside docker for security reasons.
|
||||
|
||||
1. Download `Source code (zip)` from the [latest release](https://github.com/Significant-Gravitas/AutoGPT/releases/latest)
|
||||
2. Extract the zip-file into a folder
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
1. Find the file named `.env.template` in the main `Auto-GPT` folder. This file may
|
||||
@ -159,10 +101,7 @@ Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](htt
|
||||
[openai-python docs]: https://github.com/openai/openai-python#microsoft-azure-endpoints
|
||||
[Azure OpenAI docs]: https://learn.microsoft.com/en-us/azure/cognitive-services/openai/tutorials/embeddings?tabs=command-line
|
||||
|
||||
|
||||
## Running AutoGPT
|
||||
|
||||
### Run with Docker
|
||||
## Running AutoGPT In Docker
|
||||
|
||||
Easiest is to use `docker compose`.
|
||||
|
||||
@ -195,7 +134,7 @@ Once you have a recent version of Docker Compose, run the commands below in your
|
||||
want this, comment or remove the `depends: - redis` and `redis:` sections from
|
||||
`docker-compose.yml`.
|
||||
|
||||
For related settings, see [Memory > Redis setup](./configuration/memory.md#redis-setup).
|
||||
For related settings, see [Memory > Redis setup](../configuration/memory.md)
|
||||
|
||||
You can pass extra arguments, e.g. running with `--gpt3only` and `--continuous`:
|
||||
|
||||
@ -211,47 +150,4 @@ docker run -it --env-file=.env -v $PWD:/app auto-gpt
|
||||
docker run -it --env-file=.env -v $PWD:/app --rm auto-gpt --gpt3only --continuous
|
||||
```
|
||||
|
||||
[Docker Compose file]: https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpts/autogpt/docker-compose.yml
|
||||
|
||||
|
||||
### Run with Dev Container
|
||||
|
||||
1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in VS Code.
|
||||
|
||||
2. Open command palette with ++f1++ and type `Dev Containers: Open Folder in Container`.
|
||||
|
||||
3. Run `./run.sh`.
|
||||
|
||||
|
||||
### Run without Docker
|
||||
|
||||
#### Create a Virtual Environment
|
||||
|
||||
Create a virtual environment to run in.
|
||||
|
||||
```shell
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip3 install --upgrade pip
|
||||
```
|
||||
|
||||
!!! warning
|
||||
Due to security reasons, certain features (like Python execution) will by default be disabled when running without docker. So, even if you want to run the program outside a docker container, you currently still need docker to actually run scripts.
|
||||
|
||||
Simply run the startup script in your terminal. This will install any necessary Python
|
||||
packages and launch AutoGPT.
|
||||
|
||||
- On Linux/MacOS:
|
||||
|
||||
```shell
|
||||
./run.sh
|
||||
```
|
||||
|
||||
- On Windows:
|
||||
|
||||
```shell
|
||||
.\run.bat
|
||||
```
|
||||
|
||||
If this gives errors, make sure you have a compatible Python version installed. See also
|
||||
the [requirements](./installation.md#requirements).
|
||||
[Docker Compose file]: https://github.com/Significant-Gravitas/AutoGPT/blob/stable/docker-compose.yml
|
||||
81
docs/content/AutoGPT/Setups/Git-setup.md
Normal file
81
docs/content/AutoGPT/Setups/Git-setup.md
Normal file
@ -0,0 +1,81 @@
|
||||
### Set up with Git
|
||||
|
||||
!!! important
|
||||
Make sure you have [Git](https://git-scm.com/downloads) installed for your OS.
|
||||
|
||||
!!! info "Executing commands"
|
||||
To execute the given commands, open a CMD, Bash, or Powershell window.
|
||||
On Windows: press ++win+x++ and pick *Terminal*, or ++win+r++ and enter `cmd`
|
||||
|
||||
1. Clone the repository
|
||||
|
||||
```shell
|
||||
git clone -b stable https://github.com/Significant-Gravitas/AutoGPT.git
|
||||
```
|
||||
|
||||
2. Navigate to the directory where you downloaded the repository
|
||||
|
||||
```shell
|
||||
cd AutoGPT/autogpts/autogpt
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
1. Find the file named `.env.template` in the main `Auto-GPT` folder. This file may
|
||||
be hidden by default in some operating systems due to the dot prefix. To reveal
|
||||
hidden files, follow the instructions for your specific operating system:
|
||||
[Windows][show hidden files/Windows] and [macOS][show hidden files/macOS].
|
||||
2. Create a copy of `.env.template` and call it `.env`;
|
||||
if you're already in a command prompt/terminal window:
|
||||
```shell
|
||||
cp .env.template .env
|
||||
```
|
||||
3. Open the `.env` file in a text editor.
|
||||
4. Find the line that says `OPENAI_API_KEY=`.
|
||||
5. Insert your OpenAI API Key directly after = without quotes or spaces..
|
||||
```yaml
|
||||
OPENAI_API_KEY=sk-qwertykeys123456
|
||||
```
|
||||
6. Enter any other API keys or tokens for services you would like to use.
|
||||
|
||||
!!! note
|
||||
To activate and adjust a setting, remove the `# ` prefix.
|
||||
|
||||
7. Save and close the `.env` file.
|
||||
|
||||
!!! info "Using a GPT Azure-instance"
|
||||
If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and
|
||||
make an Azure configuration file:
|
||||
|
||||
- Rename `azure.yaml.template` to `azure.yaml` and provide the relevant `azure_api_base`, `azure_api_version` and all the deployment IDs for the relevant models in the `azure_model_map` section:
|
||||
- `fast_llm_deployment_id`: your gpt-3.5-turbo or gpt-4 deployment ID
|
||||
- `smart_llm_deployment_id`: your gpt-4 deployment ID
|
||||
- `embedding_model_deployment_id`: your text-embedding-ada-002 v2 deployment ID
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
# Please specify all of these values as double-quoted strings
|
||||
# Replace string in angled brackets (<>) to your own deployment Name
|
||||
azure_model_map:
|
||||
fast_llm_deployment_id: "<auto-gpt-deployment>"
|
||||
...
|
||||
```
|
||||
|
||||
Details can be found in the [openai-python docs], and in the [Azure OpenAI docs] for the embedding model.
|
||||
If you're on Windows you may need to install an [MSVC library](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
|
||||
|
||||
[show hidden files/Windows]: https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5
|
||||
[show hidden files/macOS]: https://www.pcmag.com/how-to/how-to-access-your-macs-hidden-files
|
||||
[openai-python docs]: https://github.com/openai/openai-python#microsoft-azure-endpoints
|
||||
[Azure OpenAI docs]: https://learn.microsoft.com/en-us/azure/cognitive-services/openai/tutorials/embeddings?tabs=command-line
|
||||
|
||||
## Running AutoGPT
|
||||
|
||||
### Run with Dev Container
|
||||
|
||||
1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in VS Code.
|
||||
|
||||
2. Open command palette with ++f1++ and type `Dev Containers: Open Folder in Container`.
|
||||
|
||||
3. Run `./run.sh`.
|
||||
85
docs/content/AutoGPT/Setups/nogit-setup.md
Normal file
85
docs/content/AutoGPT/Setups/nogit-setup.md
Normal file
@ -0,0 +1,85 @@
|
||||
### Setting Up without Git/Docker
|
||||
|
||||
!!! warning
|
||||
We recommend to use Git or Docker, to make updating easier. Also note that some features such as Python execution will only work inside docker for security reasons.
|
||||
|
||||
1. Download `Source code (zip)` from the [latest stable release](https://github.com/Significant-Gravitas/AutoGPT/releases/latest)
|
||||
2. Extract the zip-file into a folder
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
1. Find the file named `.env.template` in the main `Auto-GPT` folder. This file may
|
||||
be hidden by default in some operating systems due to the dot prefix. To reveal
|
||||
hidden files, follow the instructions for your specific operating system:
|
||||
[Windows][show hidden files/Windows], [macOS][show hidden files/macOS].
|
||||
2. Create a copy of `.env.template` and call it `.env`;
|
||||
if you're already in a command prompt/terminal window: `cp .env.template .env`.
|
||||
3. Open the `.env` file in a text editor.
|
||||
4. Find the line that says `OPENAI_API_KEY=`.
|
||||
5. After the `=`, enter your unique OpenAI API Key *without any quotes or spaces*.
|
||||
6. Enter any other API keys or tokens for services you would like to use.
|
||||
|
||||
!!! note
|
||||
To activate and adjust a setting, remove the `# ` prefix.
|
||||
|
||||
7. Save and close the `.env` file.
|
||||
|
||||
!!! info "Using a GPT Azure-instance"
|
||||
If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and
|
||||
make an Azure configuration file:
|
||||
|
||||
- Rename `azure.yaml.template` to `azure.yaml` and provide the relevant `azure_api_base`, `azure_api_version` and all the deployment IDs for the relevant models in the `azure_model_map` section:
|
||||
- `fast_llm_deployment_id`: your gpt-3.5-turbo or gpt-4 deployment ID
|
||||
- `smart_llm_deployment_id`: your gpt-4 deployment ID
|
||||
- `embedding_model_deployment_id`: your text-embedding-ada-002 v2 deployment ID
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
# Please specify all of these values as double-quoted strings
|
||||
# Replace string in angled brackets (<>) to your own deployment Name
|
||||
azure_model_map:
|
||||
fast_llm_deployment_id: "<auto-gpt-deployment>"
|
||||
...
|
||||
```
|
||||
|
||||
Details can be found in the [openai-python docs], and in the [Azure OpenAI docs] for the embedding model.
|
||||
If you're on Windows you may need to install an [MSVC library](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
|
||||
|
||||
[show hidden files/Windows]: https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5
|
||||
[show hidden files/macOS]: https://www.pcmag.com/how-to/how-to-access-your-macs-hidden-files
|
||||
[openai-python docs]: https://github.com/openai/openai-python#microsoft-azure-endpoints
|
||||
[Azure OpenAI docs]: https://learn.microsoft.com/en-us/azure/cognitive-services/openai/tutorials/embeddings?tabs=command-line
|
||||
|
||||
|
||||
### Start AutoGPT In A irtual Environment
|
||||
|
||||
First we need to create a virtual environment to run in.
|
||||
|
||||
```shell
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip3 install --upgrade pip
|
||||
```
|
||||
|
||||
!!! warning
|
||||
Due to security reasons, certain features (like Python execution) will by default be disabled when running without docker. So, even if you want to run the program outside a docker container, you currently still need docker to actually run scripts.
|
||||
|
||||
Simply run the startup script in your terminal. This will install any necessary Python
|
||||
packages and launch AutoGPT.
|
||||
|
||||
- On Linux/MacOS:
|
||||
|
||||
```shell
|
||||
./run.sh
|
||||
```
|
||||
|
||||
- On Windows:
|
||||
|
||||
```shell
|
||||
.\run.bat
|
||||
```
|
||||
|
||||
If this gives errors, make sure you have a compatible Python version installed. See also
|
||||
the [requirements](./installation.md#requirements).
|
||||
49
docs/content/AutoGPT/setup.md
Normal file
49
docs/content/AutoGPT/setup.md
Normal file
@ -0,0 +1,49 @@
|
||||
# Setting up AutoGPT
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
Choose an environment to run AutoGPT in (pick one):
|
||||
|
||||
- [Docker](https://docs.docker.com/get-docker/) (*recommended*)
|
||||
- Python 3.10 or later (instructions: [for Windows](https://www.tutorialspoint.com/how-to-install-python-in-windows))
|
||||
- [VSCode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
|
||||
|
||||
|
||||
## 🗝️ Getting an API key
|
||||
|
||||
Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
|
||||
|
||||
!!! attention
|
||||
To use the OpenAI API with AutoGPT, we strongly recommend **setting up billing**
|
||||
(AKA paid account). Free accounts are [limited][openai/api limits] to 3 API calls per
|
||||
minute, which can cause the application to crash.
|
||||
|
||||
You can set up a paid account at [Manage account > Billing > Overview](https://platform.openai.com/account/billing/overview).
|
||||
|
||||
[openai/api limits]: https://platform.openai.com/docs/guides/rate-limits/overview#:~:text=Free%20trial%20users,RPM%0A40%2C000%20TPM
|
||||
|
||||
!!! important
|
||||
It's highly recommended that you keep track of your API costs on [the Usage page](https://platform.openai.com/account/usage).
|
||||
You can also set limits on how much you spend on [the Usage limits page](https://platform.openai.com/account/billing/limits).
|
||||
|
||||
|
||||
|
||||
|
||||
## Setting up AutoGPT
|
||||
|
||||
### If you plan to use Docker please follow this setup.
|
||||
|
||||
!!! important "Docker Setup Issue"
|
||||
We are addressing a known issue with the Docker setup related to Poetry.
|
||||
|
||||
[**We have an open PR if you'd like to take a look**](https://github.com/python-poetry/poetry/issues/8548)
|
||||
|
||||
Please keep this in mind. We apologize for any inconvenience, and thank you for your patience.
|
||||
|
||||
[Docker Install Here.](Setups/Docker-setup.md)
|
||||
|
||||
### If you plan to use Git please follow this setup.
|
||||
[Git Setup Here.](Setups/Git-setup.md)
|
||||
|
||||
### If you dont want to use git or docker for the setup follow here.
|
||||
[No Git Or Docker Setup Here.](Setups/nogit-setup.md)
|
||||
25
docs/content/benchmarks/benchmark.md
Normal file
25
docs/content/benchmarks/benchmark.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Auto-GPT Benchmarks
|
||||
|
||||
Built for the purpose of benchmarking the performance of agents regardless of how they work.
|
||||
|
||||
Objectively know how well your agent is performing in categories like code, retrieval, memory, and safety.
|
||||
|
||||
Save time and money while doing it through smart dependencies. The best part? It's all automated.
|
||||
|
||||
## Scores:
|
||||
|
||||
<img width="733" alt="Screenshot 2023-07-25 at 10 35 01 AM" src="https://github.com/Significant-Gravitas/Auto-GPT-Benchmarks/assets/9652976/98963e0b-18b9-4b17-9a6a-4d3e4418af70">
|
||||
|
||||
## Ranking overall:
|
||||
|
||||
- 1- [Beebot](https://github.com/AutoPackAI/beebot)
|
||||
- 2- [mini-agi](https://github.com/muellerberndt/mini-agi)
|
||||
- 3- [Auto-GPT](https://github.com/Significant-Gravitas/AutoGPT)
|
||||
|
||||
## Detailed results:
|
||||
|
||||
<img width="733" alt="Screenshot 2023-07-25 at 10 42 15 AM" src="https://github.com/Significant-Gravitas/Auto-GPT-Benchmarks/assets/9652976/39be464c-c842-4437-b28a-07d878542a83">
|
||||
|
||||
[Click here to see the results and the raw data!](https://docs.google.com/spreadsheets/d/1WXm16P2AHNbKpkOI0LYBpcsGG0O7D8HYTG5Uj0PaJjA/edit#gid=203558751)!
|
||||
|
||||
More agents coming soon !
|
||||
@ -1,4 +1,3 @@
|
||||
introduction.md
|
||||
# Introduction to Challenges
|
||||
|
||||
Welcome to the AutoGPT Challenges page! This is a space where we encourage community members to collaborate and contribute towards improving AutoGPT by identifying and solving challenges that AutoGPT is not yet able to achieve.
|
||||
|
||||
31
docs/content/forge/get-started.md
Normal file
31
docs/content/forge/get-started.md
Normal file
@ -0,0 +1,31 @@
|
||||
# **AutoGPT-Forge**: Build Your Own AutoGPT Agent!
|
||||
|
||||
### 🌌 Dive into the Universe of AutoGPT Creation! 🌌
|
||||
|
||||
Ever dreamt of becoming the genius behind an AI agent? Dive into the *Forge*, where **you** become the creator!
|
||||
|
||||
---
|
||||
|
||||
### 🛠️ **Why AutoGPT-Forge?**
|
||||
- 💤 **No More Boilerplate!** - Don't let the mundane tasks stop you. Fork and build without the headache of starting from scratch!
|
||||
- 🧠 **Brain-centric Development!** - All the tools you need so you can spend 100% of your time on what matters - crafting the brain of your AI!
|
||||
- 🛠️ **Tooling ecosystem!** - We work with the best in class tools to bring you the best experience possible!
|
||||
---
|
||||
|
||||
### 🚀 **Get Started!**
|
||||
|
||||
The getting started [tutorial series](https://aiedge.medium.com/autogpt-forge-e3de53cc58ec) will guide you through the process of setting up your project all the way through to building a generalist agent.
|
||||
|
||||
1. [AutoGPT Forge: A Comprehensive Guide to Your First Steps](https://aiedge.medium.com/autogpt-forge-a-comprehensive-guide-to-your-first-steps-a1dfdf46e3b4)
|
||||
2. [AutoGPT Forge: The Blueprint of an AI Agent](https://aiedge.medium.com/autogpt-forge-the-blueprint-of-an-ai-agent-75cd72ffde6)
|
||||
3. [AutoGPT Forge: Interacting with your Agent](https://aiedge.medium.com/autogpt-forge-interacting-with-your-agent-1214561b06b)
|
||||
4. [AutoGPT Forge: Crafting Intelligent Agent Logic](https://medium.com/@aiedge/autogpt-forge-crafting-intelligent-agent-logic-bc5197b14cb4)
|
||||
|
||||
|
||||
Coming soon:
|
||||
|
||||
|
||||
3. Interacting with and Benchmarking your Agent
|
||||
4. Abilities
|
||||
5. The Planning Loop
|
||||
6. Memories
|
||||
62
docs/content/front-end/the-ui.md
Normal file
62
docs/content/front-end/the-ui.md
Normal file
@ -0,0 +1,62 @@
|
||||
# AutoGPT Flutter Client
|
||||
|
||||
## Description
|
||||
|
||||
This repository contains the Flutter client for the AutoGPT project. The application facilitates users in discussing various tasks with a single agent. The app is built to be cross-platform and runs on Web, Android, iOS, Windows, and Mac.
|
||||
|
||||
## Features
|
||||
|
||||
- List and manage multiple tasks.
|
||||
- Engage in chat conversations related to selected tasks.
|
||||
|
||||
## Design document
|
||||
|
||||
The design document for this project provides a detailed outline of the architecture, components, and other important aspects of this application. Please note that this is a living, growing document and it is subject to change as the project evolves.
|
||||
|
||||
You can access the design document [here](https://docs.google.com/document/d/1S-o2np1gq5JwFq40wPHDUVLi-mylz4WMvCB8psOUjc8/).
|
||||
|
||||
## Requirements
|
||||
|
||||
- Flutter 3.x
|
||||
- Dart 3.x
|
||||
|
||||
Flutter comes with Dart, to install Flutter, follow the instructions here: https://docs.flutter.dev/get-started/install
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Clone the repo:**
|
||||
```
|
||||
git clone https://github.com/Significant-Gravitas/AutoGPT.git
|
||||
```
|
||||
|
||||
2. **Navigate to the project directory:**
|
||||
```
|
||||
cd AutoGPT/frontend
|
||||
```
|
||||
|
||||
3. **Get Flutter packages:**
|
||||
```
|
||||
flutter pub get
|
||||
```
|
||||
|
||||
4. **Run the app:**
|
||||
```
|
||||
flutter run -d chrome --web-port 5000
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `lib/`: Contains the main source code for the application.
|
||||
- `models/`: Data models that define the structure of the objects used in the app.
|
||||
- `views/`: The UI components of the application.
|
||||
- `viewmodels/`: The business logic and data handling for the views.
|
||||
- `services/`: Contains the service classes that handle communication with backend APIs and other external data sources. These services are used to fetch and update data that the app uses, and they are consumed by the ViewModels.
|
||||
- `test/`: Contains the test files for unit and widget tests.
|
||||
|
||||
## Responsive Design
|
||||
|
||||
The app features a responsive design that adapts to different screen sizes and orientations. On larger screens (Web, Windows, Mac), views are displayed side by side horizontally. On smaller screens (Android, iOS), views are displayed in a tab bar controller layout.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
@ -1,8 +1,63 @@
|
||||
# AutoGPT docs
|
||||
|
||||
Welcome to AutoGPT. Please follow the [Installation](/setup/) guide to get started.
|
||||
Welcome to the AutoGPT Docs.
|
||||
|
||||
!!! note
|
||||
It is recommended to use a virtual machine/container (docker) for tasks that require high security measures to prevent any potential harm to the main computer's system and data. If you are considering to use AutoGPT outside a virtualized/containerized environment, you are *strongly* advised to use a separate user account just for running AutoGPT. This is even more important if you are going to allow AutoGPT to write/execute scripts and run shell commands!
|
||||
The AutoGPT project has been divided into four distinct sections: [Agents](#welcome-to-the-heart-of-autogpt), [Benchmarks](#autogpt-benchmarks), [Forge](#autogpt-forge), and [Frontend](#frontend)
|
||||
|
||||
It is for these reasons that executing python scripts is explicitly disabled when running outside a container environment.
|
||||
---
|
||||
|
||||
## [Welcome to the heart of AutoGPT](AutoGPT/setup.md)
|
||||
|
||||
Welcome to the heart of AutoGPT, 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>
|
||||
|
||||
---
|
||||
|
||||
## [AutoGPT-Benchmarks](benchmarks/benchmark.md)
|
||||
|
||||
Test to impress with AutoGPT Benchmarks! Our benchmarking system offers a stringent testing environment to evaluate your agents objectively.
|
||||
|
||||
- 📈 **Top Performance** - Among our currently benchmarked agents, AutoGPT consistently scores the best. The top-performing generalist agent will earn its position as the primary AutoGPT post-hackathon.
|
||||
|
||||
- 🔌 **Agent Protocol Standardization** - AutoGPT uses the agent protocol from the AI Engineer Foundation to ensure seamless compatibility.
|
||||
|
||||
---
|
||||
|
||||
## [AutoGPT-Forge](forge/get-started.md)
|
||||
|
||||
Forge your future with AutoGPT! The Forge is your innovation lab.
|
||||
|
||||
- 🏗️ **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](front-end/the-ui.md)
|
||||
|
||||
Harness your AI journey with the AutoGPT FrontEnd.
|
||||
|
||||
- 🎮 **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)
|
||||
|
||||
### 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.
|
||||
|
||||
---
|
||||
|
||||
@ -4,21 +4,35 @@ repo_url: https://github.com/Significant-Gravitas/AutoGPT
|
||||
docs_dir: content
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Setup: setup.md
|
||||
- Usage: usage.md
|
||||
- Plugins: plugins.md
|
||||
- Configuration:
|
||||
- Options: configuration/options.md
|
||||
- Search: configuration/search.md
|
||||
- Memory: configuration/memory.md
|
||||
- Voice: configuration/voice.md
|
||||
- Image Generation: configuration/imagegen.md
|
||||
|
||||
- Help us improve AutoGPT:
|
||||
- Share your debug logs with us: share-your-logs.md
|
||||
- Contribution guide: contributing.md
|
||||
- Running tests: testing.md
|
||||
- Code of Conduct: code-of-conduct.md
|
||||
- AutoGPT Agent:
|
||||
- Agent-setup:
|
||||
- Setting up AutoGPT: AutoGPT/setup.md
|
||||
- Docker-setup: AutoGPT/Setups/Docker-setup.md
|
||||
- Git-setup: AutoGPT/Setups/Git-setup.md
|
||||
- No Git/Docker-setup: AutoGPT/Setups/nogit-setup.md
|
||||
- Usage: AutoGPT/usage.md
|
||||
- Plugins: AutoGPT/plugins.md
|
||||
- Configuration:
|
||||
- Options: AutoGPT/configuration/options.md
|
||||
- Search: AutoGPT/configuration/search.md
|
||||
- Memory: AutoGPT/configuration/memory.md
|
||||
- Voice: AutoGPT/configuration/voice.md
|
||||
- Image Generation: AutoGPT/configuration/imagegen.md
|
||||
- Help us improve AutoGPT:
|
||||
- Share your debug logs with us: AutoGPT/share-your-logs.md
|
||||
- Contribution guide: contributing.md
|
||||
- Running tests: AutoGPT/testing.md
|
||||
- Code of Conduct: code-of-conduct.md
|
||||
|
||||
- AutoGPT-Benchmarks:
|
||||
- Benchmarks: benchmarks/benchmark.md
|
||||
|
||||
- AutoGPT-Forge:
|
||||
- Forge-setup: forge/get-started.md
|
||||
|
||||
- Frontend:
|
||||
- Flutter-setup: front-end/the-ui.md
|
||||
|
||||
- Challenges:
|
||||
- Introduction: challenges/introduction.md
|
||||
@ -40,6 +54,7 @@ nav:
|
||||
|
||||
theme:
|
||||
name: material
|
||||
custom_dir: overrides
|
||||
icon:
|
||||
logo: material/book-open-variant
|
||||
favicon: favicon.png
|
||||
|
||||
61
docs/overrides/main.html
Normal file
61
docs/overrides/main.html
Normal file
@ -0,0 +1,61 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
|
||||
{% block extrahead %}
|
||||
<style>
|
||||
svg.ms-w-12 {
|
||||
width: 2rem !important;
|
||||
}
|
||||
svg.ms-h-12 {
|
||||
height: 2rem !important;
|
||||
}
|
||||
/* Temporary solution for the font sizes */
|
||||
#headlessui-dialog-panel-2 p{
|
||||
font-size: 16px;
|
||||
}
|
||||
#headlessui-dialog-panel-2 textarea{
|
||||
font-size: 16px;
|
||||
}
|
||||
#headlessui-dialog-panel-2 span{
|
||||
font-size: 14px;
|
||||
|
||||
}
|
||||
#headlessui-dialog-panel-2 div{
|
||||
font-size: 16px;
|
||||
}
|
||||
#headlessui-dialog-panel-2 a{
|
||||
font-size: 14px;
|
||||
line-height: 1rem;
|
||||
}
|
||||
#headlessui-dialog-panel-2 button{
|
||||
border: 1px solid #0000001d;
|
||||
line-height: 1rem;
|
||||
|
||||
}
|
||||
/* Temporary solution for the font size */
|
||||
#headlessui-dialog-panel-2 > div > div > div > div.ms-w-full.ms-rounded-xl.ms-flex.ms-flex-col.ms-relative > div > div > div > div > div.ms-flex.ms-flex-row.ms-items-center.ms-justify-between.ms-gap-1 > p{
|
||||
font-size: 14px;
|
||||
line-height: 1rem;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
<div id="my-component-root" class="mendable-search"></div>
|
||||
|
||||
<script src="https://unpkg.com/@mendable/search@0.0.155/dist/umd/mendable-bundle.min.js"></script>
|
||||
{% raw %}
|
||||
<script>
|
||||
Mendable.initialize({
|
||||
anon_key: 'a0bd44db-eb3b-412f-8924-b31c58244a64',
|
||||
type: 'floatingButton',
|
||||
style : { accentColor: '#3F51B5', darkMode: false },
|
||||
floatingButtonStyle:{
|
||||
backgroundColor: '#3F51B5',
|
||||
color: '#fff',
|
||||
},
|
||||
icon: "https://mendable-storage.s3.amazonaws.com/autoGPT.gif",
|
||||
botIcon: "https://mendable-storage.s3.amazonaws.com/autoGPTbot.gif",
|
||||
})
|
||||
</script>
|
||||
{% endraw %}
|
||||
{% endblock %}
|
||||
Loading…
Reference in New Issue
Block a user