ClarifyMonitoringExecution: ClarifyMonitoringExecution class

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

ClarifyMonitoringExecution class

Description

Provides functionality to retrieve monitoring-specific files output from executions.

Super classes

sagemaker.common::.Job -> sagemaker.common::ProcessingJob -> sagemaker.mlcore::MonitoringExecution -> ClarifyMonitoringExecution

Methods

Public methods

• ClarifyMonitoringExecution$new()

• ClarifyMonitoringExecution$statistics()

• ClarifyMonitoringExecution$clone()

Inherited methods

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

• sagemaker.common::ProcessingJob$describe()

• 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::MonitoringExecution$constraint_violations()

• sagemaker.mlcore::MonitoringExecution$from_processing_arn()

---

Method new()

Initializes an object that tracks a monitoring execution by a Clarify model monitor

Usage

ClarifyMonitoringExecution$new(
  sagemaker_session,
  job_name,
  inputs,
  output,
  output_kms_key = NULL
)

Arguments

sagemaker_session

(sagemaker.session.Session): Session object which manages interactions with Amazon SageMaker APIs and any other AWS services needed. If not specified, one is created using the default AWS configuration chain.

job_name

(str): The name of the monitoring execution job.

inputs

(list[:class:'~sagemaker.processing.ProcessingInput']): A list of :class:'~sagemaker.processing.ProcessingInput' objects.

output

(sagemaker.Processing.ProcessingOutput): The output associated with the monitoring execution.

output_kms_key

(str): The output kms key associated with the job. Defaults to None if not provided.

---

Method statistics()

Not implemented. The class doesn't support statistics.

Usage

ClarifyMonitoringExecution$statistics()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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