From 3446e871a9924f669b116068b066df402035d521 Mon Sep 17 00:00:00 2001 From: awaelchli Date: Tue, 11 Oct 2022 22:15:01 +0200 Subject: [PATCH] udpate docs --- docs/source-pytorch/versioning.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source-pytorch/versioning.rst b/docs/source-pytorch/versioning.rst index b3491dd0d1de7..d9ba06d58e453 100644 --- a/docs/source-pytorch/versioning.rst +++ b/docs/source-pytorch/versioning.rst @@ -52,6 +52,7 @@ For API removal, renaming or other forms of backwards-incompatible changes, the #. A deprecation process is initiated at a minor version ``X``, producing a deprecation warning at runtime and in the documentation. #. The deprecated API remains unchanged during the deprecation phase for two minor versions. #. The breaking change takes effect at a minor version ``X+2``. +#. From version ``X+2`` onward, the deprecation warning gets converted into a helpful error, which will remain as long as possible. The ``X+2`` rule is a recommendation and not a strict requirement. Shorter or longer deprecation cycles may apply to some cases. In the past, DDP2 was removed without a deprecation process because the feature was broken and unusable beyond fixing as discussed in `#12584 `_. Also, `#10410 `_ is an example that a longer deprecation applied to. We deprecated the accelerator arguments, such as ``Trainer(gpus=...)``, in 1.7, however, because the APIs were so core that they would impact almost all use cases, we decided not to introduce the breaking change until 2.0.