EndpointInput: Accepts parameters that specify an endpoint input for...

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

Accepts parameters that specify an endpoint input for monitoring execution.

Description

It also provides a method to turn those parameters into a dictionary.

Methods

Public methods

• EndpointInput$new()

• EndpointInput$to_request_list()

• EndpointInput$format()

• EndpointInput$clone()

---

Method new()

Initialize an “EndpointInput“ instance. EndpointInput accepts parameters that specify an endpoint input for a monitoring job and provides a method to turn those parameters into a dictionary.

Usage

EndpointInput$new(
  endpoint_name,
  destination,
  s3_input_mode = c("File", "Pipe"),
  s3_data_distribution_type = c("FullyReplicated", "ShardedByS3Key"),
  start_time_offset = NULL,
  end_time_offset = NULL,
  features_attribute = NULL,
  inference_attribute = NULL,
  probability_attribute = NULL,
  probability_threshold_attribute = NULL
)

Arguments

endpoint_name

(str): The name of the endpoint.

destination

(str): The destination of the input.

s3_input_mode

(str): The S3 input mode. Can be one of: "File", "Pipe. Default: "File".

s3_data_distribution_type

(str): The S3 Data Distribution Type. Can be one of: "FullyReplicated", "ShardedByS3Key"

start_time_offset

(str): Monitoring start time offset, e.g. "-PT1H"

end_time_offset

(str): Monitoring end time offset, e.g. "-PT0H".

features_attribute

(str): JSONpath to locate features in JSONlines dataset. Only used for ModelBiasMonitor and ModelExplainabilityMonitor

inference_attribute

(str): Index or JSONpath to locate predicted label(s). Only used for ModelQualityMonitor, ModelBiasMonitor, and ModelExplainabilityMonitor

probability_attribute

(str or int): Index or JSONpath to locate probabilities. Only used for ModelQualityMonitor, ModelBiasMonitor and ModelExplainabilityMonitor

probability_threshold_attribute

(float): threshold to convert probabilities to binaries Only used for ModelQualityMonitor, ModelBiasMonitor and ModelExplainabilityMonitor

---

Method to_request_list()

Generates a request dictionary using the parameters provided to the class.

Usage

EndpointInput$to_request_list()

---

Method format()

format class

Usage

EndpointInput$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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