Skip to content

Commit

Permalink
Update docs to reflect current status (#1458)
Browse files Browse the repository at this point in the history
Removes the disclaimers about what will be removed, as that has all been removed.
  • Loading branch information
scotts authored Feb 26, 2025
1 parent c8cdedf commit fd1c5bb
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 26 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Your contributions may fall into the following categories:

- If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the
feature with us.
- We have a checklist of things to go through while adding a new DataPipe. See below.
- We have a checklist of things to go through while adding a new Node. See below.
- If you would like to feature a usage example in our documentation, discuss that with us in an issue.

## Issues
Expand Down
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
# TorchData (see note below on current status)
# TorchData

[**What is TorchData?**](#what-is-torchdata) | [**Stateful DataLoader**](#stateful-dataloader) |
[**Install guide**](#installation) | [**Contributing**](#contributing) | [**License**](#license)

**:warning: June 2024 Status Update: Removing DataPipes and DataLoader V2**

**We are re-focusing the torchdata repo to be an iterative enhancement of torch.utils.data.DataLoader. We do not plan on
continuing development or maintaining the [`DataPipes`] and [`DataLoaderV2`] solutions, and they will be removed from
the torchdata repo. We'll also be revisiting the `DataPipes` references in pytorch/pytorch. In release
`torchdata==0.8.0` (July 2024) they will be marked as deprecated, and sometime after 0.9.0 (Oct 2024) they will be
deleted. Existing users are advised to pin to `torchdata==0.9.0` or an older version until they are able to migrate
away. Subsequent releases will not include DataPipes or DataLoaderV2. The old version of this README is
[available here](https://github.com/pytorch/data/blob/v0.7.1/README.md). Please reach out if you suggestions or comments
(please use [#1196](https://github.com/pytorch/data/issues/1196) for feedback).**

##

## What is TorchData?
Expand Down
13 changes: 0 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,16 +117,3 @@ def setup(app):
intersphinx_mapping = {
"graphviz": ("https://graphviz.readthedocs.io/en/stable/", None),
}

rst_prolog = """.. attention::
**June 2024 Status Update: Removing DataPipes and DataLoader V2**
We are re-focusing the torchdata repo to be an iterative enhancement of torch.utils.data.DataLoader. We do not plan on
continuing development or maintaining the [`DataPipes`] and [`DataLoaderV2`] solutions, and they will be removed from
the torchdata repo. We'll also be revisiting the `DataPipes` references in pytorch/pytorch. In release
`torchdata==0.8.0` (July 2024) they will be marked as deprecated, and in 0.10.0 (Late 2024) they will be deleted. Existing
users are advised to pin to `torchdata<=0.9.0` or an older version until they are able to migrate away. Subsequent
releases will not include DataPipes or DataLoaderV2.
Please reach out if you suggestions or comments (please use `this issue <https://github.com/pytorch/data/issues/1196>`_ for feedback)
"""

0 comments on commit fd1c5bb

Please sign in to comment.