From 12c8a494a728520b30e41c005cf34599aeae7f88 Mon Sep 17 00:00:00 2001 From: Vincent Moens Date: Mon, 5 Feb 2024 16:25:15 +0000 Subject: [PATCH] [Doc] Installation instructions in API ref (#1871) --- docs/source/index.rst | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 91906abb857..49bcde82488 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,14 @@ TorchRL TorchRL is an open-source Reinforcement Learning (RL) library for PyTorch. -It provides pytorch and python-first, low and high level abstractions for RL that are intended to be efficient, modular, documented and properly tested. +You can install TorchRL directly from PyPI (see more about installation +instructions in the dedicated section below): + +.. code-block:: + + $ pip install torchrl + +TorchRL provides pytorch and python-first, low and high level abstractions for RL that are intended to be efficient, modular, documented and properly tested. The code is aimed at supporting research in RL. Most of it is written in python in a highly modular way, such that researchers can easily swap components, transform them or write new ones with little effort. This repo attempts to align with the existing pytorch ecosystem libraries in that it has a "dataset pillar" @@ -30,6 +37,32 @@ TorchRL aims at a high modularity and good runtime performance. To read more about TorchRL philosophy and capabilities beyond this API reference, check the `TorchRL paper `__. +Installation +============ + +TorchRL releases are synced with PyTorch, so make sure you always enjoy the latest +features of the library with the `most recent version of PyTorch `__ (although core features +are guaranteed to be backward compatible with pytorch>=1.13). +Nightly releases can be installed via + +.. code-block:: + + $ pip install tensordict-nightly + $ pip install torchrl-nightly + +or via a ``git clone`` if you're willing to contribute to the library: + +.. code-block:: + + $ cd path/to/root + $ git clone https://github.com/pytorch/tensordict + $ git clone https://github.com/pytorch/rl + $ cd tensordict + $ python setup.py develop + $ cd ../rl + $ python setup.py develop + + Tutorials =========