ClarifyBaseliningConfig: ClarifyBaseliningConfig class

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

ClarifyBaseliningConfig class

Description

Data class to hold some essential analysis configuration of ClarifyBaseliningJob

Public fields

analysis_config

analysis config from configurations of the baselining job.

features_attribute

JSONpath to locate features in predictor request payload. Only required when predictor content type is JSONlines.

inference_attribute

Index, header or JSONpath to locate predicted label in predictor response payload

probability_attribute

Index or JSONpath location in the model output for probabilities or scores to be used for explainability.

probability_threshold_attribute

Value to indicate the threshold to select the binary label in the case of binary classification. Default is 0.5.

Methods

Public methods

• ClarifyBaseliningConfig$new()

• ClarifyBaseliningConfig$format()

• ClarifyBaseliningConfig$clone()

---

Method new()

Initialization.

Usage

ClarifyBaseliningConfig$new(
  analysis_config,
  features_attribute = NULL,
  inference_attribute = NULL,
  probability_attribute = NULL,
  probability_threshold_attribute = NULL
)

Arguments

analysis_config

(BiasAnalysisConfig or ExplainabilityAnalysisConfig): analysis config from configurations of the baselining job.

features_attribute

(str): JSONpath to locate features in predictor request payload. Only required when predictor content type is JSONlines.

inference_attribute

(str): Index, header or JSONpath to locate predicted label in predictor response payload.

probability_attribute

(str): Index or JSONpath location in the model output for probabilities or scores to be used for explainability.

probability_threshold_attribute

(float): Value to indicate the threshold to select the binary label in the case of binary classification. Default is 0.5.

---

Method format()

format class

Usage

ClarifyBaseliningConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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