github/AutoGPT
1
1
Fork 0
mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-04-08 03:00:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
SwiftyOS
2024-09-20 11:32:38 +02:00
parent be16fd90d4
commit ba206e3bec
14 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
classic/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
View File

0
classic/CONTRIBUTING.md → CONTRIBUTING.md
View File

2
README.md
View File

@@ -58,7 +58,7 @@ Be part of the revolution! **AutoGPT** is here to stay, at the forefront of AI i
**🛠️ [Build your own Agent - Quickstart](FORGE-QUICKSTART.md)**
### 🏗️ 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`](/classic/forge/classic/forge/sdk) can also be used individually to speed up development and reduce boilerplate in your agent project.
**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/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/classic/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.

2
classic/Dockerfile.autogpt
View File

@@ -51,7 +51,7 @@ ONBUILD COPY classic/original_autogpt/ ./
FROM autogpt-base as autogpt-release
RUN poetry install --no-cache --no-root --without dev \
&& rm -rf $(poetry env info --path)/src
ONBUILD COPY classic/original_autogpt/classic/original_autogpt/ ./autogpt
ONBUILD COPY classic/original_autogpt/ ./autogpt
ONBUILD COPY classic/original_autogpt/scripts/ ./scripts
ONBUILD COPY classic/original_autogpt/plugins/ ./plugins
ONBUILD COPY classic/original_autogpt/README.md ./README.md

2
classic/original_autogpt/autogpt/agents/README.md
View File

@@ -34,4 +34,4 @@ class MyAgent(Agent):
self.my_component = MyComponent()
```
For more customization, you can override the `propose_action` and `execute` or even subclass `BaseAgent` directly. This way you can have full control over the agent's components and behavior. Have a look at the [implementation of Agent](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/classic/original_autogpt/agents/agent.py) for more details.
For more customization, you can override the `propose_action` and `execute` or even subclass `BaseAgent` directly. This way you can have full control over the agent's components and behavior. Have a look at the [implementation of Agent](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/agents/agent.py) for more details.

2
docs/content/AutoGPT/configuration/options.md
View File

@@ -9,7 +9,7 @@ You can set configuration variables via the `.env` file. If you don't have a `.e
- `ANTHROPIC_API_KEY`: Set this if you want to use Anthropic models with AutoGPT
- `AZURE_CONFIG_FILE`: Location of the Azure Config file relative to the AutoGPT root directory. Default: azure.yaml
- `COMPONENT_CONFIG_FILE`: Path to the component configuration file (json) for an agent. Optional
- `DISABLED_COMMANDS`: Commands to disable. Use comma separated names of commands. See the list of commands from built-in components [here](../../classic/forge/components/components.md). Default: None
- `DISABLED_COMMANDS`: Commands to disable. Use comma separated names of commands. See the list of commands from built-in components [here](../../forge/components/components.md). Default: None
- `ELEVENLABS_API_KEY`: ElevenLabs API Key. Optional.
- `ELEVENLABS_VOICE_ID`: ElevenLabs Voice ID. Optional.
- `EMBEDDING_MODEL`: LLM Model to use for embedding tasks. Default: `text-embedding-3-small`

2
docs/content/AutoGPT/configuration/search.md
View File

@@ -3,7 +3,7 @@
!!! note
This section is optional. Use the official Google API if search attempts return
error 429. To use the `google` command, you need to set up your
Google API key in your environment variables or pass it with configuration to the [`WebSearchComponent`](../../classic/forge/components/built-in-components.md).
Google API key in your environment variables or pass it with configuration to the [`WebSearchComponent`](../../forge/components/built-in-components.md).
Create your project:

2
docs/content/AutoGPT/setup/docker.md
View File

@@ -89,7 +89,7 @@
```
4. _Optional: mount configuration file._
If you have component configuration file, for example `config.json`, place it in `classic/original_autogpt/data/` directory. Or place it in `classic/original_autogpt/` and uncomment the line in `docker-compose.yml` that mounts it.
To learn more about configuring, see [Component configuration](../../classic/forge/components/components.md#json-configuration)
To learn more about configuring, see [Component configuration](../../forge/components/components.md#json-configuration)
!!! note "Docker only supports headless browsing"
AutoGPT uses a browser in headless mode by default: `HEADLESS_BROWSER=True`.

8
docs/content/AutoGPT/setup/index.md
View File

@@ -50,11 +50,11 @@ Since we don't ship AutoGPT as a desktop application, you'll need to download th
### Completing the Setup
Once you have cloned or downloaded the project, you can find the AutoGPT Agent in the
`classic/original_autogpt/` folder.
`original_autogpt/` folder.
Inside this folder you can configure the AutoGPT application with an `.env` file and (optionally) a JSON configuration file:
- `.env` for environment variables, which are mostly used for sensitive data like API keys
- a JSON configuration file to customize certain features of AutoGPT's [Components](../../classic/forge/components/introduction.md)
- a JSON configuration file to customize certain features of AutoGPT's [Components](../../forge/components/introduction.md)
See the [Configuration](../configuration/options.md) reference for a list of available environment variables.
@@ -79,7 +79,7 @@ See the [Configuration](../configuration/options.md) reference for a list of ava
application also checks for and installs any required dependencies when it starts.
8. _Optional: configure the JSON file (e.g. `config.json`) with your desired settings._
The application will use default settings if you don't provide a JSON configuration file.
Learn how to [set up the JSON configuration file](../../classic/forge/components/components.md#json-configuration)
Learn how to [set up the JSON configuration file](../../forge/components/components.md#json-configuration)
You should now be able to explore the CLI (`./autogpt.sh --help`) and run the application.
@@ -260,4 +260,4 @@ For more information and in-depth documentation, check out the [llamafile docume
set `LLAMAFILE_API_BASE` in `.env` to the right base URL
[llamafile documentation]: https://github.com/Mozilla-Ocho/llamafile#readme
[classic/forge/llamafile.py]: https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/forge/classic/forge/llm/providers/llamafile/llamafile.py
[classic/forge/llamafile.py]: https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/forge/llm/providers/llamafile/llamafile.py

4
docs/content/AutoGPT/usage.md
View File

@@ -213,5 +213,5 @@ For example, to disable python coding features, set it to the value below:
DISABLED_COMMANDS=execute_python_code,execute_python_file
```
[components]: ../classic/forge/components/components.md
[commands]: ../classic/forge/components/built-in-components.md
[components]: ../forge/components/components.md
[commands]: ../forge/components/built-in-components.md

