Skip to content

Commit 3bc71be

Browse files
authored
Installation instructions (#20)
1 parent e8350e5 commit 3bc71be

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,22 @@
33
<p align="center"><b>Katakomba</b> is an open-source benchmark for data-driven NetHack. At the moment, it provides a set of standardized datasets with familiar interfaces and offline RL baselines augmented with recurrence. Full training logs synced to the Weights&Biases are included.</p>
44

55
## Installation
6-
TO BE DONE
76

7+
For now, Katakomba is not pip installable. However, the installation is easy.
8+
We also provide an alternative with the Dockerfile already set up to work (this is the preferred way!).
89
```bash
910
git clone https://github.com/tinkoff-ai/katakomba.git && cd katakomba
10-
pip install -r requirements/requirements_dev.txt
11+
pip install -r requirements.txt
1112

12-
# alternatively, you could use docker
13-
docker build -t <image_name> .
14-
docker run --gpus=all -it --rm --name <container_name> <image_name>
13+
# or alternatively, you could use docker
14+
docker build -t katakomba .
1515
```
1616

17-
1. ```cd katakomba/utils/render_utils/```
18-
19-
2. ```pip install -e .```
20-
17+
One last step is the installation of additional utils used for faster rendering of `tty` observations as images:
18+
```bash
19+
# use pip3 inside the docker container
20+
pip install -e katakomba/utils/render_utils/
21+
```
2122

2223
## Getting Started
2324

@@ -139,5 +140,5 @@ We host all of the datasets on the [HuggingFace](https://huggingface.co/datasets
139140

140141
## Citing Katakamoba
141142
```bibtex
142-
143+
TO APPEAR SOON
143144
```

0 commit comments

Comments
 (0)