Constraints: Constraints Class

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

Constraints Class

Description

Represents the constraints JSON file used in Amazon SageMaker Model Monitoring.

Super class

sagemaker.mlcore::ModelMonitoringFile -> Constraints

Methods

Public methods

• Constraints$new()

• Constraints$from_s3_uri()

• Constraints$from_string()

• Constraints$from_file_path()

• Constraints$set_monitoring()

• Constraints$clone()

Inherited methods

• sagemaker.mlcore::ModelMonitoringFile$format()

• sagemaker.mlcore::ModelMonitoringFile$save()

---

Method new()

Initializes the Constraints object used in Amazon SageMaker Model Monitoring.

Usage

Constraints$new(
  body_dict = NULL,
  constraints_file_s3_uri = NULL,
  kms_key = NULL,
  sagemaker_session = NULL
)

Arguments

body_dict

(str): The body of the constraints JSON file.

constraints_file_s3_uri

(str): The uri of the constraints 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 from_s3_uri()

Generates a Constraints object from an s3 uri.

Usage

Constraints$from_s3_uri(
  constraints_file_s3_uri,
  kms_key = NULL,
  sagemaker_session = NULL
)

Arguments

constraints_file_s3_uri

(str): The uri of the constraints 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.

Returns

sagemaker.model_monitor.Constraints: The instance of Constraints generated from the s3 uri.

---

Method from_string()

Generates a Constraints object from an s3 uri.

Usage

Constraints$from_string(
  constraints_file_string,
  kms_key = NULL,
  file_name = NULL,
  sagemaker_session = NULL
)

Arguments

constraints_file_string

(str): The uri of the constraints JSON file.

kms_key

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

file_name

(str): The file name to use when uploading to 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.

Returns

sagemaker.model_monitor.Constraints: The instance of Constraints generated from the s3 uri.

---

Method from_file_path()

Initializes a Constraints object from a file path.

Usage

Constraints$from_file_path(
  constraints_file_path,
  kms_key = NULL,
  sagemaker_session = NULL
)

Arguments

constraints_file_path

(str): The path to the constraints file.

kms_key

(str): The kms_key to use when encrypting 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.

Returns

sagemaker.model_monitor.Constraints: The instance of Constraints generated from the local file path.

---

Method set_monitoring()

Sets the monitoring flags on this Constraints object. If feature-name is provided, modify the feature-level override. Else, modify the top-level monitoring flag.

Usage

Constraints$set_monitoring(enable_monitoring, feature_name = NULL)

Arguments

enable_monitoring

(bool): Whether to enable monitoring or not.

feature_name

(str): Sets the feature-level monitoring flag if provided. Otherwise, sets the file-level override.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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