Skip to content

documentation: Update SageMaker Debugger doc #3723

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
merged 5 commits into from
Apr 3, 2023
Merged

documentation: Update SageMaker Debugger doc #3723

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
002f422
update sm debugger doc
mchoi8739 Mar 15, 2023
0eaf671
improve toc
mchoi8739 Mar 15, 2023
c7d1df0
minor change
mchoi8739 Mar 15, 2023
cfc3148
white space fix
mchoi8739 Mar 17, 2023
91566ac
fix white space
mchoi8739 Mar 17, 2023
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
6 changes: 6 additions & 0 deletions doc/amazon_sagemaker_debugger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Amazon SageMaker Debugger
#########################


.. warning::

This page is no longer supported for maintenence. The live documentation is at `Debug and Profile Training Jobs Using Amazon SageMaker Debugger <https://docs.aws.amazon.com/sagemaker/latest/dg/train-debugger.html>`_
and `Debugger API <https://sagemaker.readthedocs.io/en/stable/api/training/debugger.html>`_.


Amazon SageMaker Debugger allows you to detect anomalies while training your machine learning model by emitting relevant data during training, storing the data and then analyzing it.

.. contents::
Expand Down
23 changes: 23 additions & 0 deletions doc/api/training/debugger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ Configure the Debugger-specific parameters when constructing
a SageMaker estimator to gain visibility and insights
into your training job.

.. contents::

.. currentmodule:: sagemaker.debugger

Debugger Rule APIs
~~~~~~~~~~~~~~~~~~

.. autoclass:: get_rule_container_image_uri
:show-inheritance:

Expand Down Expand Up @@ -44,6 +49,9 @@ into your training job.
:show-inheritance:
:inherited-members:

Debugger Configuration APIs
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: CollectionConfig
:show-inheritance:

Expand All @@ -56,6 +64,21 @@ into your training job.
.. autoclass:: ProfilerConfig
:show-inheritance:

Debugger Configuration APIs for Framework Profiling (Deprecated)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

SageMaker Debugger deprecates the framework profiling feature starting from TensorFlow 2.11 and PyTorch 2.0. You can still use the feature in the previous versions of the frameworks and SDKs as follows.

* SageMaker Python SDK <= v2.130.0
* PyTorch >= v1.6.0, < v2.0
* TensorFlow >= v2.3.1, < v2.11

With the deprecation, SageMaker Debugger discontinues support for the APIs below this note.

See also `Amazon SageMaker Debugger Release Notes: March 16, 2023 <https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-release-notes.html#debugger-release-notes-20230315>`_.

.. autoclass:: FrameworkProfile
:show-inheritance:

Expand Down