DataCaptureConfig: DataCaptureConfig Class

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

DataCaptureConfig Class

Description

Configuration object passed in when deploying models to Amazon SageMaker Endpoints. This object specifies configuration related to endpoint data capture for use with Amazon SageMaker Model Monitoring.

Public fields

enable_capture

Whether data capture should be enabled or not.

sampling_percentage

The percentage of data to sample.

destination_s3_uri

Defaults to "s3://<default-session-bucket>/model-monitor/data-capture"

kms_key_id

The kms key to use when writing to S3.

capture_options

Denotes which data to capture between request and response.

csv_content_types

Default=["text/csv"].

json_content_types

Default=["application/json"].

sagemaker_session

A SageMaker Session object

API_MAPPING

Convert to API values or pass value directly through if unable to convert

Methods

Public methods

• DataCaptureConfig$new()

• DataCaptureConfig$to_request_list()

• DataCaptureConfig$format()

• DataCaptureConfig$clone()

---

Method new()

Initialize a DataCaptureConfig object for capturing data from Amazon SageMaker Endpoints.

Usage

DataCaptureConfig$new(
  enable_capture = TRUE,
  sampling_percentage = 20L,
  destination_s3_uri = NULL,
  kms_key_id = NULL,
  capture_options = NULL,
  csv_content_types = NULL,
  json_content_types = NULL,
  sagemaker_session = NULL
)

Arguments

enable_capture

(bool): Required. Whether data capture should be enabled or not.

sampling_percentage

(int): Optional. Default=20. The percentage of data to sample. Must be between 0 and 100.

destination_s3_uri

(str): Optional. Defaults to "s3://<default-session-bucket>/ model-monitor/data-capture".

kms_key_id

(str): Optional. Default=None. The kms key to use when writing to S3.

capture_options

([str]): Optional. Must be a list containing any combination of the following values: "REQUEST", "RESPONSE". Default=["REQUEST", "RESPONSE"]. Denotes which data to capture between request and response.

csv_content_types

([str]): Optional. Default=["text/csv"].

json_content_types

([str]): Optional. Default=["application/json"].

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 to_request_list()

Generates a request named list using the parameters provided to the class.

Usage

DataCaptureConfig$to_request_list()

---

Method format()

format class

Usage

DataCaptureConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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