4
docs/content/forge/components/creating-components.md
View File

@@ -124,7 +124,7 @@ After components provided all necessary data, the agent needs to build the final
Currently, `PromptStrategy` (*not* a protocol) is responsible for building the final prompt.
If you want to change the way the prompt is built, you need to create a new `PromptStrategy` class, and then call relevant methods in your agent class.
You can have a look at the default strategy used by the AutoGPT Agent: [OneShotAgentPromptStrategy](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/classic/original_autogpt/agents/prompt_strategies/one_shot.py), and how it's used in the [Agent](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/classic/original_autogpt/agents/agent.py) (search for `self.prompt_strategy`).
You can have a look at the default strategy used by the AutoGPT Agent: [OneShotAgentPromptStrategy](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/agents/prompt_strategies/one_shot.py), and how it's used in the [Agent](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/agents/agent.py) (search for `self.prompt_strategy`).
## Example `UserInteractionComponent`
@@ -263,7 +263,7 @@ class MyAgent(Agent):
## Learn more
The best place to see more examples is to look at the built-in components in the [classic/original_autogpt/components](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/classic/original_autogpt/components/) and [classic/original_autogpt/commands](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/classic/original_autogpt/commands/) directories.
The best place to see more examples is to look at the built-in components in the [classic/original_autogpt/components](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/components/) and [classic/original_autogpt/commands](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/original_autogpt/commands/) directories.
Guide on how to extend the built-in agent and build your own: [🤖 Agents](./agents.md)
Order of some components matters, see [🧩 Components](./components.md) to learn more about components and how they can be customized.

4
docs/content/forge/get-started.md
View File

@@ -19,9 +19,9 @@ Forge is a ready-to-go template for *your* agent application. All the boilerplat
### 🚀 **Get Started!**
The best way to get started is to fork or download the AutoGPT repository and look at the example agent in `classic/forge/classic/forge/agent/forge_agent.py`.
The best way to get started is to fork or download the AutoGPT repository and look at the example agent in `classic/forge/agent/forge_agent.py`.
This can work as a starting point for your own agent.
Agents are built using *components* which provide different functionality, see the [Component Introduction](./components/introduction.md). You can find built-in components in `classic/forge/classic/forge/components/`.
Agents are built using *components* which provide different functionality, see the [Component Introduction](./components/introduction.md). You can find built-in components in `classic/forge/components/`.
!!! warning
The tutorial series below is out of date.

4
docs/content/index.md
View File

@@ -54,7 +54,7 @@ Measure your agent's performance! The `agbenchmark` can be used with any agent t
<!-- TODO: insert visual demonstrating the benchmark -->
- 📦 [**`agbenchmark`**](https://pypi.org/project/agclassic/benchmark/) on Pypi
- 📦 [**`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.
@@ -62,7 +62,7 @@ Measure your agent's performance! The `agbenchmark` can be used with any agent t
## 🏗️ Forge
**[📖 Introduction](classic/forge/get-started.md)**
**[📖 Introduction](forge/get-started.md)**
&ensp;|&ensp;
**[🚀 Quickstart](https://github.com/Significant-Gravitas/AutoGPT/blob/master/QUICKSTART.md)**

16
docs/mkdocs.yml
View File

@@ -33,15 +33,15 @@ nav:
- Readme: https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/benchmark/README.md
- Forge:
- Introduction: classic/forge/get-started.md
- Introduction: forge/get-started.md
- Components:
- Introduction: classic/forge/components/introduction.md
- Agents: classic/forge/components/agents.md
- Components: classic/forge/components/components.md
- Protocols: classic/forge/components/protocols.md
- Commands: classic/forge/components/commands.md
- Built in Components: classic/forge/components/built-in-components.md
- Creating Components: classic/forge/components/creating-components.md
- Introduction: forge/components/introduction.md
- Agents: forge/components/agents.md
- Components: forge/components/components.md
- Protocols: forge/components/protocols.md
- Commands: forge/components/commands.md
- Built in Components: forge/components/built-in-components.md
- Creating Components: forge/components/creating-components.md
- Frontend:
- Readme: https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/frontend/README.md