importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=TRUE | FALSE,

where="where-expression",

whereTable={

casLib="string"

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

tableCASLVariable="string",

tableModList={{

CASLVar="string",

table={

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

name="table-name"

onDemand=TRUE | FALSE

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

tableSaveList={{

casout={

caslib="string"

compress=TRUE | FALSE

indexVars={"variable-name-1" <, "variable-name-2", ...>}

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

memoryFormat="DVR" | "INHERIT" | "STANDARD"

name="table-name"

onDemand=TRUE | FALSE

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"

threadBlockSize=64-bit-integer

timeStamp="string"

where={"string-1" <, "string-2", ...>}

key="string"

}, {...}},

tolerance=double,

trainProgram="string",

tuneBound=TRUE | FALSE,

vars={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

weight={

format="string",

formattedLength=integer,

label="string",

length=integer,

name="string",

nfd=integer,

nfl=integer,

weightCASLVariable="string"

;

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	—	specifies the input data table.
tableModList	required parametertable	specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
tableSaveList	required parametercasout	specifies a list of tables to save after running the training program (specified by the trainProgram parameter). Tables are saved only if the bias measurement that you specify in the biasMetric parameter improves in that iteration.

Parameter Descriptions

biasMetric="string"

specifies the type of bias measurement. You can specify four types: 'DEMOGRAPHICPARITY', 'EQUALIZEDODDS', 'EQUALOPPORTUNITY', or 'PREDICTIVEPARITY'.

Default	"PREDICTIVEPARITY"

bound=double

specifies the bound value for the exponentiated gradient reduction algorithm.

Default	100
Minimum value	1

copyVarsCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the copyVars list for scored table creation.

Default	"copyVars"

cutoff=double

specifies the cutoff for the confusion matrix.

Alias	intoCutPt
Default	0.5
Range	(0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias	freq

iterationCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the value of the current exponentiated gradient reduction iteration.

Default	"iteration"

learningRate=double

specifies the step size to use in updating the exponentiated gradient reduction algorithm.

Default	0.01
Range	(0, 1)

logLevel=64-bit-integer

specifies the level of log information to print. Higher levels display more information.

Default	1
Range	0–7

maxIters=64-bit-integer

specifies the maximum number of iterations to run the exponentiated gradient reduction algorithm.

Alias	maxIterations
Default	10
Range	1–50

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default	20
Range	2–100

predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}

specifies the list of variables that contain the model's predictions. The order of the variables must match the order that you specify in the responseLevels parameter. Alternatively, you can pass the list of variables as a return from the training program (specified by the trainProgram parameter) by using the predictedVariablesResultKey parameter.

name="string"

specifies the name for the variable.

predictedVariablesResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the predicted variable names.

Default	"predictedVariables"

* response={casvardesc}

specifies the response (target) variable for supervised learning.

Alias	target

name="string"

specifies the name for the variable.

responseLevels={"string-1" <, "string-2", ...>}

specifies the list of formatted values of the response (target) variable. The order of the variables must match the order that you specify in the predictedVariables parameter. If the event parameter is omitted, the first formatted value is assumed to be the event.

Alias	targetLevels

responseLevelsResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the response (target) variable levels.

Alias	targetLevelsResultKey
Default	"responseLevels"

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias	cutStep
Default	0.05
Range	(0–0.5]

scoredCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the output specification for the scored table.

Default	"casout"

seed=double

specifies the seed for the random number generator. By default, the random number stream is based on the time of day from the computer's clock. A zero or negative seed value also results in random number streams that are based on the time of day from the computer's clock. If you want a reproducible random number sequence between runs, specify a value greater than 0.

Default	0

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default	10
Range	(0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table={castable}

specifies the input data table.

Long form	table={name="table-name"}
Shortcut form	table="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default	TRUE

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains modified input data table information. Training steps that you are mitigating must use this table.

Default	"table"

tableModList={{fairaitools_mitigateBias_tableModList-1} <, {fairaitools_mitigateBias_tableModList-2}, ...>}

specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

The fairaitools_mitigateBias_tableModList value can be one or more of the following:

* CASLVar="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the modified input data table information.

* table={castable}

specifies the input data table.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default	TRUE

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableSaveList={{fairaitools_mitigateBias_tableSaveList-1} <, {fairaitools_mitigateBias_tableSaveList-2}, ...>}

specifies a list of tables to save after running the training program (specified by the trainProgram parameter). Tables are saved only if the bias measurement that you specify in the biasMetric parameter improves in that iteration.

The fairaitools_mitigateBias_tableSaveList value can be one or more of the following:

* casout={casouttable}

specifies where to save the table that is returned by the training program (specified by the trainProgram parameter).

For more information about specifying the casout parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

* key="string"

specifies the name of the response key that is returned by the training program (specified by the trainProgram parameter) that specifies the table to copy.

tolerance=double

specifies the parity constraint violation tolerance. If you set this parameter to 0, the action trains for the maximum number of iterations, which you specify in the maxIters parameter.

Default	0.005
Range	[0–1)

* trainProgram="string"

specifies the CASL training code to train a model. This code is used in conjunction with the values that you specify in the copyVarsCASLVariable, scoredCASLVariable, tableCASLVariable, and weightCASLVariable parameters.

Alias	code

tuneBound=TRUE | FALSE

when set to True, specifies that the bound value must be tuned.

Default	FALSE

vars={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies additional variables to pass to the training program (specified by the trainProgram parameter).

weight={casvardesc}

specifies the variable that contains weight values. Weights that are produced by the exponentiated gradient reduction algorithm are multiplied by these values during training.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

weightCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the name of the weight variable.

Default	"weight"

mitigateBias Action

Mitigate bias during the training of predictive models.

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:fairAITools_mitigateBias{

biasMetric="string",

bound=double,

copyVarsCASLVariable="string",

cutoff=double,

event="string",

frequency={

format="string",

formattedLength=integer,

label="string",

length=integer,

name="string",

nfd=integer,

nfl=integer,

iterationCASLVariable="string",

learningRate=double,

logLevel=64-bit-integer,

maxIters=64-bit-integer,

nBins=64-bit-integer,

predictedVariables={{

name="string"

}, {...}},

predictedVariablesResultKey="string",

response={

name="string"

responseLevels={"string-1" <, "string-2", ...>},

responseLevelsResultKey="string",

rocStep=double,

scoredCASLVariable="string",

seed=double,

selectionDepth=64-bit-integer,

sensitiveVariable={

name="string"

table={

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

name="table-name",

onDemand=true | false,

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

tableCASLVariable="string",

tableModList={{

CASLVar="string",

table={

caslib="string"

computedOnDemand=true | false

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

name="table-name"

onDemand=true | false

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

tableSaveList={{

casout={

caslib="string"

compress=true | false

indexVars={"variable-name-1" <, "variable-name-2", ...>}

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

memoryFormat="DVR" | "INHERIT" | "STANDARD"

name="table-name"

onDemand=true | false

promote=true | false

replace=true | false

replication=integer

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"

threadBlockSize=64-bit-integer

timeStamp="string"

where={"string-1" <, "string-2", ...>}

key="string"

}, {...}},

tolerance=double,

trainProgram="string",

tuneBound=true | false,

vars={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

weight={

format="string",

formattedLength=integer,

label="string",

length=integer,

name="string",

nfd=integer,

nfl=integer,

weightCASLVariable="string"

}

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	—	specifies the input data table.
tableModList	required parametertable	specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
tableSaveList	required parametercasout	specifies a list of tables to save after running the training program (specified by the trainProgram parameter). Tables are saved only if the bias measurement that you specify in the biasMetric parameter improves in that iteration.

Parameter Descriptions

biasMetric="string"

specifies the type of bias measurement. You can specify four types: 'DEMOGRAPHICPARITY', 'EQUALIZEDODDS', 'EQUALOPPORTUNITY', or 'PREDICTIVEPARITY'.

Default	"PREDICTIVEPARITY"

bound=double

specifies the bound value for the exponentiated gradient reduction algorithm.

Default	100
Minimum value	1

copyVarsCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the copyVars list for scored table creation.

Default	"copyVars"

cutoff=double

specifies the cutoff for the confusion matrix.

Alias	intoCutPt
Default	0.5
Range	(0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias	freq

iterationCASLVariable="string"

Default	"iteration"

learningRate=double

specifies the step size to use in updating the exponentiated gradient reduction algorithm.

Default	0.01
Range	(0, 1)

logLevel=64-bit-integer

specifies the level of log information to print. Higher levels display more information.

Default	1
Range	0–7

maxIters=64-bit-integer

specifies the maximum number of iterations to run the exponentiated gradient reduction algorithm.

Alias	maxIterations
Default	10
Range	1–50

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default	20
Range	2–100

predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}

name="string"

specifies the name for the variable.

predictedVariablesResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the predicted variable names.

Default	"predictedVariables"

* response={casvardesc}

specifies the response (target) variable for supervised learning.

Alias	target

name="string"

specifies the name for the variable.

responseLevels={"string-1" <, "string-2", ...>}

Alias	targetLevels

responseLevelsResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the response (target) variable levels.

Alias	targetLevelsResultKey
Default	"responseLevels"

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias	cutStep
Default	0.05
Range	(0–0.5]

scoredCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the output specification for the scored table.

Default	"casout"

seed=double

Default	0

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default	10
Range	(0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table={castable}

specifies the input data table.

Long form	table={name="table-name"}
Shortcut form	table="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	false

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=true | false

This parameter is deprecated.

Default	true

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableCASLVariable="string"

Default	"table"

tableModList={{fairaitools_mitigateBias_tableModList-1} <, {fairaitools_mitigateBias_tableModList-2}, ...>}

specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

The fairaitools_mitigateBias_tableModList value can be one or more of the following:

* CASLVar="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the modified input data table information.

* table={castable}

specifies the input data table.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	false

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=true | false

This parameter is deprecated.

Default	true

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableSaveList={{fairaitools_mitigateBias_tableSaveList-1} <, {fairaitools_mitigateBias_tableSaveList-2}, ...>}

The fairaitools_mitigateBias_tableSaveList value can be one or more of the following:

* casout={casouttable}

specifies where to save the table that is returned by the training program (specified by the trainProgram parameter).

For more information about specifying the casout parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

* key="string"

specifies the name of the response key that is returned by the training program (specified by the trainProgram parameter) that specifies the table to copy.

tolerance=double

specifies the parity constraint violation tolerance. If you set this parameter to 0, the action trains for the maximum number of iterations, which you specify in the maxIters parameter.

Default	0.005
Range	[0–1)

* trainProgram="string"

Alias	code

tuneBound=true | false

when set to True, specifies that the bound value must be tuned.

Default	false

vars={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies additional variables to pass to the training program (specified by the trainProgram parameter).

weight={casvardesc}

specifies the variable that contains weight values. Weights that are produced by the exponentiated gradient reduction algorithm are multiplied by these values during training.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

weightCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the name of the weight variable.

Default	"weight"

mitigateBias Action

Mitigate bias during the training of predictive models.

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.fairAITools.mitigateBias(

biasMetric="string",

bound=double,

copyVarsCASLVariable="string",

cutoff=double,

event="string",

frequency={

"format":"string",

"formattedLength":integer,

"label":"string",

"length":integer,

"name":"string",

"nfd":integer,

"nfl":integer,

iterationCASLVariable="string",

learningRate=double,

logLevel=64-bit-integer,

maxIters=64-bit-integer,

nBins=64-bit-integer,

predictedVariables=[{

"name":"string"

}<, {...}>],

predictedVariablesResultKey="string",

response={

"name":"string"

responseLevels=["string-1" <, "string-2", ...>],

responseLevelsResultKey="string",

rocStep=double,

scoredCASLVariable="string",

seed=double,

selectionDepth=64-bit-integer,

sensitiveVariable={

"name":"string"

table={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

"name":"table-name",

"onDemand":True | False,

"where":"where-expression",

"whereTable":{

"casLib":"string"

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

tableCASLVariable="string",

tableModList=[{

"CASLVar":"string",

"table":{

"caslib":"string"

"computedOnDemand":True | False

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"computedVarsProgram":"string"

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

"name":"table-name"

"onDemand":True | False

"where":"where-expression"

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

}<, {...}>],

tableSaveList=[{

"casout":{

"caslib":"string"

"compress":True | False

"indexVars":["variable-name-1" <, "variable-name-2", ...>]

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

"memoryFormat":"DVR" | "INHERIT" | "STANDARD"

"name":"table-name"

"onDemand":True | False

"promote":True | False

"replace":True | False

"replication":integer

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE"

"threadBlockSize":64-bit-integer

"timeStamp":"string"

"where":["string-1" <, "string-2", ...>]

"key":"string"

}<, {...}>],

tolerance=double,

trainProgram="string",

tuneBound=True | False,

vars={"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

weight={

"format":"string",

"formattedLength":integer,

"label":"string",

"length":integer,

"name":"string",

"nfd":integer,

"nfl":integer,

weightCASLVariable="string"

)

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	—	specifies the input data table.
tableModList	required parametertable	specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
tableSaveList	required parametercasout	specifies a list of tables to save after running the training program (specified by the trainProgram parameter). Tables are saved only if the bias measurement that you specify in the biasMetric parameter improves in that iteration.

Parameter Descriptions

biasMetric="string"

specifies the type of bias measurement. You can specify four types: 'DEMOGRAPHICPARITY', 'EQUALIZEDODDS', 'EQUALOPPORTUNITY', or 'PREDICTIVEPARITY'.

Default	"PREDICTIVEPARITY"

bound=double

specifies the bound value for the exponentiated gradient reduction algorithm.

Default	100
Minimum value	1

copyVarsCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the copyVars list for scored table creation.

Default	"copyVars"

cutoff=double

specifies the cutoff for the confusion matrix.

Alias	intoCutPt
Default	0.5
Range	(0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias	freq

iterationCASLVariable="string"

Default	"iteration"

learningRate=double

specifies the step size to use in updating the exponentiated gradient reduction algorithm.

Default	0.01
Range	(0, 1)

logLevel=64-bit-integer

specifies the level of log information to print. Higher levels display more information.

Default	1
Range	0–7

maxIters=64-bit-integer

specifies the maximum number of iterations to run the exponentiated gradient reduction algorithm.

Alias	maxIterations
Default	10
Range	1–50

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default	20
Range	2–100

predictedVariables=[{casvardesc-1} <, {casvardesc-2}, ...>]

"name":"string"

specifies the name for the variable.

predictedVariablesResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the predicted variable names.

Default	"predictedVariables"

* response={casvardesc}

specifies the response (target) variable for supervised learning.

Alias	target

"name":"string"

specifies the name for the variable.

responseLevels=["string-1" <, "string-2", ...>]

Alias	targetLevels

responseLevelsResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the response (target) variable levels.

Alias	targetLevelsResultKey
Default	"responseLevels"

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias	cutStep
Default	0.05
Range	(0–0.5]

scoredCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the output specification for the scored table.

Default	"casout"

seed=double

Default	0

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default	10
Range	(0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

"name":"string"

specifies the name for the variable.

* table={castable}

specifies the input data table.

Long form	table={"name":"table-name"}
Shortcut form	table="table-name"

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	False

"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

Alias	compVars

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the input table.

"onDemand":True | False

This parameter is deprecated.

Default	True

"where":"where-expression"

specifies an expression for subsetting the input data.

"whereTable":{groupbytable}

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

tableCASLVariable="string"

Default	"table"

tableModList=[{fairaitools_mitigateBias_tableModList-1} <, {fairaitools_mitigateBias_tableModList-2}, ...>]

specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

The fairaitools_mitigateBias_tableModList value can be one or more of the following:

* "CASLVar":"string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the modified input data table information.

* "table":{castable}

specifies the input data table.

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	False

"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

Alias	compVars

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the input table.

"onDemand":True | False

This parameter is deprecated.

Default	True

"where":"where-expression"

specifies an expression for subsetting the input data.

"whereTable":{groupbytable}

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

tableSaveList=[{fairaitools_mitigateBias_tableSaveList-1} <, {fairaitools_mitigateBias_tableSaveList-2}, ...>]

The fairaitools_mitigateBias_tableSaveList value can be one or more of the following:

* "casout":{casouttable}

specifies where to save the table that is returned by the training program (specified by the trainProgram parameter).

For more information about specifying the casout parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

* "key":"string"

specifies the name of the response key that is returned by the training program (specified by the trainProgram parameter) that specifies the table to copy.

tolerance=double

specifies the parity constraint violation tolerance. If you set this parameter to 0, the action trains for the maximum number of iterations, which you specify in the maxIters parameter.

Default	0.005
Range	[0–1)

* trainProgram="string"

Alias	code

tuneBound=True | False

when set to True, specifies that the bound value must be tuned.

Default	False

vars={"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies additional variables to pass to the training program (specified by the trainProgram parameter).

weight={casvardesc}

specifies the variable that contains weight values. Weights that are produced by the exponentiated gradient reduction algorithm are multiplied by these values during training.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

weightCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the name of the weight variable.

Default	"weight"

mitigateBias Action

Mitigate bias during the training of predictive models.

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.fairAITools.mitigateBias(s,

biasMetric="string",

bound=double,

copyVarsCASLVariable="string",

cutoff=double,

event="string",

frequency=list(

format="string",

formattedLength=integer,

label="string",

length=integer,

name="string",

nfd=integer,

nfl=integer,

iterationCASLVariable="string",

learningRate=double,

logLevel=64-bit-integer,

maxIters=64-bit-integer,

nBins=64-bit-integer,

predictedVariables=list( list(

name="string"

) <, list(...)>),

predictedVariablesResultKey="string",

response=list(

name="string"

responseLevels=list("string-1" <, "string-2", ...>),

responseLevelsResultKey="string",

rocStep=double,

scoredCASLVariable="string",

seed=double,

selectionDepth=64-bit-integer,

sensitiveVariable=list(

name="string"

table=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

computedVarsProgram="string",

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),

name="table-name",

onDemand=TRUE | FALSE,

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

tableCASLVariable="string",

tableModList=list( list(

CASLVar="string",

table=list(

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

computedVarsProgram="string"

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

name="table-name"

onDemand=TRUE | FALSE

where="where-expression"

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

) <, list(...)>),

tableSaveList=list( list(

casout=list(

caslib="string"

compress=TRUE | FALSE

indexVars=list("variable-name-1" <, "variable-name-2", ...>)

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

memoryFormat="DVR" | "INHERIT" | "STANDARD"

name="table-name"

onDemand=TRUE | FALSE

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"

threadBlockSize=64-bit-integer

timeStamp="string"

where=list("string-1" <, "string-2", ...>)

key="string"

) <, list(...)>),

tolerance=double,

trainProgram="string",

tuneBound=TRUE | FALSE,

vars=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),

weight=list(

format="string",

formattedLength=integer,

label="string",

length=integer,

name="string",

nfd=integer,

nfl=integer,

weightCASLVariable="string"

)

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	—	specifies the input data table.
tableModList	required parametertable	specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
tableSaveList	required parametercasout	specifies a list of tables to save after running the training program (specified by the trainProgram parameter). Tables are saved only if the bias measurement that you specify in the biasMetric parameter improves in that iteration.

Parameter Descriptions

biasMetric="string"

specifies the type of bias measurement. You can specify four types: 'DEMOGRAPHICPARITY', 'EQUALIZEDODDS', 'EQUALOPPORTUNITY', or 'PREDICTIVEPARITY'.

Default	"PREDICTIVEPARITY"

bound=double

specifies the bound value for the exponentiated gradient reduction algorithm.

Default	100
Minimum value	1

copyVarsCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the copyVars list for scored table creation.

Default	"copyVars"

cutoff=double

specifies the cutoff for the confusion matrix.

Alias	intoCutPt
Default	0.5
Range	(0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency=list(casvardesc)

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias	freq

iterationCASLVariable="string"

Default	"iteration"

learningRate=double

specifies the step size to use in updating the exponentiated gradient reduction algorithm.

Default	0.01
Range	(0, 1)

logLevel=64-bit-integer

specifies the level of log information to print. Higher levels display more information.

Default	1
Range	0–7

maxIters=64-bit-integer

specifies the maximum number of iterations to run the exponentiated gradient reduction algorithm.

Alias	maxIterations
Default	10
Range	1–50

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default	20
Range	2–100

predictedVariables=list( list(casvardesc-1) <, list(casvardesc-2), ...>)

name="string"

specifies the name for the variable.

predictedVariablesResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the predicted variable names.

Default	"predictedVariables"

* response=list(casvardesc)

specifies the response (target) variable for supervised learning.

Alias	target

name="string"

specifies the name for the variable.

responseLevels=list("string-1" <, "string-2", ...>)

Alias	targetLevels

responseLevelsResultKey="string"

specifies the results key that is returned by the training program (specified by the trainProgram parameter) that specifies the response (target) variable levels.

Alias	targetLevelsResultKey
Default	"responseLevels"

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias	cutStep
Default	0.05
Range	(0–0.5]

scoredCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the output specification for the scored table.

Default	"casout"

seed=double

Default	0

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default	10
Range	(0–100]

* sensitiveVariable=list(casvardesc)

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table=list(castable)

specifies the input data table.

Long form	table=list(name="table-name")
Shortcut form	table="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default	TRUE

where="where-expression"

specifies an expression for subsetting the input data.

whereTable=list(groupbytable)

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableCASLVariable="string"

Default	"table"

tableModList=list( list(fairaitools_mitigateBias_tableModList-1) <, list(fairaitools_mitigateBias_tableModList-2), ...>)

specifies a list of tables to modify and pass to the training program (specified by the trainProgram parameter). The table that you specify in the table parameter is appended to this list.

The fairaitools_mitigateBias_tableModList value can be one or more of the following:

* CASLVar="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the modified input data table information.

* table=list(castable)

specifies the input data table.

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default	TRUE

where="where-expression"

specifies an expression for subsetting the input data.

whereTable=list(groupbytable)

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

tableSaveList=list( list(fairaitools_mitigateBias_tableSaveList-1) <, list(fairaitools_mitigateBias_tableSaveList-2), ...>)

The fairaitools_mitigateBias_tableSaveList value can be one or more of the following:

* casout=list(casouttable)

specifies where to save the table that is returned by the training program (specified by the trainProgram parameter).

For more information about specifying the casout parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

* key="string"

specifies the name of the response key that is returned by the training program (specified by the trainProgram parameter) that specifies the table to copy.

tolerance=double

specifies the parity constraint violation tolerance. If you set this parameter to 0, the action trains for the maximum number of iterations, which you specify in the maxIters parameter.

Default	0.005
Range	[0–1)

* trainProgram="string"

Alias	code

tuneBound=TRUE | FALSE

when set to True, specifies that the bound value must be tuned.

Default	FALSE

vars=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies additional variables to pass to the training program (specified by the trainProgram parameter).

weight=list(casvardesc)

specifies the variable that contains weight values. Weights that are produced by the exponentiated gradient reduction algorithm are multiplied by these values during training.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

weightCASLVariable="string"

specifies the name of the CASL variable that is passed to the training program (specified by the trainProgram parameter) that contains the name of the weight variable.

Default	"weight"

Last updated: November 23, 2025