File size: 4,595 Bytes
a89d35f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | .. _install:
Installation
============
Prerequisites
-------------
Stable-Baselines3 requires python 3.6+.
Windows 10
~~~~~~~~~~
We recommend using `Anaconda <https://conda.io/docs/user-guide/install/windows.html>`_ for Windows users for easier installation of Python packages and required libraries. You need an environment with Python version 3.6 or above.
For a quick start you can move straight to installing Stable-Baselines3 in the next step.
.. note::
Trying to create Atari environments may result to vague errors related to missing DLL files and modules. This is an
issue with atari-py package. `See this discussion for more information <https://github.com/openai/atari-py/issues/65>`_.
Stable Release
~~~~~~~~~~~~~~
To install Stable Baselines3 with pip, execute:
.. code-block:: bash
pip install stable-baselines3[extra]
This includes an optional dependencies like Tensorboard, OpenCV or ``atari-py`` to train on atari games. If you do not need those, you can use:
.. code-block:: bash
pip install stable-baselines3
Bleeding-edge version
---------------------
.. code-block:: bash
pip install git+https://github.com/DLR-RM/stable-baselines3
Development version
-------------------
To contribute to Stable-Baselines3, with support for running tests and building the documentation.
.. code-block:: bash
git clone https://github.com/DLR-RM/stable-baselines3 && cd stable-baselines3
pip install -e .[docs,tests,extra]
Using Docker Images
-------------------
If you are looking for docker images with stable-baselines already installed in it,
we recommend using images from `RL Baselines3 Zoo <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
Otherwise, the following images contained all the dependencies for stable-baselines3 but not the stable-baselines3 package itself.
They are made for development.
Use Built Images
~~~~~~~~~~~~~~~~
GPU image (requires `nvidia-docker`_):
.. code-block:: bash
docker pull stablebaselines/stable-baselines3
CPU only:
.. code-block:: bash
docker pull stablebaselines/stable-baselines3-cpu
Build the Docker Images
~~~~~~~~~~~~~~~~~~~~~~~~
Build GPU image (with nvidia-docker):
.. code-block:: bash
make docker-gpu
Build CPU image:
.. code-block:: bash
make docker-cpu
Note: if you are using a proxy, you need to pass extra params during
build and do some `tweaks`_:
.. code-block:: bash
--network=host --build-arg HTTP_PROXY=http://your.proxy.fr:8080/ --build-arg http_proxy=http://your.proxy.fr:8080/ --build-arg HTTPS_PROXY=https://your.proxy.fr:8080/ --build-arg https_proxy=https://your.proxy.fr:8080/
Run the images (CPU/GPU)
~~~~~~~~~~~~~~~~~~~~~~~~
Run the nvidia-docker GPU image
.. code-block:: bash
docker run -it --runtime=nvidia --rm --network host --ipc=host --name test --mount src="$(pwd)",target=/root/code/stable-baselines3,type=bind stablebaselines/stable-baselines3 bash -c 'cd /root/code/stable-baselines3/ && pytest tests/'
Or, with the shell file:
.. code-block:: bash
./scripts/run_docker_gpu.sh pytest tests/
Run the docker CPU image
.. code-block:: bash
docker run -it --rm --network host --ipc=host --name test --mount src="$(pwd)",target=/root/code/stable-baselines3,type=bind stablebaselines/stable-baselines3-cpu bash -c 'cd /root/code/stable-baselines3/ && pytest tests/'
Or, with the shell file:
.. code-block:: bash
./scripts/run_docker_cpu.sh pytest tests/
Explanation of the docker command:
- ``docker run -it`` create an instance of an image (=container), and
run it interactively (so ctrl+c will work)
- ``--rm`` option means to remove the container once it exits/stops
(otherwise, you will have to use ``docker rm``)
- ``--network host`` don't use network isolation, this allow to use
tensorboard/visdom on host machine
- ``--ipc=host`` Use the host system’s IPC namespace. IPC (POSIX/SysV IPC) namespace provides
separation of named shared memory segments, semaphores and message
queues.
- ``--name test`` give explicitly the name ``test`` to the container,
otherwise it will be assigned a random name
- ``--mount src=...`` give access of the local directory (``pwd``
command) to the container (it will be map to ``/root/code/stable-baselines``), so
all the logs created in the container in this folder will be kept
- ``bash -c '...'`` Run command inside the docker image, here run the tests
(``pytest tests/``)
.. _nvidia-docker: https://github.com/NVIDIA/nvidia-docker
.. _tweaks: https://stackoverflow.com/questions/23111631/cannot-download-docker-images-behind-a-proxy
|