BiasConfig: BiasConfig Class

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

BiasConfig Class

Description

Config object related to bias configurations of the input dataset.

Public fields

analysis_config

Analysis config dictionary

Methods

Public methods

• BiasConfig$new()

• BiasConfig$get_config()

• BiasConfig$format()

• BiasConfig$clone()

---

Method new()

Initializes a configuration of the sensitive groups in the dataset.

Usage

BiasConfig$new(
  label_values_or_threshold,
  facet_name,
  facet_values_or_threshold = NULL,
  group_name = NULL
)

Arguments

label_values_or_threshold

(Any): List of label values or threshold to indicate positive outcome used for bias metrics.

facet_name

(str): Sensitive attribute in the input data for which we like to compare metrics.

facet_values_or_threshold

(list): Optional list of values to form a sensitive group or threshold for a numeric facet column that defines the lower bound of a sensitive group. Defaults to considering each possible value as sensitive group and computing metrics vs all the other examples.

group_name

(str): Optional column name or index to indicate a group column to be used for the bias metric 'Conditional Demographic Disparity in Labels - CDDL' or 'Conditional Demographic Disparity in Predicted Labels - CDDPL'.

---

Method get_config()

Returns part of an analysis config dictionary.

Usage

BiasConfig$get_config()

---

Method format()

format class

Usage

BiasConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

BiasConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.