ModelMonitoringFile: ModelMonitoringFile Class

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

ModelMonitoringFile Class

Description

Represents a file with a body and an S3 uri.

Methods

Public methods

• ModelMonitoringFile$new()

• ModelMonitoringFile$save()

• ModelMonitoringFile$format()

• ModelMonitoringFile$clone()

---

Method new()

Initializes a file with a body and an S3 uri.

Usage

ModelMonitoringFile$new(body_dict, file_s3_uri, kms_key, sagemaker_session)

Arguments

body_dict

(str): The body of the JSON file.

file_s3_uri

(str): The uri of the JSON file.

kms_key

(str): The kms key to be used to decrypt the file in S3.

sagemaker_session

(sagemaker.session.Session): A SageMaker Session object, used for SageMaker interactions (default: None). If not specified, one is created using the default AWS configuration chain.

---

Method save()

Save the current instance's body to s3 using the instance's s3 path. The S3 path can be overridden by providing one. This also overrides the default save location for this object.

Usage

ModelMonitoringFile$save(new_save_location_s3_uri = NULL)

Arguments

new_save_location_s3_uri

(str): Optional. The S3 path to save the file to. If not provided, the file is saved in place in S3. If provided, the file's S3 path is permanently updated.

Returns

str: The s3 location to which the file was saved.

---

Method format()

format class

Usage

ModelMonitoringFile$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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