Skip to content

Commit 3ffff9f

Browse files
committed
Merge branch 'master' of github.com:Torantulino/Auto-GPT into attr-error-lower
2 parents a40943a + 1e98d34 commit 3ffff9f

31 files changed

+708
-221
lines changed

.env.template

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ PINECONE_API_KEY=your-pinecone-api-key
22
PINECONE_ENV=your-pinecone-region
33
OPENAI_API_KEY=your-openai-api-key
44
ELEVENLABS_API_KEY=your-elevenlabs-api-key
5-
SMART_LLM_MODEL="gpt-4"
6-
FAST_LLM_MODEL="gpt-3.5-turbo"
5+
SMART_LLM_MODEL=gpt-4
6+
FAST_LLM_MODEL=gpt-3.5-turbo
77
GOOGLE_API_KEY=
88
CUSTOM_SEARCH_ENGINE_ID=
99
USE_AZURE=False
10-
OPENAI_API_BASE=your-base-url-for-azure
11-
OPENAI_API_VERSION=api-version-for-azure
12-
OPENAI_DEPLOYMENT_ID=deployment-id-for-azure
10+
OPENAI_AZURE_API_BASE=your-base-url-for-azure
11+
OPENAI_AZURE_API_VERSION=api-version-for-azure
12+
OPENAI_AZURE_DEPLOYMENT_ID=deployment-id-for-azure
1313
IMAGE_PROVIDER=dalle
14-
HUGGINGFACE_API_TOKEN=
14+
HUGGINGFACE_API_TOKEN=
15+
USE_MAC_OS_TTS=False

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
1-
### Background
1+
<!-- 📢 Announcement
2+
We've recently noticed an increase in pull requests focusing on combining multiple changes. While the intentions behind these PRs are appreciated, it's essential to maintain a clean and manageable git history. To ensure the quality of our repository, we kindly ask you to adhere to the following guidelines when submitting PRs:
3+
4+
Focus on a single, specific change.
5+
Do not include any unrelated or "extra" modifications.
6+
Provide clear documentation and explanations of the changes made.
7+
Ensure diffs are limited to the intended lines — no applying preferred formatting styles or line endings (unless that's what the PR is about).
8+
For guidance on committing only the specific lines you have changed, refer to this helpful video: https://youtu.be/8-hSNHHbiZg
29
3-
<!-- Provide a brief overview of why this change is being made. Include any relevant context, prior discussions, or links to relevant issues. -->
10+
By following these guidelines, your PRs are more likely to be merged quickly after testing, as long as they align with the project's overall direction. -->
11+
12+
### Background
13+
<!-- Provide a concise overview of the rationale behind this change. Include relevant context, prior discussions, or links to related issues. Ensure that the change aligns with the project's overall direction. -->
414

515
### Changes
16+
<!-- Describe the specific, focused change made in this pull request. Detail the modifications clearly and avoid any unrelated or "extra" changes. -->
617

7-
<!-- Describe the changes made in this pull request. Be specific and detailed. -->
18+
### Documentation
19+
<!-- Explain how your changes are documented, such as in-code comments or external documentation. Ensure that the documentation is clear, concise, and easy to understand. -->
820

921
### Test Plan
22+
<!-- Describe how you tested this functionality. Include steps to reproduce, relevant test cases, and any other pertinent information. -->
1023

11-
<!-- Explain how you tested this functionality. Include the steps to reproduce and any relevant test cases. -->
12-
13-
### Change Safety
24+
### PR Quality Checklist
25+
- [ ] My pull request is atomic and focuses on a single change.
26+
- [ ] I have thouroughly tested my changes with multiple different prompts.
27+
- [ ] I have considered potential risks and mitigations for my changes.
28+
- [ ] I have documented my changes clearly and comprehensively.
29+
- [ ] I have not snuck in any "extra" small tweaks changes <!-- Submit these as seperate Pull Reqests, they are the easiest to merge! -->
1430

15-
- [ ] I have added tests to cover my changes
16-
- [ ] I have considered potential risks and mitigations for my changes
31+
<!-- If you haven't added tests, please explain why. If you have, check the appropriate box. If you've ensured your PR is atomic and well-documented, check the corresponding boxes. -->
1732

18-
<!-- If you haven't added tests, please explain why. If you have, check the appropriate box. -->
33+
<!-- By submitting this, I agree that my pull request should be closed if I do not fill this out or follow the guide lines. -->

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,9 @@ package-lock.json
77
auto_gpt_workspace/*
88
*.mpeg
99
.env
10+
venv/*
1011
outputs/*
11-
ai_settings.yaml
12+
ai_settings.yaml
13+
.vscode
14+
auto-gpt.json
15+
log.txt

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ git checkout -b "branch-name"
1919

2020
5. Add the changes to the staging area using the following command:
2121
```
22-
git add .
22+
git add .
2323
```
2424

2525
6. Commit the changes with a meaningful commit message using the following command:

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ FROM python:3.11
22

33
WORKDIR /app
44
COPY scripts/ /app
5+
COPY requirements.txt /app
56

67
RUN pip install -r requirements.txt
78

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
![Twitter Follow](https://img.shields.io/twitter/follow/siggravitas?style=social)
44
[![](https://dcbadge.vercel.app/api/server/PQ7VX6TY4t?style=flat)](https://discord.gg/PQ7VX6TY4t)
55

6-
Auto-GPT is an experimental open-source application showcasing the capabilities of the GPT-4 language model. This program, driven by GPT-4, autonomously develops and manages businesses to increase net worth. As one of the first examples of GPT-4 running fully autonomously, Auto-GPT pushes the boundaries of what is possible with AI.
6+
Auto-GPT is an experimental open-source application showcasing the capabilities of the GPT-4 language model. This program, driven by GPT-4, chains together LLM "thoughts", to autonomously achieve whatever goal you set. As one of the first examples of GPT-4 running fully autonomously, Auto-GPT pushes the boundaries of what is possible with AI.
77

88
### Demo (30/03/2023):
99
https://user-images.githubusercontent.com/22963551/228855501-2f5777cf-755b-4407-a643-c7299e5b6419.mp4
1010

1111

12-
<h2 align="center"> 💖 Help Fund Auto-GPT's Development 💖</h2>
12+
<h2 align="center"> 💖 Help Fund Auto-GPT's Development 💖</h2>
1313
<p align="center">
1414
If you can spare a coffee, you can help to cover the API costs of developing Auto-GPT and help push the boundaries of fully autonomous AI!
1515
A full day of development can easily cost as much as $20 in API costs, which for a free project is quite limiting.
@@ -59,7 +59,7 @@ Your support is greatly appreciated
5959
## 📋 Requirements
6060
- [Python 3.8 or later](https://www.tutorialspoint.com/how-to-install-python-in-windows)
6161
- OpenAI API key
62-
- PINECONE API key
62+
- [PINECONE API key](https://www.pinecone.io/)
6363

6464
Optional:
6565
- ElevenLabs Key (If you want the AI to speak)
@@ -81,7 +81,7 @@ git clone https://github.com/Torantulino/Auto-GPT.git
8181
2. Navigate to the project directory:
8282
*(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)*
8383
```
84-
$ cd 'Auto-GPT'
84+
cd 'Auto-GPT'
8585
```
8686

8787
3. Install the required dependencies:
@@ -93,7 +93,7 @@ pip install -r requirements.txt
9393
4. Rename `.env.template` to `.env` and fill in your `OPENAI_API_KEY`. If you plan to use Speech Mode, fill in your `ELEVEN_LABS_API_KEY` as well.
9494
- Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
9595
- Obtain your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
96-
- If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_API_BASE`, `OPENAI_API_VERSION` and `OPENAI_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section
96+
- If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_AZURE_API_BASE`, `OPENAI_AZURE_API_VERSION` and `OPENAI_AZURE_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section
9797

9898
## 🔧 Usage
9999

@@ -114,7 +114,7 @@ python scripts/main.py --speak
114114

115115
## 🔍 Google API Keys Configuration
116116

117-
This section is optional, use the official google api if you are having issues with error 429 when running google search.
117+
This section is optional, use the official google api if you are having issues with error 429 when running a google search.
118118
To use the `google_official_search` command, you need to set up your Google API keys in your environment variables.
119119

120120
1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
@@ -127,6 +127,8 @@ To use the `google_official_search` command, you need to set up your Google API
127127
8. Set up your search engine by following the prompts. You can choose to search the entire web or specific sites.
128128
9. Once you've created your search engine, click on "Control Panel" and then "Basics". Copy the "Search engine ID" and set it as an environment variable named `CUSTOM_SEARCH_ENGINE_ID` on your machine. See setting up environment variables below.
129129

130+
*Remember that your free daily custom search quota allows only up to 100 searches. To increase this limit, you need to assign a billing account to the project to profit from up to 10K daily searches.*
131+
130132
### Setting up environment variables
131133
For Windows Users:
132134
```
@@ -177,18 +179,22 @@ MEMORY_INDEX=whatever
177179

178180
## 🌲 Pinecone API Key Setup
179181

180-
Pinecone enable a vector based memory so a vast memory can be stored and only relevant memories
181-
are loaded for the agent at any given time.
182+
Pinecone enables the storage of vast amounts of vector-based memory, allowing for only relevant memories to be loaded for the agent at any given time.
182183

183184
1. Go to app.pinecone.io and make an account if you don't already have one.
184185
2. Choose the `Starter` plan to avoid being charged.
185186
3. Find your API key and region under the default project in the left sidebar.
186187

187188
### Setting up environment variables
188-
For Windows Users:
189+
190+
Simply set them in the `.env` file.
191+
192+
Alternatively, you can set them from the command line (advanced):
193+
194+
For Windows Users:
189195
```
190196
setx PINECONE_API_KEY "YOUR_PINECONE_API_KEY"
191-
export PINECONE_ENV="Your pinecone region" # something like: us-east4-gcp
197+
setx PINECONE_ENV "Your pinecone region" # something like: us-east4-gcp
192198
193199
```
194200
For macOS and Linux users:
@@ -198,7 +204,6 @@ export PINECONE_ENV="Your pinecone region" # something like: us-east4-gcp
198204
199205
```
200206

201-
Or you can set them in the `.env` file.
202207

203208
## View Memory Usage
204209

@@ -207,8 +212,8 @@ Or you can set them in the `.env` file.
207212

208213
## 💀 Continuous Mode ⚠️
209214
Run the AI **without** user authorisation, 100% automated.
210-
Continuous mode is not recommended.
211-
It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise.
215+
Continuous mode is not recommended.
216+
It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise.
212217
Use at your own risk.
213218
1. Run the `main.py` Python script in your terminal:
214219
```
@@ -222,6 +227,7 @@ If you don't have access to the GPT4 api, this mode will allow you to use Auto-G
222227
```
223228
python scripts/main.py --gpt3only
224229
```
230+
It is recommended to use a virtual machine for tasks that require high security measures to prevent any potential harm to the main computer's system and data.
225231

226232
## 🖼 Image Generation
227233
By default, Auto-GPT uses DALL-e for image generation. To use Stable Diffusion, a [HuggingFace API Token](https://huggingface.co/settings/tokens) is required.
@@ -252,7 +258,7 @@ As an autonomous experiment, Auto-GPT may generate content or take actions that
252258

253259
By using Auto-GPT, you agree to indemnify, defend, and hold harmless the developers, contributors, and any affiliated parties from and against any and all claims, damages, losses, liabilities, costs, and expenses (including reasonable attorneys' fees) arising from your use of this software or your violation of these terms.
254260

255-
## 🐦 Connect with Us on Twitter
261+
## 🐦 Connect with Us on Twitter
256262

257263
Stay up-to-date with the latest news, updates, and insights about Auto-GPT by following our Twitter accounts. Engage with the developer and the AI's own account for interesting discussions, project updates, and more.
258264

outputs/logs/message-log-1.txt

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ These are the commands available from you:
2828

2929
Your response must ALWAYS be in JSON format, in the following format:
3030
{
31-
"command":
31+
"command":
3232
{
3333
"name": "command name",
34-
"arguments":
34+
"arguments":
3535
{
3636
"argument name": "argument value"
3737
}
38-
},
39-
"Thoughts":
38+
},
39+
"Thoughts":
4040
{
4141
"text": "thought",
4242
"reasoning": "reasoning",
@@ -50,7 +50,7 @@ Gmail: [email protected]
5050
Twitter: @En_GPT
5151
"""
5252
-----------------------------------------------------------------------
53-
Entrepreneur-GTP:
53+
Entrepreneur-GTP:
5454
{
5555
"command":
5656
{
@@ -69,7 +69,7 @@ Entrepreneur-GTP:
6969
}
7070
}
7171
-----------------------------------------------------------------------
72-
USER:
72+
USER:
7373
RESULT:
7474
"""
7575
29 best online business ideas
@@ -117,7 +117,7 @@ https://www.visitor-analytics.io › blog › best-online-b...
117117
26/10/2022 — 10 Best Online Business Ideas for 2023 · 1. Artificial Intelligence · 2. Digital Products · 3. Blogging · 4. Graphic Design · 5. Web Development · 6.
118118
"""
119119
-----------------------------------------------------------------------
120-
Entrepreneur-GTP:
120+
Entrepreneur-GTP:
121121
{
122122
"command":
123123
{
@@ -167,15 +167,15 @@ These are the commands available from you:
167167

168168
Your response must ALWAYS be in JSON format, in the following format:
169169
{
170-
"command":
170+
"command":
171171
{
172172
"name": "command name",
173-
"arguments":
173+
"arguments":
174174
{
175175
"argument name": "argument value"
176176
}
177-
},
178-
"Thoughts":
177+
},
178+
"Thoughts":
179179
{
180180
"text": "thought",
181181
"reasoning": "reasoning",
@@ -193,7 +193,7 @@ Online business ideas: 1. Clothing line, 2. Dropshipping, 3. Sell art, 4. Freela
193193
"""
194194
"""
195195
-----------------------------------------------------------------------
196-
Entrepreneur-GTP:
196+
Entrepreneur-GTP:
197197
{
198198
"command":
199199
{
@@ -282,15 +282,15 @@ These are the commands available from you:
282282

283283
Your response must ALWAYS be in JSON format, in the following format:
284284
{
285-
"command":
285+
"command":
286286
{
287287
"name": "command name",
288-
"arguments":
288+
"arguments":
289289
{
290290
"argument name": "argument value"
291291
}
292-
},
293-
"Thoughts":
292+
},
293+
"Thoughts":
294294
{
295295
"text": "thought",
296296
"reasoning": "reasoning",
@@ -334,7 +334,7 @@ Entrepreneur-GTP:
334334
-----------------------------------------------------------------------
335335
USER:
336336
"""
337-
Top Result:
337+
Top Result:
338338
"""
339339
Low-Cost Business Ideas:
340340
Mobile Food Shop: Mobile Food Shop is the top small business idea as people all over the world love to eat tasty and healthy food. ...
@@ -403,15 +403,15 @@ These are the commands available from you:
403403

404404
Your response must ALWAYS be in JSON format, in the following format:
405405
{
406-
"command":
406+
"command":
407407
{
408408
"name": "command name",
409-
"arguments":
409+
"arguments":
410410
{
411411
"argument name": "argument value"
412412
}
413-
},
414-
"Thoughts":
413+
},
414+
"Thoughts":
415415
{
416416
"text": "thought",
417417
"reasoning": "reasoning",

0 commit comments

Comments
 (0)