ModelMetrics: ModelMetrics class

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

ModelMetrics class

Description

Accepts model metrics parameters for conversion to request dict.

Methods

Public methods

• ModelMetrics$new()

• ModelMetrics$to_request_list()

• ModelMetrics$format()

• ModelMetrics$clone()

---

Method new()

Initialize a “ModelMetrics“ instance and turn parameters into dict.

Usage

ModelMetrics$new(
  model_statistics = NULL,
  model_constraints = NULL,
  model_data_statistics = NULL,
  model_data_constraints = NULL,
  bias = NULL,
  explainability = NULL,
  bias_pre_training = NULL,
  bias_post_training = NULL
)

Arguments

model_statistics

(MetricsSource): A metric source object that represents model statistics (default: None).

model_constraints

(MetricsSource): A metric source object that represents model constraints (default: None).

model_data_statistics

(MetricsSource): A metric source object that represents model data statistics (default: None).

model_data_constraints

(MetricsSource): A metric source object that represents model data constraints (default: None).

bias

(MetricsSource): A metric source object that represents bias report (default: None).

explainability

(MetricsSource): A metric source object that represents explainability report (default: None).

bias_pre_training

(MetricsSource): A metric source object that represents Pre-training report (default: None).

bias_post_training

(MetricsSource): A metric source object that represents Post-training report (default: None).

---

Method to_request_list()

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

Usage

ModelMetrics$to_request_list()

---

Method format()

format class

Usage

ModelMetrics$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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