DetailedProfilingConfig: DetailedProfilingConfig Class

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

DetailedProfilingConfig Class

Description

The configuration for framework metrics to be collected for detailed profiling.

Super class

sagemaker.common::MetricsConfigBase -> DetailedProfilingConfig

Methods

Public methods

• DetailedProfilingConfig$new()

• DetailedProfilingConfig$clone()

Inherited methods

• sagemaker.common::MetricsConfigBase$format()
• sagemaker.common::MetricsConfigBase$to_json_string()

---

Method new()

Specify target steps or a target duration to profile. By default, it profiles step 5 of training. If profile_default_steps is set to 'True' and none of the other range parameters is specified, the class uses the default configuration for detailed profiling.

Usage

DetailedProfilingConfig$new(
  start_step = NULL,
  num_steps = NULL,
  start_unix_time = NULL,
  duration = NULL,
  profile_default_steps = FALSE
)

Arguments

start_step

(int): The step to start profiling. The default is step 5.

num_steps

(int): The number of steps to profile. The default is for 1 step.

start_unix_time

(int): The Unix time to start profiling.

duration

(float): The duration in seconds to profile.

profile_default_steps

(bool): Indicates whether the default config should be used.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DetailedProfilingConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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