Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 2.88 KB

debugger.rst

File metadata and controls

102 lines (71 loc) · 2.88 KB
Raw

Debugger

Amazon SageMaker Debugger provides full visibility into training jobs of state-of-the-art machine learning models. This SageMaker Debugger module provides high-level methods to set up Debugger configurations to monitor, profile, and debug your training job. 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:


.. autoclass:: get_default_profiler_rule
    :show-inheritance:

A helper module to configure the SageMaker Debugger built-in rules with the :class:`~sagemaker.debugger.Rule` classmethods and and the :class:`~sagemaker.debugger.ProfilerRule` classmethods.

For a full list of built-in rules, see List of Debugger Built-in Rules.

This module is imported from the Debugger client library for rule configuration. For more information, see Amazon SageMaker Debugger RulesConfig.

.. autoclass:: RuleBase
    :show-inheritance:


.. autoclass:: Rule
    :show-inheritance:
    :inherited-members:


.. autoclass:: ProfilerRule
    :show-inheritance:
    :inherited-members:

Debugger Configuration APIs

.. autoclass:: CollectionConfig
    :show-inheritance:


.. autoclass:: DebuggerHookConfig
    :show-inheritance:


.. autoclass:: TensorBoardOutputConfig
    :show-inheritance:


.. 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:


.. autoclass:: DetailedProfilingConfig
    :show-inheritance:


.. autoclass:: DataloaderProfilingConfig
    :show-inheritance:


.. autoclass:: PythonProfilingConfig
    :show-inheritance:


.. autoclass:: PythonProfiler
    :show-inheritance:


.. autoclass:: cProfileTimer
    :show-inheritance:


.. automodule:: sagemaker.debugger.metrics_config
    :members: StepRange, TimeRange
    :undoc-members: