Skip to content

[Docs] Host TensorDict docs inside TorchRL docs #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2022
Merged

[Docs] Host TensorDict docs inside TorchRL docs #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd11773
Pull tensordict docs into TorchRL docs
tcbegley Nov 21, 2022
1c0edf6
Add banner for tensordict docs
tcbegley Nov 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ jobs:
cd ./docs
conda run -n build_binary make html
cd ..
- name: Pull TensorDict docs
run: |
git subtree add --prefix=docs/build/html/tensordict --squash https://github.com/pytorch-labs/tensordict.git gh-pages
- name: Get output time
run: echo "The time was ${{ steps.build.outputs.time }}"
- name: Deploy
Expand Down
3 changes: 3 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
Welcome to the TorchRL Documentation!
=====================================

.. note::
The TensorDict class has been moved out of TorchRL into a dedicated library. Take a look at `the documentation <./tensordict>`_ or find the source code `on GitHub <https://github.com/pytorch-labs/tensordict>`_.

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.
Expand Down