-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c762c4e
commit 628a012
Showing
2 changed files
with
20 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,59 +14,34 @@ GPT Engineer is made to be easy to adapt, extend, and make your agent learn how | |
- Fast handovers back and forth between AI and human | ||
- Simplicity, all computation is "resumable" and persisted to the filesystem | ||
|
||
## Usage | ||
|
||
## Installation | ||
|
||
**Users**: | ||
|
||
We recommend installing from PyPi: | ||
```bash | ||
pip install gpt-engineer | ||
``` | ||
This will make sure you are running the latest stable version. | ||
|
||
|
||
**Contributors/Developers**: | ||
|
||
If you plan on becoming a [contributor](.github/CONTRIBUTING.md) or if you just want to test/develop something on top of things, | ||
you can install from GitHub the bleeding version, aka the `main` branch: | ||
|
||
_(be aware this is a very active project and might be unstable at times)_ | ||
Choose either **stable** or **development**. | ||
|
||
```bash | ||
# use make (run make --help to see all commands available) | ||
make install | ||
For **stable** release: | ||
|
||
# or | ||
- `pip install gpt-engineer` | ||
|
||
make dev-install # if you plan to contribute | ||
``` | ||
For **development**: | ||
- `git clone [email protected]:AntonOsika/gpt-engineer.git` | ||
- `cd gpt-engineer` | ||
- `make install` | ||
- `source venv/bin/activate` | ||
|
||
If you know your way around Python project you can also install manually (make sure you are in a virtual environment): | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
**Setup** | ||
|
||
With an api key that has GPT4 access run: | ||
|
||
## Usage | ||
- `export OPENAI_API_KEY=[your api key]` | ||
|
||
**Setup**: | ||
|
||
- setup your OpenAI API Key (with a key that has GPT4 access) | ||
``` | ||
export OPENAI_API_KEY=[your api key] | ||
``` | ||
|
||
**Run**: | ||
- Create a new empty folder with a `main_prompt` file in the `projects` folder or copy the example folder: | ||
``` | ||
cp -r projects/example/ projects/my-new-project | ||
``` | ||
|
||
- Fill in the `main_prompt` in your new folder | ||
- Run `python -m gpt_engineer.main projects/my-new-project` | ||
- Create an empty folder. If inside the repo, you can run: | ||
- `cp -r projects/example/ projects/my-new-project` | ||
- Fill in the `main_prompt` file in your new folder | ||
- Run: `gpt-engineer projects/my-new-project` | ||
|
||
**Results**: | ||
**Results** | ||
- Check the generated files in `projects/my-new-project/workspace` | ||
|
||
### Limitations | ||
|
628a012
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am using GPT3.5, how can i make necessary changes for the code to work? Because the API key being used is for ChatGPT3.5.
ThanK you
628a012
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even I am getting the GPT version error upon trying to run the code
OpenAI API error received' stream_error=False
Model gpt-4 not available for provided API key. Reverting to gpt-3.5-turbo. Sign up for the GPT-4 wait list here: https://openai.com/waitlist/gpt-4-api