Skip to content

Commit

Permalink
Add docker, and devcontainer documentation, update index in the process.
Browse files Browse the repository at this point in the history
  • Loading branch information
ludgerpaehler committed Jan 29, 2024
1 parent dae7dd4 commit fb12f38
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 1 deletion.
31 changes: 31 additions & 0 deletions docs/source/docker_development.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Container-based Development
===========================

We strongly recommend development in the provided Docker container. The docker container
is available from `DockerHub <https://hub.docker.com/repository/docker/lpaehler/hydrogym/general>`_
, and can be pulled with

.. code-block:: console
$ docker pull lpaehler/hydrogym:stable
or directly run if one seeks to develop inside of it:

.. code-block:: console
$ docker run lpaehler/hydrogym:stable
If `VSCode <https://code.visualstudio.com>`_ is used for development, a .devcontainer file is provided
and allows VSCode to immediately spin up a `devcontainer <https://containers.dev>`_ with all dependencies
installed. To make full use of this you have to have the
`devcontainer extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>`_
installed, and upon pointing VSCode at the HydroGym directory allow it to launch into the devcontainer.
VSCode will then take care of the rest.

.. note::

The first start of the devcontainer can take a minute depending on your internet connection as it needs to pull
the docker container from the server before being able to launch the IDE into the container.

For more information regarding the way devcontainer works please see
`Microsoft's documentation <https://code.visualstudio.com/docs/devcontainers/containers>`_.
3 changes: 3 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,14 @@ Core Features
:caption: API Reference

api
torch_rl
rllib


.. toctree::
:maxdepth: 1
:caption: Developer Notes

docker_development
distributed_backend
further_backend
2 changes: 1 addition & 1 deletion docs/source/ray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ the underlying resources.
.. code-block:: python
import ray
ray.init(address=IP_ADDRESS_OF_HEAD_NODE)
ray.init(address=IP_ADDRESS_OF_HEAD_NODE)
3 changes: 3 additions & 0 deletions docs/source/rllib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
RLlib Integration
=================

3 changes: 3 additions & 0 deletions docs/source/torch_rl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
TorchRL Integration
===================

0 comments on commit fb12f38

Please sign in to comment.