RuleBase: The SageMaker Debugger rule base class that cannot be...

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

The SageMaker Debugger rule base class that cannot be instantiated directly.

Description

Debugger rule classes inheriting this RuleBase class are :class:'~sagemaker.debugger.Rule' and :class:'~sagemaker.debugger.ProfilerRule'. Do not directly use the rule base class to instantiate a SageMaker Debugger rule. Use the :class:'~sagemaker.debugger.Rule' classmethods for debugging and the :class:'~sagemaker.debugger.ProfilerRule' classmethods for profiling.

Public fields

name

(str): The name of the rule.

image_uri

(str): The image URI to use the rule.

instance_type

(str): Type of EC2 instance to use. For example, 'ml.c4.xlarge'.

container_local_output_path

(str): The local path to store the Rule output.

s3_output_path

(str): The location in S3 to store the output.

volume_size_in_gb

(int): Size in GB of the EBS volume to use for storing data.

rule_parameters

(dict): A dictionary of parameters for the rule.

Methods

Public methods

• RuleBase$new()

• RuleBase$format()

• RuleBase$clone()

---

Method new()

Initialize RuleBase class

Usage

RuleBase$new(
  name = NULL,
  image_uri = NULL,
  instance_type = NULL,
  container_local_output_path = NULL,
  s3_output_path = NULL,
  volume_size_in_gb = NULL,
  rule_parameters = NULL
)

Arguments

name

(str): The name of the rule.

image_uri

(str): The image URI to use the rule.

instance_type

(str): Type of EC2 instance to use. For example, 'ml.c4.xlarge'.

container_local_output_path

(str): The local path to store the Rule output.

s3_output_path

(str): The location in S3 to store the output.

volume_size_in_gb

(int): Size in GB of the EBS volume to use for storing data.

rule_parameters

(dict): A dictionary of parameters for the rule.

---

Method format()

format class

Usage

RuleBase$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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