ProfilerConfig: Configuration for collecting system and framework metrics of...

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

Configuration for collecting system and framework metrics of SageMaker training jobs.

Description

SageMaker Debugger collects system and framework profiling information of training jobs and identify performance bottlenecks.

Methods

Public methods

• ProfilerConfig$new()

• ProfilerConfig$to_request_list()

• ProfilerConfig$format()

• ProfilerConfig$clone()

---

Method new()

Initialize a “ProfilerConfig“ instance. Pass the output of this class to the “profiler_config“ parameter of the generic :class:'~sagemaker.estimator.Estimator' class and SageMaker Framework estimators.

Usage

ProfilerConfig$new(
  s3_output_path = NULL,
  system_monitor_interval_millis = NULL,
  framework_profile_params = NULL
)

Arguments

s3_output_path

(str): The location in Amazon S3 to store the output. The default Debugger output path for profiling data is created under the default output path of the :class:'~sagemaker.estimator.Estimator' class. For example, s3://sagemaker-<region>-<12digit_account_id>/<training-job-name>/profiler-output/.

system_monitor_interval_millis

(int): The time interval in milliseconds to collect system metrics. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default is 500 milliseconds.

framework_profile_params

(:class:'~sagemaker.debugger.FrameworkProfile'): A parameter object for framework metrics profiling. Configure it using the :class:'~sagemaker.debugger.FrameworkProfile' class. To use the default framework profile parameters, pass “FrameworkProfile()“. For more information about the default values, see :class:'~sagemaker.debugger.FrameworkProfile'.

Examples

# The following example shows the basic ``profiler_config``
# parameter configuration, enabling system monitoring every 5000 milliseconds
# and framework profiling with default parameter values.
library(sagemaker.common)

profiler_config = ProfilerConfig$new(
      system_monitor_interval_millis = 5000,
      framework_profile_params = FrameworkProfile$new()
 )

---

Method to_request_list()

Generate a request dictionary using the parameters provided when initializing the object.

Usage

ProfilerConfig$to_request_list()

Returns

dict: An portion of an API request as a dictionary.

---

Method format()

format class

Usage

ProfilerConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ProfilerConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `ProfilerConfig$new`
## ------------------------------------------------

# The following example shows the basic ``profiler_config``
# parameter configuration, enabling system monitoring every 5000 milliseconds
# and framework profiling with default parameter values.
library(sagemaker.common)

profiler_config = ProfilerConfig$new(
      system_monitor_interval_millis = 5000,
      framework_profile_params = FrameworkProfile$new()
 )

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.