|
1 |
| -########################################################## |
2 |
| -Use Version 2.0 of the SageMaker Python SDK (experimental) |
3 |
| -########################################################## |
4 |
| - |
5 |
| -Development on v2.0.0 of the SageMaker Python SDK is underway. |
6 |
| -For more info on our plans, see https://github.com/aws/sagemaker-python-sdk/issues/1459. |
| 1 | +########################################### |
| 2 | +Use Version 2.x of the SageMaker Python SDK |
| 3 | +########################################### |
7 | 4 |
|
8 | 5 | .. contents::
|
9 | 6 | :local:
|
| 7 | + :depth: 2 |
10 | 8 |
|
11 | 9 | ************
|
12 | 10 | Installation
|
13 | 11 | ************
|
14 | 12 |
|
15 |
| -.. warning:: |
16 |
| - Version 2.0.0 is currently experimental, so proceed with caution. If you do run into issues or have any other feedback, |
17 |
| - please let us know by `opening an issue <https://github.com/aws/sagemaker-python-sdk/issues/new/choose>`_ |
18 |
| - or `commenting on our planning issue <https://github.com/aws/sagemaker-python-sdk/issues/1459>`_. |
19 |
| - |
20 |
| -To install the latest release candidate: |
21 |
| - |
22 |
| -.. code:: bash |
23 |
| -
|
24 |
| - pip install git+git://github.com/aws/[email protected] |
25 |
| -
|
26 |
| -To install the latest version of v2: |
| 13 | +To install the latest version: |
27 | 14 |
|
28 | 15 | .. code:: bash
|
29 | 16 |
|
30 |
| - pip install git+git://github.com/aws/sagemaker-python-sdk.git@zwei |
| 17 | + pip install --upgrade sagemaker |
31 | 18 |
|
32 | 19 | If you are executing this pip install command in a notebook, make sure to restart your kernel.
|
33 | 20 |
|
34 |
| -******* |
35 |
| -Changes |
36 |
| -******* |
| 21 | +**************** |
| 22 | +Breaking Changes |
| 23 | +**************** |
37 | 24 |
|
38 | 25 | 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>`_. |
| 26 | +For the full list of changes, see the `CHANGELOG <https://github.com/aws/sagemaker-python-sdk/blob/master/CHANGELOG.md>`_. |
40 | 27 |
|
41 | 28 | Deprecations
|
42 | 29 | ============
|
@@ -127,8 +114,46 @@ write MIME types as a string,
|
127 | 114 | | ``CONTENT_TYPE_NPY`` | ``"application/x-npy"`` |
|
128 | 115 | +-------------------------------+--------------------------------+
|
129 | 116 |
|
| 117 | +Image URI Functions (e.g. ``get_image_uri``) |
| 118 | +-------------------------------------------- |
| 119 | + |
| 120 | +The following functions have been deprecated in favor of :func:`sagemaker.image_uris.retrieve`: |
| 121 | + |
| 122 | +- ``sagemaker.amazon_estimator.get_image_uri()`` |
| 123 | +- ``sagemaker.fw_utils.create_image_uri()`` |
| 124 | +- ``sagemaker.fw_registry.registry()`` |
| 125 | +- ``sagemaker.utils.get_ecr_image_uri_prefix()`` |
| 126 | + |
| 127 | +For more information about usage, see :func:`sagemaker.image_uris.retrieve`. |
| 128 | + |
| 129 | +SageMaker Python SDK CLI |
| 130 | +------------------------ |
| 131 | + |
| 132 | +The SageMaker Python SDK CLI has been deprecated. |
| 133 | +(This is different from the AWS CLI.) |
| 134 | + |
| 135 | +``enable_cloudwatch_metrics`` for Estimators and Models |
| 136 | +------------------------------------------------------- |
| 137 | + |
| 138 | +The parameter ``enable_cloudwatch_metrics`` has been deprecated. |
| 139 | +CloudWatch metrics are already emitted for all Training Jobs, etc. |
| 140 | + |
| 141 | +``sagemaker.fw_utils.parse_s3_url`` |
| 142 | +----------------------------------- |
| 143 | + |
| 144 | +The ``sagemaker.fw_utils.parse_s3_url`` function has been deprecated. |
| 145 | +Please use :func:`sagemaker.s3.parse_s3_url` instead. |
| 146 | + |
| 147 | +``sagemaker.session.ModelContainer`` |
| 148 | +------------------------------------ |
| 149 | + |
| 150 | +The class ``sagemaker.session.ModelContainer`` has been deprecated, as it is not needed for creating inference pipelines. |
| 151 | + |
| 152 | +Changes in Default Behavior |
| 153 | +=========================== |
| 154 | + |
130 | 155 | Require ``framework_version`` and ``py_version`` for Frameworks
|
131 |
| -=============================================================== |
| 156 | +--------------------------------------------------------------- |
132 | 157 |
|
133 | 158 | Framework estimator and model classes now require ``framework_version`` and ``py_version`` instead of supplying defaults,
|
134 | 159 | unless an image URI is explicitly supplied.
|
@@ -158,6 +183,19 @@ For example:
|
158 | 183 | py_version="py3", # now required
|
159 | 184 | )
|
160 | 185 |
|
| 186 | +Log Display Behavior with ``attach()`` |
| 187 | +-------------------------------------- |
| 188 | + |
| 189 | +Logs are no longer printed when using ``attach()`` with an estimator. |
| 190 | +To view logs after attaching a training job to an estimator, use :func:`sagemaker.estimator.EstimatorBase.logs`. |
| 191 | + |
| 192 | +``HyperparameterTuner.fit()`` and ``Transformer.transform()`` |
| 193 | +------------------------------------------------------------- |
| 194 | + |
| 195 | +:func:`sagemaker.tuner.HyperparameterTuner.fit` and :func:`sagemaker.transformer.Transformer.transform` now wait |
| 196 | +until the completion of the Hyperparameter Tuning Job or Batch Transform Job, respectively. |
| 197 | +To make the function non-blocking, use ``wait=False``. |
| 198 | + |
161 | 199 | Parameter and Class Name Changes
|
162 | 200 | ================================
|
163 | 201 |
|
@@ -281,6 +319,19 @@ TensorFlow Serving Predictor
|
281 | 319 | (For the previous implementation of that class, see `Deprecate Legacy TensorFlow <#deprecate-legacy-tensorflow>`_).
|
282 | 320 |
|
283 | 321 |
|
| 322 | +Inputs |
| 323 | +------ |
| 324 | + |
| 325 | +``s3_input`` |
| 326 | +~~~~~~~~~~~~ |
| 327 | + |
| 328 | +``sagemaker.session.s3_input`` has been renamed to :class:`sagemaker.inputs.TrainingInput`. |
| 329 | + |
| 330 | +``ShuffleConfig`` |
| 331 | +~~~~~~~~~~~~~~~~~ |
| 332 | + |
| 333 | +``sagemaker.session.ShuffleConfig`` has been renamed to :class:`sagemaker.inputs.ShuffleConfig`. |
| 334 | + |
284 | 335 | Airflow
|
285 | 336 | -------
|
286 | 337 |
|
|
0 commit comments