MetricsConfigBase: The base class for the metrics configuration.

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

The base class for the metrics configuration.

Description

It determines the step or time range that needs to be profiled and validates the input value pairs. Available profiling range parameter pairs are (start_step and num_steps) and (start_unix_time and duration). The two parameter pairs are mutually exclusive, and this class validates if one of the two pairs is used. If both pairs are specified, a FOUND_BOTH_STEP_AND_TIME_FIELDS error occurs.

Methods

Public methods

• MetricsConfigBase$new()

• MetricsConfigBase$to_json_string()

• MetricsConfigBase$format()

• MetricsConfigBase$clone()

---

Method new()

Validate the provided range fields and set the range to be profiled accordingly.

Usage

MetricsConfigBase$new(
  name,
  start_step = NULL,
  num_steps = NULL,
  start_unix_time = NULL,
  duration = NULL
)

Arguments

name

(str): The name of the metrics config.

start_step

(int): The step to start profiling.

num_steps

(int): The number of steps to profile.

start_unix_time

(int): The Unix time to start profiling.

duration

(float): The duration in seconds to profile.

---

Method to_json_string()

Convert this metrics configuration to dictionary formatted as a string. Calling eval on the return value is the same as calling _to_json directly.

Usage

MetricsConfigBase$to_json_string()

Returns

str: This metrics configuration as a dictionary and formatted as a string.

---

Method format()

format class

Usage

MetricsConfigBase$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MetricsConfigBase$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.