Skip to content

Commit

Permalink
[Doc] Installation instructions in API ref (#1871)
Browse files Browse the repository at this point in the history
  • Loading branch information
vmoens committed Feb 6, 2024
1 parent 49449a6 commit 12c8a49
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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 <https://arxiv.org/abs/2306.00577>`__.

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 <https://pytorch.org/get-started/locally/>`__ (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
=========

Expand Down

0 comments on commit 12c8a49

Please sign in to comment.