doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
laurenyu merged 5 commits into from
Jul 31, 2020
Merged

doc: document v2.0.0 changes #1774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2235b21
doc: document v2.0.0 changes
laurenyu Jul 29, 2020
5fcdd48
add new file
laurenyu Jul 30, 2020
2186fe7
Merge branch 'zwei' into v2-docs
laurenyu Jul 30, 2020
7cff1c2
Merge branch 'zwei' into v2-docs
laurenyu Jul 30, 2020
9600983
Merge branch 'zwei' into v2-docs
laurenyu Jul 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/api/utility/image_uris.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
:members:
:undoc-members:
:show-inheritance:
4 changes: 0 additions & 4 deletions doc/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down
99 changes: 75 additions & 24 deletions doc/v2.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
doc: document v2.0.0 changes#1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

laurenyu
merged 5 commits into

from

Jul 31, 2020
 Merged


doc: document v2.0.0 changes
#1774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2235b21

doc: document v2.0.0 changes


laurenyu Jul 29, 2020
5fcdd48

add new file


laurenyu Jul 30, 2020
2186fe7

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
7cff1c2

Merge branch 'zwei' into v2-docs


laurenyu Jul 30, 2020
9600983

Merge branch 'zwei' into v2-docs


laurenyu Jul 31, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
doc/api/utility/image_uris.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
Image URIs
----------

.. automodule:: sagemaker.image_uris
 :members:
 :undoc-members:
 :show-inheritance:

4 changes: 0 additions & 4 deletions
doc/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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
###########################
Expand Down

99 changes: 75 additions & 24 deletions
doc/v2.rst

View file


Open in desktop

Original file line numberDiff line numberDiff 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/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 <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
============
Expand DownExpand Up@@ -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.
Expand DownExpand Up@@ -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
================================

Expand DownExpand Up@@ -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
-------

Expand Down