Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
umair-nasir14 authored May 15, 2024
1 parent cb896ed commit 500d3f9
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,17 @@ Install the environment and activate it:

```
cd Word2World
type > word2world/.env
conda env create -f environment.yml
conda activate word2world
```

Add your API key to the .env file created in word2world folder:

```
OPENAI_API_KEY="sk..."
```

Run with default configs:

`python main.py`
Expand All @@ -34,7 +41,7 @@ python main.py \
--min_story_paragraphs=4 \
--max_story_paragraphs=5 \
--total_objectives=8 \
--rounds=3 \
--rounds=1 \
--experiment_name="Your_World" \
--save_dir="outputs"
```
Expand Down Expand Up @@ -69,6 +76,11 @@ python word2world/play_game.py
![world_6](https://github.com/umair-nasir14/Word2World/assets/68095790/d92fa869-82de-4e97-bb77-2eb5fb7d04e2)
![world_7](https://github.com/umair-nasir14/Word2World/assets/68095790/751a753e-9e3d-41da-b146-fa852d0e7f1c)

### Note:

- The most stable model is `"gpt-4-turbo-2024-04-09"`.
- Currently only `OpenAI` models are supported.

### Cite:
```
Expand Down

0 comments on commit 500d3f9

Please sign in to comment.