aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-17 05:54:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update QUICKSTART.md

Browse Source 
* Clarify instructions for entering the Arena
* Clarify that entering the Arena is optional
* Remove indent from top level content
This commit is contained in:
Reinier van der Leer
2024-03-05 11:16:44 +01:00
parent 7bf31dad35
commit d5aa8d373b
1 changed files with 33 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
QUICKSTART.md
View File

@@ -85,29 +85,39 @@ If you continue to experience issues, consider storing your project files within
## Creating Your Agent ## Creating Your Agent
Now setup has been completed its time to create your agent template. After completing the setup, the next step is to create your agent template.
Do so by running the `./run agent create YOUR_AGENT_NAME` replacing YOUR_AGENT_NAME with a name of your choice. Examples of valid names: swiftyosgpt or SwiftyosAgent or swiftyos_agent Execute the command `./run agent create YOUR_AGENT_NAME`, where `YOUR_AGENT_NAME` should be replaced with a name of your choosing.
Tips for naming your agent:
* Give it its own unique name, or name it after yourself
* Include an important aspect of your agent in the name, such as its purpose
Examples: `SwiftyosAssistant`, `PwutsPRAgent`, `Narvis`, `evo.ninja`
![Create an Agent](docs/content/imgs/quickstart/007_create_agent.png) ![Create an Agent](docs/content/imgs/quickstart/007_create_agent.png)
Upon creating your agent its time to officially enter the Arena! ### Optional: Entering the Arena
Do so by running `./run arena enter YOUR_AGENT_NAME`
Entering the Arena is an optional step intended for those who wish to actively participate in the agent leaderboard. If you decide to participate, you can enter the Arena by running `./run arena enter YOUR_AGENT_NAME`. This step is not mandatory for the development or testing of your agent.
Entries with names like `agent`, `ExampleAgent`, `test_agent` or `MyExampleGPT` will NOT be merged. We also don't accept copycat entries that use the name of other projects, like `AutoGPT` or `evo.ninja`.
![Enter the Arena](docs/content/imgs/quickstart/008_enter_arena.png) ![Enter the Arena](docs/content/imgs/quickstart/008_enter_arena.png)
> Note: for advanced users, create a new branch and create a file called YOUR_AGENT_NAME.json in the arena directory. Then commit this and create a PR to merge into the main repo. Only single file entries will be permitted. The json file needs the following format. > **Note**
```json > For advanced users, create a new branch and create a file called YOUR_AGENT_NAME.json in the arena directory. Then commit this and create a PR to merge into the main repo. Only single file entries will be permitted. The json file needs the following format:
{ > ```json
"github_repo_url": "https://github.com/Swiftyos/YourAgentName", > {
"timestamp": "2023-09-18T10:03:38.051498", > "github_repo_url": "https://github.com/Swiftyos/YourAgentName",
"commit_hash_to_benchmark": "ac36f7bfc7f23ad8800339fa55943c1405d80d5e", > "timestamp": "2023-09-18T10:03:38.051498",
"branch_to_benchmark": "master" > "commit_hash_to_benchmark": "ac36f7bfc7f23ad8800339fa55943c1405d80d5e",
} > "branch_to_benchmark": "master"
``` > }
- github_repo_url: the url to your fork > ```
- timestamp: timestamp of the last update of this file > - `github_repo_url`: the url to your fork
- commit_hash_to_benchmark: the commit hash of your entry. You update each time you have an something ready to be officially entered into the hackathon > - `timestamp`: timestamp of the last update of this file
- branch_to_benchmark: the branch you are using to develop your agent on, default is master. > - `commit_hash_to_benchmark`: the commit hash of your entry. You update each time you have an something ready to be officially entered into the hackathon
> - `branch_to_benchmark`: the branch you are using to develop your agent on, default is master.
## Running your Agent ## Running your Agent