Skip to content

Commit b4b651c

Browse files
authored
Update docs regarding deprecation window (#15089)
1 parent e11b2b1 commit b4b651c

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/source-pytorch/versioning.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ For API removal, renaming or other forms of backwards-incompatible changes, the
5252
#. A deprecation process is initiated at a minor version ``X``, producing a deprecation warning at runtime and in the documentation.
5353
#. The deprecated API remains unchanged during the deprecation phase for two minor versions.
5454
#. The breaking change takes effect at a minor version ``X+2``.
55+
#. From version ``X+2`` onward, the deprecation warning gets converted into a helpful error, which will remain as long as possible.
5556

5657
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 <https://github.com/Lightning-AI/lightning/issues/12584>`_. Also, `#10410 <https://github.com/Lightning-AI/lightning/issues/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.
5758

0 commit comments

Comments
 (0)