DebuggerHookConfig: Create a Debugger hook configuration object to save the...

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

Create a Debugger hook configuration object to save the tensor for debugging.

Description

DebuggerHookConfig provides options to customize how debugging information is emitted and saved. This high-level DebuggerHookConfig class runs based on the 'smdebug.SaveConfig https://github.com/awslabs/sagemaker-debugger/blob/master/docs/api.md#saveconfig class.

Public fields

s3_output_path

The location in Amazon S3 to store the output tensors

container_local_output_path

The local path in the container

hook_parameters

A dictionary of parameters

collection_configs

A list of :class:'~sagemaker.debugger.CollectionConfig

Methods

Public methods

• DebuggerHookConfig$new()

• DebuggerHookConfig$to_request_list()

• DebuggerHookConfig$format()

• DebuggerHookConfig$clone()

---

Method new()

Initialize the DebuggerHookConfig instance.

Usage

DebuggerHookConfig$new(
  s3_output_path = NULL,
  container_local_output_path = NULL,
  hook_parameters = NULL,
  collection_configs = NULL
)

Arguments

s3_output_path

(str): Optional. The location in Amazon S3 to store the output tensors. The default Debugger output path 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>/debug-output/.

container_local_output_path

(str): Optional. The local path in the container.

hook_parameters

(dict): Optional. A dictionary of parameters.

collection_configs

([sagemaker.debugger.CollectionConfig]): Required. A list of :class:'~sagemaker.debugger.CollectionConfig' objects to be saved at the s3_output_path.

---

Method to_request_list()

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

Usage

DebuggerHookConfig$to_request_list()

Returns

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

---

Method format()

format class

Usage

DebuggerHookConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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