Skip to content

Commit 9288c1f

Browse files
speediedanCopilotBorda
authored andcommitted
Update versioning governance document (#21107)
* Update versioning governance document per discussion in #21073 * Update docs/source-pytorch/versioning.rst simplify language --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> (cherry picked from commit a8f26e8)
1 parent b4cef86 commit 9288c1f

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

docs/source-pytorch/versioning.rst

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,8 @@ API Evolution
5353

5454
Lightning's development is driven by research and best practices in a rapidly developing field of AI and machine learning. Change is inevitable and when it happens, the Lightning team is committed to minimizing user friction and maximizing ease of transition from one version to the next. We take backwards compatibility and reproducibility very seriously.
5555

56-
For API removal, renaming or other forms of backwards-incompatible changes, the procedure is:
57-
58-
#. A deprecation process is initiated at a minor version ``MAJOR.MINOR.PATCH`` (e.g. ``1.5.0``), producing a deprecation warning at runtime and removing it from the documentation.
59-
#. The deprecated API remains unchanged during the deprecation phase for two minor versions or the next major update, whichever comes first.
60-
#. The breaking change is done in version ``MAJOR.(MINOR+2).0`` (e.g. ``1.7.0``), or ``(MAJOR+1).0.0`` (e.g. ``2.0.0``), whichever comes first.
61-
#. From that version onward, the deprecation warning gets converted into a helpful error, which will remain until next major release.
56+
Excepting extenuating circumstances (e.g. a critical bug), API removal, renaming or other forms of backwards-incompatible changes are limited to major version upgrades — that is ``(MAJOR+1).0.0``.
57+
Concretely, a breaking change for an API introduced in ``2.x.x`` can be introduced with Lightning ``3.0.0``.
6258

6359
This policy is not strict. Shorter or longer deprecation cycles may apply to some cases.
6460
For example, 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/pytorch-lightning/issues/12584>`_.
@@ -69,6 +65,7 @@ Compatibility matrix
6965

7066
PyTorch Lightning follows `NEP 29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_ which PyTorch also follows (`#74203 <https://github.com/pytorch/pytorch/issues/74203>`_).
7167
The table below indicates the coverage of tested versions in our CI. Versions outside the ranges may unofficially work in some cases.
68+
Since the release of PyTorch `2.0`, Lightning strives to officially support the latest 5 PyTorch minor releases with no breaking changes within major versions [1]_.
7269

7370
.. list-table::
7471
:header-rows: 1
@@ -82,102 +79,104 @@ The table below indicates the coverage of tested versions in our CI. Versions ou
8279
* - 2.5
8380
- 2.5
8481
- 2.5
85-
- ≥2.1, ≤2.7
82+
- ≥2.1, (last tested 2.8)
8683
- ≥0.7.0
87-
- ≥3.9, 3.12
84+
- ≥3.9, (last tested 3.12)
8885
* - 2.4
8986
- 2.4
9087
- 2.4
91-
- ≥2.1, 2.6
88+
- ≥2.1, (last tested 2.6)
9289
- ≥0.7.0
93-
- ≥3.9, 3.12
90+
- ≥3.9, (last tested 3.12)
9491
* - 2.3
9592
- 2.3
9693
- 2.3
97-
- ≥2.0, 2.3
94+
- ≥2.0, (last tested 2.3)
9895
- ≥0.7.0
99-
- ≥3.8, 3.11
96+
- ≥3.8, (last tested 3.11)
10097
* - 2.2
10198
- 2.2
10299
- 2.2
103-
- ≥1.13, 2.2
100+
- ≥1.13, (last tested 2.2)
104101
- ≥0.7.0
105-
- ≥3.8, 3.11
102+
- ≥3.8, (last tested 3.11)
106103
* - 2.1
107104
- 2.1
108105
- 2.1
109-
- ≥1.12, 2.1
106+
- ≥1.12, (last tested 2.1)
110107
- ≥0.7.0
111-
- ≥3.8, 3.11
108+
- ≥3.8, (last tested 3.11)
112109
* - 2.0
113110
- 2.0
114111
- 2.0 (GA)
115-
- ≥1.11, 2.0
112+
- ≥1.11, (last tested 2.0)
116113
- ≥0.7.0
117-
- ≥3.8, 3.10
114+
- ≥3.8, (last tested 3.10)
118115
* - 1.9
119116
- 1.9
120117
- 1.9 (experimental)
121-
- ≥1.10, 1.13
118+
- ≥1.10, (last tested 1.13)
122119
- ≥0.7.0
123-
- ≥3.7, 3.10
120+
- ≥3.7, (last tested 3.10)
124121
* - 1.8**
125122
- 1.8
126123
- n/a***
127-
- ≥1.10, 1.13
124+
- ≥1.10, (last tested 1.13)
128125
- ≥0.7.0
129-
- ≥3.7, 3.10
126+
- ≥3.7, (last tested 3.10)
130127
* - n/a
131128
- 1.7
132129
- n/a***
133-
- ≥1.9, 1.12
130+
- ≥1.9, (last tested 1.12)
134131
- ≥0.7.0
135-
- ≥3.7, 3.10
132+
- ≥3.7, (last tested 3.10)
136133
* - n/a
137134
- 1.6
138135
- n/a***
139-
- ≥1.8, 1.11
136+
- ≥1.8, (last tested 1.11)
140137
- ≥0.4.1
141-
- ≥3.7, 3.9
138+
- ≥3.7, (last tested 3.9)
142139
* - n/a
143140
- 1.5
144141
- n/a***
145-
- ≥1.7, 1.10
142+
- ≥1.7, (last tested 1.10)
146143
- ≥0.4.1
147-
- ≥3.6, 3.9
144+
- ≥3.6, (last tested 3.9)
148145
* - n/a
149146
- 1.4
150147
- n/a
151-
- ≥1.6, 1.9
148+
- ≥1.6, (last tested 1.9)
152149
- ≥0.4.0
153-
- ≥3.6, 3.9
150+
- ≥3.6, (last tested 3.9)
154151
* - n/a
155152
- 1.3
156153
- n/a
157-
- ≥1.4, 1.8
154+
- ≥1.4, (last tested 1.8)
158155
- ≥0.2.0
159-
- ≥3.6, 3.9
156+
- ≥3.6, (last tested 3.9)
160157
* - n/a
161158
- 1.2
162159
- n/a
163-
- ≥1.4, 1.8
160+
- ≥1.4, (last tested 1.8)
164161
- n/a*
165-
- ≥3.6, 3.8
162+
- ≥3.6, (last tested 3.8)
166163
* - n/a
167164
- 1.1
168165
- n/a
169-
- ≥1.3, 1.8
166+
- ≥1.3, (last tested 1.8)
170167
- n/a*
171-
- ≥3.6, 3.8
168+
- ≥3.6, (last tested 3.8)
172169
* - n/a
173170
- 1.0
174171
- n/a
175-
- ≥1.3, 1.7
172+
- ≥1.3, (last tested 1.7)
176173
- n/a*
177-
- ≥3.6, 3.8
174+
- ≥3.6, (last tested 3.8)
178175

179176
\* ``torchmetrics`` was part of ``pytorch_lightning`` at the time and was decoupled to a separate package in v1.3.
180177

181178
\*\* The joint ``lightning`` package was first published in version 1.8
182179

183180
\*\*\* Fabric is the evolution of ``LightningLite`` which was released inside ``pytorch_lightning`` 1.5 and was decoupled to a separate package in v1.9
181+
182+
.. [1] See `this community discussion <https://github.com/Lightning-AI/pytorch-lightning/issues/21073#issuecomment-3201706857>`_.

0 commit comments

Comments
 (0)