diff --git a/doc/amazon_sagemaker_debugger.rst b/doc/amazon_sagemaker_debugger.rst index 23081138b1..2066aaf524 100644 --- a/doc/amazon_sagemaker_debugger.rst +++ b/doc/amazon_sagemaker_debugger.rst @@ -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 `_ + and `Debugger API `_. + + 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:: diff --git a/doc/api/training/debugger.rst b/doc/api/training/debugger.rst index 0fd1f1d3cd..3a8320474c 100644 --- a/doc/api/training/debugger.rst +++ b/doc/api/training/debugger.rst @@ -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: @@ -44,6 +49,9 @@ into your training job. :show-inheritance: :inherited-members: +Debugger Configuration APIs +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. autoclass:: CollectionConfig :show-inheritance: @@ -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 `_. + .. autoclass:: FrameworkProfile :show-inheritance: