Skip to content

Commit 92e3f4a

Browse files
authored
Update README.md
1 parent 77c816c commit 92e3f4a

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,27 @@ conda activate amadeusgpt-cpu
6969
```
7070

7171

72-
### Setup OpenAI Key to use AmadeusGPT
72+
### Setup OpenAI API Key to use AmadeusGPT
7373

74+
**Why OpenAI API Key is needed** AmadeusGPT relies on API calls of OpenAI (we will add more options in the future) for language understanding and code writing.
75+
76+
You can either add this into your environment by following:
77+
78+
```bash
79+
export OPENAI_API_KEY='your API key'
80+
```
81+
82+
Or inside your python script or jupyter notebook, add this line in the beginning of the file
83+
84+
85+
```python
86+
import os
87+
os.environ["OPENAI_API_KEY"] = 'your api key'
88+
```
7489

7590
- Please note that you need an [openAI API key](https://platform.openai.com/account/api-keys), which you can easily create [here](https://platform.openai.com/account/api-keys).
76-
- If you want the **Streamlit Demo on your computer**, you will also need demo files that are supplied in our repo (see below**), so please git clone the repo and navigate into the `AmadeusGPT` directory. Then in your conda env/terminal run `pip install 'amadeusgpt[streamlit]'` as described above. Then, to launch the Demo App execute in the terminal:
91+
92+
7793

7894
### Try AmadeusGPT with local web app
7995
```python

0 commit comments

Comments
 (0)