You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source-pytorch/versioning.rst
+37-38Lines changed: 37 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,12 +53,8 @@ API Evolution
53
53
54
54
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.
55
55
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``.
62
58
63
59
This policy is not strict. Shorter or longer deprecation cycles may apply to some cases.
64
60
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
69
65
70
66
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>`_).
71
67
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]_.
72
69
73
70
.. list-table::
74
71
:header-rows: 1
@@ -82,102 +79,104 @@ The table below indicates the coverage of tested versions in our CI. Versions ou
82
79
* - 2.5
83
80
- 2.5
84
81
- 2.5
85
-
- ≥2.1, ≤2.7
82
+
- ≥2.1, (last tested 2.8)
86
83
- ≥0.7.0
87
-
- ≥3.9, ≤3.12
84
+
- ≥3.9, (last tested 3.12)
88
85
* - 2.4
89
86
- 2.4
90
87
- 2.4
91
-
- ≥2.1, ≤2.6
88
+
- ≥2.1, (last tested 2.6)
92
89
- ≥0.7.0
93
-
- ≥3.9, ≤3.12
90
+
- ≥3.9, (last tested 3.12)
94
91
* - 2.3
95
92
- 2.3
96
93
- 2.3
97
-
- ≥2.0, ≤2.3
94
+
- ≥2.0, (last tested 2.3)
98
95
- ≥0.7.0
99
-
- ≥3.8, ≤3.11
96
+
- ≥3.8, (last tested 3.11)
100
97
* - 2.2
101
98
- 2.2
102
99
- 2.2
103
-
- ≥1.13, ≤2.2
100
+
- ≥1.13, (last tested 2.2)
104
101
- ≥0.7.0
105
-
- ≥3.8, ≤3.11
102
+
- ≥3.8, (last tested 3.11)
106
103
* - 2.1
107
104
- 2.1
108
105
- 2.1
109
-
- ≥1.12, ≤2.1
106
+
- ≥1.12, (last tested 2.1)
110
107
- ≥0.7.0
111
-
- ≥3.8, ≤3.11
108
+
- ≥3.8, (last tested 3.11)
112
109
* - 2.0
113
110
- 2.0
114
111
- 2.0 (GA)
115
-
- ≥1.11, ≤2.0
112
+
- ≥1.11, (last tested 2.0)
116
113
- ≥0.7.0
117
-
- ≥3.8, ≤3.10
114
+
- ≥3.8, (last tested 3.10)
118
115
* - 1.9
119
116
- 1.9
120
117
- 1.9 (experimental)
121
-
- ≥1.10, ≤1.13
118
+
- ≥1.10, (last tested 1.13)
122
119
- ≥0.7.0
123
-
- ≥3.7, ≤3.10
120
+
- ≥3.7, (last tested 3.10)
124
121
* - 1.8**
125
122
- 1.8
126
123
- n/a***
127
-
- ≥1.10, ≤1.13
124
+
- ≥1.10, (last tested 1.13)
128
125
- ≥0.7.0
129
-
- ≥3.7, ≤3.10
126
+
- ≥3.7, (last tested 3.10)
130
127
* - n/a
131
128
- 1.7
132
129
- n/a***
133
-
- ≥1.9, ≤1.12
130
+
- ≥1.9, (last tested 1.12)
134
131
- ≥0.7.0
135
-
- ≥3.7, ≤3.10
132
+
- ≥3.7, (last tested 3.10)
136
133
* - n/a
137
134
- 1.6
138
135
- n/a***
139
-
- ≥1.8, ≤1.11
136
+
- ≥1.8, (last tested 1.11)
140
137
- ≥0.4.1
141
-
- ≥3.7, ≤3.9
138
+
- ≥3.7, (last tested 3.9)
142
139
* - n/a
143
140
- 1.5
144
141
- n/a***
145
-
- ≥1.7, ≤1.10
142
+
- ≥1.7, (last tested 1.10)
146
143
- ≥0.4.1
147
-
- ≥3.6, ≤3.9
144
+
- ≥3.6, (last tested 3.9)
148
145
* - n/a
149
146
- 1.4
150
147
- n/a
151
-
- ≥1.6, ≤1.9
148
+
- ≥1.6, (last tested 1.9)
152
149
- ≥0.4.0
153
-
- ≥3.6, ≤3.9
150
+
- ≥3.6, (last tested 3.9)
154
151
* - n/a
155
152
- 1.3
156
153
- n/a
157
-
- ≥1.4, ≤1.8
154
+
- ≥1.4, (last tested 1.8)
158
155
- ≥0.2.0
159
-
- ≥3.6, ≤3.9
156
+
- ≥3.6, (last tested 3.9)
160
157
* - n/a
161
158
- 1.2
162
159
- n/a
163
-
- ≥1.4, ≤1.8
160
+
- ≥1.4, (last tested 1.8)
164
161
- n/a*
165
-
- ≥3.6, ≤3.8
162
+
- ≥3.6, (last tested 3.8)
166
163
* - n/a
167
164
- 1.1
168
165
- n/a
169
-
- ≥1.3, ≤1.8
166
+
- ≥1.3, (last tested 1.8)
170
167
- n/a*
171
-
- ≥3.6, ≤3.8
168
+
- ≥3.6, (last tested 3.8)
172
169
* - n/a
173
170
- 1.0
174
171
- n/a
175
-
- ≥1.3, ≤1.7
172
+
- ≥1.3, (last tested 1.7)
176
173
- n/a*
177
-
- ≥3.6, ≤3.8
174
+
- ≥3.6, (last tested 3.8)
178
175
179
176
\* ``torchmetrics`` was part of ``pytorch_lightning`` at the time and was decoupled to a separate package in v1.3.
180
177
181
178
\*\* The joint ``lightning`` package was first published in version 1.8
182
179
183
180
\*\*\* 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