Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a .env.template file #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .env.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Steps:
# 1) Copy the contents of this file via `cp .env.template .env`
# 2) Add your OpenAPI key in the `.env` file (not in `.env.template`)
OPENAI_API_KEY=add_your_api_key_here
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,26 @@ pip install -r requirements.txt

Run the prepare exercise notebook (found inside the [exercises folder](https://github.com/dair-ai/maven-pe-for-llms-9/blob/main/exercises/PE_for_LLMs_Preparation_Exercise.ipynb)). Before attempting the preparation exercise, add a `.env` file to your root folder and add your `OPENAI_API_KEY`.

Create a `.env` file by copying `.env.template`:
```sh
cp .env.template .env
```

Add your OpenAI API key to the `.env` file (not the .env.template file).

Start a local Jupyter Lab server:
```sh
jupyter lab .
```

Execute the code in `exercises/PE_for_LLMs_Preparation_Exercise.py`. If you see an output similar to the following everything works as intended:

```
positive
neutral
neutral
positive
```


That's it! You're all set to start working on the notebooks and exercises.