BaseliningJob: Baselining Job Class

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

Baselining Job Class

Description

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

Super classes

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

Methods

Public methods

• BaseliningJob$new()

• BaseliningJob$from_processing_job()

• BaseliningJob$baseline_statistics()

• BaseliningJob$suggested_constraints()

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

---

Method new()

Initializes a Baselining job that tracks a baselining job kicked off by the suggest workflow.

Usage

BaseliningJob$new(
  sagemaker_session = NULL,
  job_name = NULL,
  inputs = NULL,
  outputs = 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): Name of the Amazon SageMaker Model Monitoring Baselining Job.

inputs

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

outputs

([sagemaker.processing.ProcessingOutput]): A list of ProcessingOutput objects.

output_kms_key

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

---

Method from_processing_job()

Initializes a Baselining job from a processing job.

Usage

BaseliningJob$from_processing_job(processing_job)

Arguments

processing_job

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

Returns

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

---

Method baseline_statistics()

Returns a sagemaker.model_monitor.Statistics object representing the statistics JSON file generated by this baselining job.

Usage

BaseliningJob$baseline_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 job.

---

Method suggested_constraints()

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

Usage

BaseliningJob$suggested_constraints(
  file_name = CONSTRAINTS_JSON_DEFAULT_FILE_NAME,
  kms_key = NULL
)

Arguments

file_name

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

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

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