Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thesofakillers committed Sep 29, 2023
1 parent f00bd4c commit 0b6cdeb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Empty file added checkpoints/.keep
Empty file.

0 comments on commit 0b6cdeb

Please sign in to comment.