DatasetFormat: DatasetFormat Class

DatasetFormatR Documentation

DatasetFormat Class

Description

Represents a Dataset Format that is used when calling a DefaultModelMonitor.

Methods

Public methods


Method csv()

Returns a DatasetFormat JSON string for use with a DefaultModelMonitor.

Usage
DatasetFormat$csv(header = TRUE, output_columns_position = c("START", "END"))
Arguments
header

(bool): Whether the csv dataset to baseline and monitor has a header. Default: True.

output_columns_position

(str): The position of the output columns. Must be one of ("START", "END"). Default: "START".

Returns

dict: JSON string containing DatasetFormat to be used by DefaultModelMonitor.


Method json()

Returns a DatasetFormat JSON string for use with a DefaultModelMonitor.

Usage
DatasetFormat$json(lines = TRUE)
Arguments
lines

(bool): Whether the file should be read as a json object per line. Default: True.

Returns

dict: JSON string containing DatasetFormat to be used by DefaultModelMonitor.


Method sagemaker_capture_json()

Returns a DatasetFormat SageMaker Capture Json string for use with a DefaultModelMonitor.

Usage
DatasetFormat$sagemaker_capture_json()
Returns

dict: JSON string containing DatasetFormat to be used by DefaultModelMonitor.


Method format()

format class

Usage
DatasetFormat$format()

Method clone()

The objects of this class are cloneable with this method.

Usage
DatasetFormat$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.