From f1d41c7aa9b9f2adba26016a404d75e260f75e1a Mon Sep 17 00:00:00 2001 From: Andrew Ho Date: Wed, 7 Aug 2024 18:10:35 -0400 Subject: [PATCH] Add datapipes deprecation warning banner to docs (#1312) Co-authored-by: Andrew Ho --- docs/source/conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3391a3dcc..b3a903058 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -160,3 +160,16 @@ 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.9.0 (Oct 2024) they will be deleted. Existing + users are advised to pin to `torchdata==0.8.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 `_ for feedback) + +"""