Skip to content

Commit 40803d4

Browse files
authored
Merge pull request #18 from samvelyan/readme
Fixing links in the README.md
2 parents 41b249e + fc0c537 commit 40803d4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<p align="center">
2-
<img width="80%" src="https://raw.githubusercontent.com/facebookresearch/minihack/main/docs/imgs/minihack.png" />
2+
<img width="80%" src="https://raw.githubusercontent.com/samvelyan/minihack/main/docs/imgs/minihack.png" />
33
</p>
44

55
<p align="center">
66
<a href="https://pypi.python.org/pypi/minihack/"><img src="https://img.shields.io/pypi/v/minihack.svg" /></a>
77
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
88
<a href="https://minihack.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/minihack/badge/?version=latest" /></a>
99
<a href="https://pepy.tech/project/minihack"><img src="https://static.pepy.tech/personalized-badge/minihack?period=total&units=international_system&left_color=black&right_color=red&left_text=Downloads" /></a>
10-
<a href="https://github.com/facebookresearch/minihack/actions/workflows/test_and_deploy.yml"><img src="https://github.com/facebookresearch/minihack/actions/workflows/test_and_deploy.yml/badge.svg?branch=main" /></a>
10+
<a href="https://github.com/samvelyan/minihack/actions/workflows/test_and_deploy.yml"><img src="https://github.com/samvelyan/minihack/actions/workflows/test_and_deploy.yml/badge.svg?branch=main" /></a>
1111
<a href="https://arxiv.org/abs/2109.13202"><img src="https://img.shields.io/badge/arXiv-2109.13202-b31b1b.svg"/></a>
1212
</p>
1313

@@ -21,23 +21,23 @@ MiniHack comes with a large list of challenging [environments](https://minihack.
2121
The motivation behind MiniHack is to be able to perform RL experiments in a controlled setting while being able to increasingly scale the complexity of the tasks.
2222

2323
<p align="center">
24-
<img width="90%" src="https://raw.githubusercontent.com/facebookresearch/minihack/main/docs/imgs/minihack_gameplay_collage.gif" />
24+
<img width="90%" src="https://raw.githubusercontent.com/samvelyan/minihack/main/docs/imgs/minihack_gameplay_collage.gif" />
2525
</p>
2626

2727
To do this, MiniHack leverages the so-called [description files](https://nethackwiki.com/wiki/Des-file_format) written using a human-readable probabilistic-programming-like domain-specific language. With just a few lines of code, people can generate a large variety of [Gymnasium](https://github.com/Farama-Foundation/Gymnasium) environments, controlling every little detail, from the location and types of monsters, to the traps, objects, and terrain of the level, all while introducing randomness that challenges generalization capabilities of RL agents. For further details, we refer users to our [brief overview](https://minihack.readthedocs.io/en/latest/getting-started/des_files.html), [detailed tutorial](https://minihack.readthedocs.io/en/latest/tutorials/des_file_tutorial.html), or [interactive notebook](./docs/tutorials/des_file_tutorial.ipynb).
2828

2929
[Our documentation](https://minihack.readthedocs.io/) will walk you through everything you need to know about MiniHack, step-by-step, including information on how to get started, configure environments or design new ones, train baseline agents, and much more.
3030

3131
<p align="center">
32-
<img width="90%" src="https://raw.githubusercontent.com/facebookresearch/minihack/main/docs/imgs/des_file.gif" />
32+
<img width="90%" src="https://raw.githubusercontent.com/samvelyan/minihack/main/docs/imgs/des_file.gif" />
3333
</p>
3434

3535
### MiniHack Level Editor
3636

3737
The [MiniHack Level Editor](https://minihack-editor.github.io) allows to easily define MiniHack environments inside a browser using a convenient drag-and-drop functionality. The source code is available [here](https://github.com/minihack-editor/minihack-editor.github.io).
3838

3939
<p align="center">
40-
<img width="75%" src="https://raw.githubusercontent.com/facebookresearch/minihack/main/docs/imgs/level_editor.png" />
40+
<img width="75%" src="https://raw.githubusercontent.com/samvelyan/minihack/main/docs/imgs/level_editor.png" />
4141
</p>
4242

4343
### Language Wrapper
@@ -72,7 +72,7 @@ We thank [ngoodger](https://github.com/ngoodger) for implementing the [NLE Langu
7272
- Parker-Holder et al. [That Escalated Quickly: Compounding Complexity by Editing Levels at the Frontier of Agent Capabilities](https://openreview.net/forum?id=3qGInPFqR0p) (Oxford, FAIR, UCL, Berkeley, DeepRL Workshop 2021)
7373
- Samvelyan et al. [MiniHack the Planet: A Sandbox for Open-Ended Reinforcement Learning Research](https://arxiv.org/abs/2109.13202) (FAIR, UCL, Oxford, NeurIPS 2021)
7474

75-
Open a [pull request](https://github.com/facebookresearch/minihack/edit/main/README.md) to add papers.
75+
Open a [pull request](https://github.com/samvelyan/minihack/edit/main/README.md) to add papers.
7676

7777
# Installation
7878

@@ -86,7 +86,7 @@ pip install minihack
8686
If you wish to extend MiniHack, please install the package as follows:
8787

8888
```bash
89-
git clone https://github.com/facebookresearch/minihack
89+
git clone https://github.com/samvelyan/minihack
9090
cd minihack
9191
pip install -e ".[dev]"
9292
pre-commit install

0 commit comments

Comments
 (0)