-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'zwei' into deprecate-ecr-prefix
- Loading branch information
Showing
29 changed files
with
1,378 additions
and
476 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Image URIs | ||
---------- | ||
|
||
.. automodule:: sagemaker.image_uris | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,29 @@ | ||
########################################################## | ||
Use Version 2.0 of the SageMaker Python SDK (experimental) | ||
########################################################## | ||
|
||
Development on v2.0.0 of the SageMaker Python SDK is underway. | ||
For more info on our plans, see https://github.com/aws/sagemaker-python-sdk/issues/1459. | ||
########################################### | ||
Use Version 2.x of the SageMaker Python SDK | ||
########################################### | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 2 | ||
|
||
************ | ||
Installation | ||
************ | ||
|
||
.. warning:: | ||
Version 2.0.0 is currently experimental, so proceed with caution. If you do run into issues or have any other feedback, | ||
please let us know by `opening an issue <https://github.com/aws/sagemaker-python-sdk/issues/new/choose>`_ | ||
or `commenting on our planning issue <https://github.com/aws/sagemaker-python-sdk/issues/1459>`_. | ||
|
||
To install the latest release candidate: | ||
|
||
.. code:: bash | ||
pip install git+git://github.com/aws/[email protected] | ||
To install the latest version of v2: | ||
To install the latest version: | ||
|
||
.. code:: bash | ||
pip install git+git://github.com/aws/sagemaker-python-sdk.git@zwei | ||
pip install --upgrade sagemaker | ||
If you are executing this pip install command in a notebook, make sure to restart your kernel. | ||
|
||
******* | ||
Changes | ||
******* | ||
**************** | ||
Breaking Changes | ||
**************** | ||
|
||
This section is for major changes that may require updates to your SageMaker Python SDK code. | ||
You can also see what changes have been made in the `CHANGELOG <https://github.com/aws/sagemaker-python-sdk/blob/zwei/CHANGELOG.md>`_. | ||
For the full list of changes, see the `CHANGELOG <https://github.com/aws/sagemaker-python-sdk/blob/master/CHANGELOG.md>`_. | ||
|
||
Deprecations | ||
============ | ||
|
@@ -94,6 +81,13 @@ Please instantiate the objects instead. | |
The ``update_endpoint`` argument in ``deploy()`` methods for estimators and models has been deprecated. | ||
Please use :func:`sagemaker.predictor.Predictor.update_endpoint` instead. | ||
|
||
``serializer`` and ``deserializer`` in ``create_model()`` | ||
--------------------------------------------------------- | ||
|
||
The ``serializer`` and ``deserializer`` arguments in | ||
:func:`sagemaker.estimator.Estimator.create_model` have been deprecated. Please | ||
specify serializers and deserializers in ``deploy()`` methods instead. | ||
|
||
``content_type`` and ``accept`` in the Predictor Constructor | ||
------------------------------------------------------------ | ||
|
||
|
@@ -127,8 +121,46 @@ write MIME types as a string, | |
| ``CONTENT_TYPE_NPY`` | ``"application/x-npy"`` | | ||
+-------------------------------+--------------------------------+ | ||
|
||
Image URI Functions (e.g. ``get_image_uri``) | ||
-------------------------------------------- | ||
|
||
The following functions have been deprecated in favor of :func:`sagemaker.image_uris.retrieve`: | ||
|
||
- ``sagemaker.amazon_estimator.get_image_uri()`` | ||
- ``sagemaker.fw_utils.create_image_uri()`` | ||
- ``sagemaker.fw_registry.registry()`` | ||
- ``sagemaker.utils.get_ecr_image_uri_prefix()`` | ||
|
||
For more information about usage, see :func:`sagemaker.image_uris.retrieve`. | ||
|
||
SageMaker Python SDK CLI | ||
------------------------ | ||
|
||
The SageMaker Python SDK CLI has been deprecated. | ||
(This is different from the AWS CLI.) | ||
|
||
``enable_cloudwatch_metrics`` for Estimators and Models | ||
------------------------------------------------------- | ||
|
||
The parameter ``enable_cloudwatch_metrics`` has been deprecated. | ||
CloudWatch metrics are already emitted for all Training Jobs, etc. | ||
|
||
``sagemaker.fw_utils.parse_s3_url`` | ||
----------------------------------- | ||
|
||
The ``sagemaker.fw_utils.parse_s3_url`` function has been deprecated. | ||
Please use :func:`sagemaker.s3.parse_s3_url` instead. | ||
|
||
``sagemaker.session.ModelContainer`` | ||
------------------------------------ | ||
|
||
The class ``sagemaker.session.ModelContainer`` has been deprecated, as it is not needed for creating inference pipelines. | ||
|
||
Changes in Default Behavior | ||
=========================== | ||
|
||
Require ``framework_version`` and ``py_version`` for Frameworks | ||
=============================================================== | ||
--------------------------------------------------------------- | ||
|
||
Framework estimator and model classes now require ``framework_version`` and ``py_version`` instead of supplying defaults, | ||
unless an image URI is explicitly supplied. | ||
|
@@ -158,6 +190,25 @@ For example: | |
py_version="py3", # now required | ||
) | ||
Log Display Behavior with ``attach()`` | ||
-------------------------------------- | ||
|
||
Logs are no longer printed when using ``attach()`` with an estimator. | ||
To view logs after attaching a training job to an estimator, use :func:`sagemaker.estimator.EstimatorBase.logs`. | ||
|
||
``HyperparameterTuner.fit()`` and ``Transformer.transform()`` | ||
------------------------------------------------------------- | ||
|
||
:func:`sagemaker.tuner.HyperparameterTuner.fit` and :func:`sagemaker.transformer.Transformer.transform` now wait | ||
until the completion of the Hyperparameter Tuning Job or Batch Transform Job, respectively. | ||
To make the function non-blocking, use ``wait=False``. | ||
|
||
XGBoost Predictor | ||
----------------- | ||
|
||
The default serializer of ``sagemaker.xgboost.model.XGBoostPredictor`` has been changed from ``NumpySerializer`` to ``LibSVMSerializer``. | ||
|
||
|
||
Parameter and Class Name Changes | ||
================================ | ||
|
||
|
@@ -218,6 +269,8 @@ The follow serializer/deserializer classes have been renamed and/or moved: | |
| ``sagemaker.predictor._JsonDeserializer`` | ``sagemaker.deserializers.JSONDeserializer`` | | ||
+--------------------------------------------------------+-------------------------------------------------------+ | ||
|
||
``sagemaker.serializers.LibSVMSerializer`` has been added in v2.0. | ||
|
||
``distributions`` | ||
~~~~~~~~~~~~~~~~~ | ||
|
||
|
@@ -281,6 +334,19 @@ TensorFlow Serving Predictor | |
(For the previous implementation of that class, see `Deprecate Legacy TensorFlow <#deprecate-legacy-tensorflow>`_). | ||
|
||
|
||
Inputs | ||
------ | ||
|
||
``s3_input`` | ||
~~~~~~~~~~~~ | ||
|
||
``sagemaker.session.s3_input`` has been renamed to :class:`sagemaker.inputs.TrainingInput`. | ||
|
||
``ShuffleConfig`` | ||
~~~~~~~~~~~~~~~~~ | ||
|
||
``sagemaker.session.ShuffleConfig`` has been renamed to :class:`sagemaker.inputs.ShuffleConfig`. | ||
|
||
Airflow | ||
------- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"). You | ||
# may not use this file except in compliance with the License. A copy of | ||
# the License is located at | ||
# | ||
# http://aws.amazon.com/apache2.0/ | ||
# | ||
# or in the "license" file accompanying athis file. This file is | ||
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF | ||
# ANY KIND, either express or implied. See the License for the specific | ||
# language governing permissions and limitations under the License. | ||
"""Tools for automating code updates""" | ||
from __future__ import absolute_import |
Oops, something went wrong.