diff --git a/doc/source/data/api/dataset.rst b/doc/source/data/api/dataset.rst index d803d313f674..39abcd36199a 100644 --- a/doc/source/data/api/dataset.rst +++ b/doc/source/data/api/dataset.rst @@ -33,4 +33,5 @@ Deprecated API :nosignatures: :toctree: doc/ - Dataset.iter_tf_batches \ No newline at end of file + Dataset.iter_tf_batches + Dataset.to_torch diff --git a/python/ray/data/dataset.py b/python/ray/data/dataset.py index 11eb6de5c174..c3fed90e4afc 100644 --- a/python/ray/data/dataset.py +++ b/python/ray/data/dataset.py @@ -4096,7 +4096,7 @@ def iter_tf_batches( ) @ConsumptionAPI(pattern="Time complexity:") - @PublicAPI(api_group=IOC_API_GROUP) + @Deprecated def to_torch( self, *, @@ -4207,7 +4207,11 @@ def to_torch( Returns: A `Torch IterableDataset`_. """ # noqa: E501 - + warnings.warn( + "`to_torch` is deprecated and will be removed after May 2025. Use " + "`iter_torch_batches` instead.", + DeprecationWarning, + ) return self.iterator().to_torch( label_column=label_column, feature_columns=feature_columns, diff --git a/python/ray/data/tests/test_torch.py b/python/ray/data/tests/test_torch.py index 00d250921814..024a8f1044c3 100644 --- a/python/ray/data/tests/test_torch.py +++ b/python/ray/data/tests/test_torch.py @@ -8,6 +8,11 @@ from ray.tests.conftest import * # noqa +def test_to_torch_emits_deprecation_warning(ray_start_10_cpus_shared): + with pytest.warns(DeprecationWarning): + ray.data.range(1).to_torch() + + def test_to_torch(ray_start_10_cpus_shared): import torch