MonitoringExecution: MonitoringExecution Class

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

MonitoringExecution Class

Description

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

Super classes

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

Methods

Public methods

• MonitoringExecution$new()

• MonitoringExecution$from_processing_arn()

• MonitoringExecution$statistics()

• MonitoringExecution$constraint_violations()

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

---

Method new()

Initializes a MonitoringExecution job that tracks a monitoring execution kicked off by an Amazon SageMaker Model Monitoring Schedule.

Usage

MonitoringExecution$new(
  sagemaker_session = NULL,
  job_name = NULL,
  inputs = NULL,
  output = NULL,
  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 from_processing_arn()

Initializes a Baselining job from a processing arn.

Usage

MonitoringExecution$from_processing_arn(sagemaker_session, processing_job_arn)

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.

processing_job_arn

(str): ARN of the processing job to create a MonitoringExecution out of.

Returns

sagemaker.processing.BaseliningJob: The instance of ProcessingJob created using the current job name.

---

Method statistics()

Returns a sagemaker.model_monitor.Statistics object representing the statistics JSON file generated by this monitoring execution.

Usage

MonitoringExecution$statistics(
  file_name = STATISTICS_JSON_DEFAULT_FILE_NAME,
  kms_key = NULL
)

Arguments

file_name

(str): The name of the json-formatted statistics file

kms_key

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

Returns

sagemaker.model_monitor.Statistics: The Statistics object representing the file that was generated by the execution.

---

Method constraint_violations()

Returns a sagemaker.model_monitor.ConstraintViolations object representing the constraint violations JSON file generated by this monitoring execution.

Usage

MonitoringExecution$constraint_violations(
  file_name = CONSTRAINT_VIOLATIONS_JSON_DEFAULT_FILE_NAME,
  kms_key = NULL
)

Arguments

file_name

(str): The name of the json-formatted constraint violations file.

kms_key

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

Returns

sagemaker.model_monitor.ConstraintViolations: The ConstraintViolations object representing the file that was generated by the monitoring execution.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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