ソースを参照

Updated README

Maxime Chevalier-Boisvert 7 年 前
コミット
f28a1ba73f
2 ファイル変更23 行追加13 行削除
  1. 22 11
      README.md
  2. 1 2
      setup.py

+ 22 - 11
README.md

@@ -4,17 +4,7 @@ Simple and minimailistic grid world environment for OpenAI Gym.
 
 ## Installation
 
-Requirements:
-- Python 3
-- OpenAI gym
-- numpy
-- PyQT5
-- PyTorch (if using the supplied `basicrl` training code)
-- matplotlib (if using the supplied `basicrl` training code)
-
-Start by manually installing [PyTorch](http://pytorch.org/).
-
-Then, clone the repository and install the other dependencies with `pip3`:
+Clone this repository and install the other dependencies with `pip3`:
 
 ```
 git clone https://github.com/maximecb/gym-minigrid.git
@@ -22,6 +12,27 @@ cd gym-minigrid
 pip3 install -e .
 ```
 
+Optionally, if you wish use the reinforcement learning code included
+under [/basicrl](/basicrl), you can install its dependencies as follows:
+
+```
+cd basicrl
+
+# PyTorch
+conda install pytorch torchvision -c soumith
+
+# OpenAI baselines
+git clone https://github.com/openai/baselines.git
+cd baselines
+pip install -e .
+
+# Other requirements
+pip install -r requirements.txt
+```
+
+Note: the basicrl code is a custom fork of [this repository](https://github.com/ikostrikov/pytorch-a2c-ppo-acktr),
+which was modified to work with this environment.
+
 ## Usage
 
 To run the standalone UI application, which allows you to manually control the agent with the arrow keys:

+ 1 - 2
setup.py

@@ -7,7 +7,6 @@ setup(
     install_requires=[
         'gym>=0.9.0',
         'numpy>=1.10.0',
-        'pyqt5',
-        'matplotlib'
+        'pyqt5'
     ]
 )