[Feature Request] Document `get_sub_tensordict` in the `TensorDict` tutorial
@vmoens is already working on this.
Since Aug 7, 2022.
- Dominant language
- Python
- Stars
- 3.6k
- Forks
- 487
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 207
Description
Motivation
TensorDict.get_sub_tensordict() is quite useful when working with indexed memmap tensors (as they do no share storage as torch.Tensor do). However, this is currently not documented in the TensorDict tutorial. Since it is not the default behaviour of __getitem__ since #340, this should be properly documented.
The description of the feature should include:
- Indexing with
torch.Tensorswhile keeping the same storage - Indexing tensordicts that contain memmap tensors
Besides, the places in the tests where get_sub_tensordict is used should be also commented.
We could consider moving this to an "advanced" tensordict tutorial section, since this is a feature that most users may not be interested in.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.