You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
2
9
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. -->
4
14
5
15
### Changes
16
+
<!-- Describe the specific, focused change made in this pull request. Detail the modifications clearly and avoid any unrelated or "extra" changes. -->
6
17
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. -->
8
20
9
21
### Test Plan
22
+
<!-- Describe how you tested this functionality. Include steps to reproduce, relevant test cases, and any other pertinent information. -->
10
23
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! -->
14
30
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. -->
17
32
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. -->
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.
*(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)*
83
83
```
84
-
$ cd 'Auto-GPT'
84
+
cd 'Auto-GPT'
85
85
```
86
86
87
87
3. Install the required dependencies:
@@ -93,7 +93,7 @@ pip install -r requirements.txt
93
93
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.
94
94
- Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
95
95
- 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
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.
118
118
To use the `google_official_search` command, you need to set up your Google API keys in your environment variables.
119
119
120
120
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
127
127
8. Set up your search engine by following the prompts. You can choose to search the entire web or specific sites.
128
128
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.
129
129
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
+
130
132
### Setting up environment variables
131
133
For Windows Users:
132
134
```
@@ -177,18 +179,22 @@ MEMORY_INDEX=whatever
177
179
178
180
## 🌲 Pinecone API Key Setup
179
181
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.
182
183
183
184
1. Go to app.pinecone.io and make an account if you don't already have one.
184
185
2. Choose the `Starter` plan to avoid being charged.
185
186
3. Find your API key and region under the default project in the left sidebar.
186
187
187
188
### 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):
@@ -207,8 +212,8 @@ Or you can set them in the `.env` file.
207
212
208
213
## 💀 Continuous Mode ⚠️
209
214
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.
212
217
Use at your own risk.
213
218
1. Run the `main.py` Python script in your terminal:
214
219
```
@@ -222,6 +227,7 @@ If you don't have access to the GPT4 api, this mode will allow you to use Auto-G
222
227
```
223
228
python scripts/main.py --gpt3only
224
229
```
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.
225
231
226
232
## 🖼 Image Generation
227
233
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
252
258
253
259
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.
254
260
255
-
## 🐦 Connect with Us on Twitter
261
+
## 🐦 Connect with Us on Twitter
256
262
257
263
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.
@@ -117,7 +117,7 @@ https://www.visitor-analytics.io › blog › best-online-b...
117
117
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.
0 commit comments