Skip to content

Commit 3ab2524

Browse files
authored
docs: Add Version Lifecycle page under Getting Started (#5994)
Add a dedicated Version Lifecycle page documenting the maintenance lifecycle for the SDK's major versions, following the AWS SDKs and Tools maintenance policy. The page adopts the AWS version support matrix format: a top-level support matrix summarizing each major version's current phase and install command, followed by per-version phase tables (General Availability, Maintenance mode, End-of-Support) with start and end dates. Version metadata (V3 GA 2025-11-19, V2 GA 2020-08-04, V2 maintenance and end-of-support timelines) is sourced from the master-v2 README Version Lifecycle section. Styling follows the existing Getting Started pages: note admonitions, list-table directives, and doc cross-references for consistency. The page is registered in the Getting Started toctree in index.rst.
1 parent d7abb82 commit 3ab2524

2 files changed

Lines changed: 120 additions & 0 deletions

File tree

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ SageMaker Python SDK V3
1111
overview
1212
installation
1313
quickstart
14+
lifecycle
1415

1516
.. toctree::
1617
:maxdepth: 2

‎docs/lifecycle.rst‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
Version Lifecycle
2+
=================
3+
4+
The SageMaker Python SDK follows the `AWS SDKs and Tools maintenance policy
5+
<https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html>`_. This page
6+
describes the maintenance lifecycle for the major versions of the SDK and the
7+
timelines associated with each phase.
8+
9+
Version 3 became generally available on 2025-11-19 and is the actively developed
10+
major version. Version 2 is in maintenance mode: it receives critical bug fixes
11+
and security updates only, and will not receive new features, API updates, or new
12+
region support.
13+
14+
.. note::
15+
We recommend all users migrate to V3. See the `migration guide
16+
<https://github.com/aws/sagemaker-python-sdk/blob/master/migration.md>`_ for
17+
detailed guidance on moving from V2 to V3.
18+
19+
Version Support Matrix
20+
----------------------
21+
22+
The following table shows the available major versions of the SageMaker Python
23+
SDK and where each is in the maintenance lifecycle.
24+
25+
.. list-table::
26+
:header-rows: 1
27+
:widths: 20 25 35 20
28+
29+
* - Major Version
30+
- Current Phase
31+
- Install
32+
- General Availability
33+
* - Version 3
34+
- General Availability
35+
- ``pip install sagemaker``
36+
- 2025-11-19
37+
* - Version 2
38+
- Maintenance mode
39+
- ``pip install "sagemaker<3"``
40+
- 2020-08-04
41+
42+
Lifecycle Phases
43+
----------------
44+
45+
Each major version moves through the following phases, as defined by the
46+
`AWS SDKs and Tools maintenance policy
47+
<https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html>`_:
48+
49+
- **General Availability** -- the SDK is fully supported, with regular releases
50+
for new services, API updates, and bug and security fixes.
51+
- **Maintenance mode** -- AWS limits releases to critical bug fixes and security
52+
issues only. No new APIs, features, or region support are added.
53+
- **End-of-Support** -- the SDK no longer receives updates or releases.
54+
Previously published versions remain available on PyPI and the source remains
55+
on GitHub.
56+
57+
Version 3
58+
---------
59+
60+
Version 3 is the current, actively developed major version and is in the
61+
**General Availability** phase.
62+
63+
.. list-table::
64+
:header-rows: 1
65+
:widths: 40 30 30
66+
67+
* - Phase
68+
- Start Date
69+
- End Date
70+
* - General Availability
71+
- 2025-11-19
72+
- N/A
73+
74+
Version 2
75+
---------
76+
77+
Version 2 is in **Maintenance mode**. The following table shows its lifecycle
78+
phases and timelines.
79+
80+
.. list-table::
81+
:header-rows: 1
82+
:widths: 40 30 30
83+
84+
* - Phase
85+
- Start Date
86+
- End Date
87+
* - General Availability
88+
- 2020-08-04
89+
- N/A
90+
* - Maintenance mode
91+
- 2026-07-06
92+
- 2027-07-05
93+
* - End-of-Support
94+
- 2027-07-06
95+
- N/A
96+
97+
Managing Your Version
98+
---------------------
99+
100+
To upgrade to the latest V3 release:
101+
102+
.. code-block:: bash
103+
104+
pip install --upgrade sagemaker
105+
106+
To pin to V2 during migration:
107+
108+
.. code-block:: bash
109+
110+
pip install "sagemaker<3"
111+
112+
Next Steps
113+
----------
114+
115+
- Read the :doc:`overview` to understand what changed in V3
116+
- Follow the :doc:`installation` guide to set up V3
117+
- Review the `migration guide
118+
<https://github.com/aws/sagemaker-python-sdk/blob/master/migration.md>`_ to move
119+
from V2 to V3

0 commit comments

Comments
 (0)