ClarifyBaseliningJob: ClarifyBaseliningJob class

In DyfanJones/sagemaker-r-mlcore: sagemaker machine learning core classes and methods

ClarifyBaseliningJob class

Description

Provides functionality to retrieve baseline-specific output from Clarify baselining job.

Super classes

sagemaker.common::.Job -> sagemaker.common::ProcessingJob -> sagemaker.mlcore::BaseliningJob -> ClarifyBaseliningJob

Methods

Public methods

• ClarifyBaseliningJob$new()

• ClarifyBaseliningJob$baseline_statistics()

• ClarifyBaseliningJob$suggested_constraints()

• ClarifyBaseliningJob$clone()

Inherited methods

• sagemaker.common::.Job$format()

• sagemaker.common::ProcessingJob$describe()

• sagemaker.common::ProcessingJob$from_processing_arn()

• sagemaker.common::ProcessingJob$from_processing_name()

• sagemaker.common::ProcessingJob$prepare_app_specification()

• sagemaker.common::ProcessingJob$prepare_output_config()

• sagemaker.common::ProcessingJob$prepare_processing_resources()

• sagemaker.common::ProcessingJob$prepare_stopping_condition()

• sagemaker.common::ProcessingJob$start_new()

• sagemaker.common::ProcessingJob$stop()

• sagemaker.common::ProcessingJob$wait()

• sagemaker.mlcore::BaseliningJob$from_processing_job()

---

Method new()

Initializes a ClarifyBaseliningJob that tracks a baselining job by suggest_baseline()

Usage

ClarifyBaseliningJob$new(processing_job)

Arguments

processing_job

(sagemaker.processing.ProcessingJob): The ProcessingJob used for baselining instance.

---

Method baseline_statistics()

Not implemented. The class doesn't support statistics.

Usage

ClarifyBaseliningJob$baseline_statistics()

---

Method suggested_constraints()

Returns a sagemaker.model_monitor. Constraints object representing the constraints JSON file generated by this baselining job.

Usage

ClarifyBaseliningJob$suggested_constraints(file_name = NULL, kms_key = NULL)

Arguments

file_name

(str): Keep this parameter to align with method signature in super class, but it will be ignored.

kms_key

(str): The kms key to use when retrieving the file.

Returns

sagemaker.model_monitor.Constraints: The Constraints object representing the file that was generated by the job.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ClarifyBaseliningJob$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-mlcore documentation built on May 3, 2022, 10:08 a.m.