Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
vmoens committed Feb 5, 2024
1 parent b98d075 commit 8198c8f
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Welcome to the TensorDict Documentation!
`TensorDict` is a dictionary-like class that inherits properties from tensors,
such as indexing, shape operations, casting to device etc.

You can install tensordict directly from PyPI (see more about installation
instructions in the dedicated section below):

.. code-block::
$ pip install tensordict
The main purpose of TensorDict is to make code-bases more *readable* and *modular*
by abstracting away tailored operations:

Expand All @@ -26,6 +34,28 @@ prediction, loss computation etc.)
can be tailored to the use case at hand without impacting the others.
For instance, the above example can be easily used across classification and segmentation tasks, among many others.


Installation
============

Tensordict 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
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
$ cd tensordict
$ python setup.py develop
Tutorials
=========

Expand Down

0 comments on commit 8198c8f

Please sign in to comment.