From 0b6cdebe4c8137095fad8d73a6d04af957ef2aa4 Mon Sep 17 00:00:00 2001
From: Giulio Starace <26286291+thesofakillers@users.noreply.github.com>
Date: Fri, 29 Sep 2023 19:14:43 +0300
Subject: [PATCH] update readme

---
 README.md         | 21 ++++++---------------
 checkpoints/.keep |  0
 2 files changed, 6 insertions(+), 15 deletions(-)
 create mode 100644 checkpoints/.keep

diff --git a/README.md b/README.md
index 0763edb..cd35ef9 100644
--- a/README.md
+++ b/README.md
@@ -16,18 +16,7 @@ First, install the pre-requirements[^1]:
 pip install -r requirements/pre-reqs.txt
 ```
 
-For [poetry](https://python-poetry.org/) users, getting setup is then as easy as
-running
-
-```terminal
-poetry install
-```
-
-We also provide `requirements.txt` files for
-[pip](https://pypi.org/project/pip/) users who do not wish to use poetry. We
-provide a [requirements-minimal.txt](requirements/requirements-minimal.txt) file
-and a [requirements-complete.txt](requirements/requirements-complete.txt) file
-in the [requirements](requirements/) directory. We recommend simply running
+Then install the rest of the requirements:
 
 ```terminal
 pip install -r requirements/requirements-complete.txt
@@ -62,8 +51,10 @@ These `requirements.txt` file are generated by running
     ├── outputs/           <- Output files. Not committed.
     └── src/nlgoals/       <- Source code for use in this project.
         ├── __init__.py    <- Makes src a Python module
+        ├── babyai/        <- (modified) code from babyai repo
+        ├── configs/       <- Miscellaneaous configuration
         ├── utils.py       <- Miscellaneaous utils
-        ├── data/          <- Scripts to download or generate data
+        ├── data/          <- Data processing and handling
         ├── interfaces/    <- Logic for connecting datasets and models
         ├── models/        <- Model definitions
         ├── losses/        <- Custom loss function implementations
@@ -78,8 +69,8 @@ having to edit config files. Users may find the
 [cookiecutter data-science opinions page](http://drivendata.github.io/cookiecutter-data-science/#opinions),
 of relevance
 
-The top level `data/` and `models/` directory are in version control only to
-show structure. Their contents will not be committed and are ignored via
+The top level `data/` and `checkpoints/` directories are in version control only
+to show structure. Their contents will not be committed and are ignored via
 `.gitignore`.
 
 ## Demo videos
diff --git a/checkpoints/.keep b/checkpoints/.keep
new file mode 100644
index 0000000..e69de29