Skip to content

Commit 7555d69

Browse files
committed
doc: update documentation with v2.0.0.rc0 changes
1 parent 9977206 commit 7555d69

File tree

2 files changed

+90
-1
lines changed

2 files changed

+90
-1
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Changelog
22

3+
## v2.0.0.rc0
4+
5+
### Breaking Changes
6+
7+
* remove estimator parameters for TF legacy mode
8+
* remove legacy `TensorFlowModel` and `TensorFlowPredictor` classes
9+
* force image URI to be passed for legacy TF images
10+
* rename `sagemaker.tensorflow.serving` to `sagemaker.tensorflow.model`
11+
* require `framework_version` and `py_version` for framework estimator and model classes
12+
13+
### Bug Fixes and Other Changes
14+
15+
* add v2 migration tool
16+
17+
### Documentation Changes
18+
19+
* update TF documentation to reflect breaking changes and how to upgrade
20+
* start v2 usage and migration documentation
21+
22+
### Testing and Release Infrastructure
23+
24+
* remove scipy from dependencies
25+
* remove TF from optional dependencies
26+
327
## v1.60.2 (2020-05-29)
428

529
### Bug Fixes and Other Changes

doc/v2.rst

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,72 @@ If you are executing this pip install command in a notebook, make sure to restar
3535
Changes
3636
*******
3737

38-
To see what changes have been made, see the `CHANGELOG <https://github.com/aws/sagemaker-python-sdk/blob/zwei/CHANGELOG.md>`_.
38+
This section is for major changes that may require updates to your SageMaker Python SDK code.
39+
You can also see what changes have been made in the `CHANGELOG <https://github.com/aws/sagemaker-python-sdk/blob/zwei/CHANGELOG.md>`_.
40+
41+
Require ``framework_version`` and ``py_version`` for Frameworks
42+
===============================================================
43+
44+
Framework estimator and model classes now require ``framework_version`` and ``py_version`` instead of supplying defaults,
45+
unless an image URI is explicitly supplied.
46+
47+
For example:
48+
49+
.. code:: python
50+
51+
from sagemaker.tensorflow import TensorFlow
52+
53+
TensorFlow(
54+
entry_point="script.py",
55+
framework_version="2.2.0", # now required
56+
py_version="py37", # now required
57+
role="my-role",
58+
train_instance_type="ml.m5.xlarge",
59+
train_instance_count=1,
60+
)
61+
62+
from sagemaker.mxnet import MXNetModel
63+
64+
MXNetModel(
65+
model_data="s3://bucket/model.tar.gz",
66+
role="my-role",
67+
entry_point="inference.py",
68+
framework_version="1.6.0", # now required
69+
py_version="py3", # now required
70+
)
71+
72+
Deprecate Legacy TensorFlow
73+
===========================
74+
75+
TensorFlow versions 1.4-1.10 and some variations of versions 1.11-1.12
76+
(see `What Constitutes "Legacy TensorFlow Support" <frameworks/tensorflow/upgrade_from_legacy.html#what-constitutes-legacy-tensorflow-support>`_)
77+
are no longer natively supported by the SageMaker Python SDK.
78+
79+
To use those versions of TensorFlow, you must specify the Docker image URI explicitly,
80+
and configure settings via hyperparameters or environment variables rather than using SDK parameters.
81+
For more information, see `Upgrade from Legacy TensorFlow Support <frameworks/tensorflow/upgrade_from_legacy.html>`_.
82+
83+
Dependency Changes
84+
==================
85+
86+
SciPy
87+
-----
88+
89+
SciPy is no longer a required dependency of the SageMaker Python SDK.
90+
91+
If you use :func:`sagemaker.amazon.common.write_spmatrix_to_sparse_tensor` and
92+
don't already install SciPy in your environment, you can use our ``scipy`` installation target:
93+
94+
.. code:: bash
95+
96+
pip install sagemaker[scipy]
97+
98+
TensorFlow
99+
----------
100+
101+
The ``tensorflow`` installation target has been removed, as it is no longer needed for any SageMaker Python SDK functionality.
102+
103+
If you want to install TensorFlow, see `the TensorFlow documentation <https://www.tensorflow.org/install>`_.
39104

40105
*******************************
41106
Automatically Upgrade Your Code

0 commit comments

Comments
 (0)