diff --git a/doc/api/utility/image_uris.rst b/doc/api/utility/image_uris.rst new file mode 100644 index 0000000000..e6be7e8424 --- /dev/null +++ b/doc/api/utility/image_uris.rst @@ -0,0 +1,7 @@ +Image URIs +---------- + +.. automodule:: sagemaker.image_uris + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/index.rst b/doc/index.rst index ebdff5d7ae..cdcb9f8608 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,7 +1,3 @@ -.. important:: - We are working on v2.0.0. See https://github.com/aws/sagemaker-python-sdk/issues/1459 - for more info on our plans and to leave feedback! - ########################### Amazon SageMaker Python SDK ########################### diff --git a/doc/v2.rst b/doc/v2.rst index 0d1a3b3381..31c0ab8b7c 100644 --- a/doc/v2.rst +++ b/doc/v2.rst @@ -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 `_ - or `commenting on our planning issue `_. - -To install the latest release candidate: - -.. code:: bash - - pip install git+git://github.com/aws/sagemaker-python-sdk.git@v2.0.0.rc1 - -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 `_. +For the full list of changes, see the `CHANGELOG `_. Deprecations ============ @@ -127,8 +114,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 +183,19 @@ 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``. + Parameter and Class Name Changes ================================ @@ -281,6 +319,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 -------