Welcome to the SMDebug documentation!

Introduction to SMDebug

• SMDebug: Amazon SageMaker Debugger Client Library
  • Table of Contents
  • Overview
  • Install the smdebug library
  • Debugger-supported Frameworks
  • How It Works
  • Examples
  • SageMaker Debugger in Action
  • Further Documentation and References
  • License
• Release Notes
  • SMDebug Library 1.0.10 Release Notes
  • SMDebug Library Release Notes

SMDebug Hooks

• Hook API
  • Create a Hook
• Hook Methods
  • Common Hook Methods
  • TensorFlow specific Hook API
  • MXNet specific Hook API
  • PyTorch specific Hook API
• Tensor Collections
  • Built in Collections
  • Default collections saved
  • Creating or retrieving a Collection
  • Properties of a Collection
  • Methods on a Collection
  • Configuring Collection using SageMaker Python SDK
• Configure Hook using SageMaker Python SDK
  • Path to SMDebug artifacts
• Additional Hook Config APIs
  • SaveConfig
  • ReductionConfig

Rules

• SMDebug Rules
  • Use Built-in Rules Officially Provided by SageMaker
  • Write Custom Rules Within or Outside SageMaker
• Rule API

SMDebug Debugger Modules

• SMDebug Trial
  • Create an SMDebug trial object
• Trial API
• Tensor API
• Modes for Tensors

SMDebug Profiler Modules

• Python Profiler Analysis API
• Python Stats Reader API
• SMDebug Profiler Analysis Utils
• SMDebug Profiler Visualization API

Handling Exceptions

• Exceptions

Glossary

• Glossary