StopTraining: Debugger StopTraining Action class

In DyfanJones/sagemaker-r-debugger: R6sagemaker debugger for sagemaker operations

Description

Action for stopping the training job when a rule is fired.

Super class

sagemaker.debugger::Action -> StopTraining

Methods

Public methods

• StopTraining$new()

• StopTraining$update_training_job_prefix_if_not_specified()

• StopTraining$clone()

Inherited methods

• sagemaker.debugger::Action$format()

• sagemaker.debugger::Action$serialize()

---

Method new()

Note that a policy must be created in the AWS account to allow the sagemaker role to stop the training job.

Usage

StopTraining$new(training_job_prefix = NULL)

Arguments

training_job_prefix

: The prefix of the training job to stop if the rule is fired. This must only refer to one active training job, otherwise no training job will be stopped.

---

Method update_training_job_prefix_if_not_specified()

Update the training job prefix to be the training job name if the user has not already specified a custom training job prefix. This is only meant to be called via the sagemaker SDK when 'estimator.fit' is called by the user. Validation is purposely excluded here so that any failures in validation of the training job name are intentionally caught in the sagemaker SDK and not here.

Usage

StopTraining$update_training_job_prefix_if_not_specified(training_job_name)

Arguments

training_job_name

: Name of the training job, passed in when 'estimator.fit' is called.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StopTraining$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-debugger documentation built on Jan. 20, 2022, 5:49 p.m.