Explain Model Action Set

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

nominals={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

outputTables={

includeAll=TRUE | FALSE,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=TRUE | FALSE,

replace=TRUE | FALSE

predictedTarget="string",

query={

caslib="string",

computedOnDemand=TRUE | FALSE,

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",

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

seed=double,

table={

caslib="string",

computedOnDemand=TRUE | FALSE,

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",

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

weight="variable-name"

;

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
modelTable	—	specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
modelTables	—	specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
required parameterquery	—	specifies the query input data table, which contains the query observation.
required parametertable	—	specifies the input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
generatedOut	—	specifies the output table to contain the generated data that are created during the explanation process.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

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

specifies the ID variables that were used in the creation of the analytic store model. This parameter applies only when an analytic store model is used as the model table.

Aliases	id
	copyVars
	copyVar

binWidth=double

specifies the bin width (relative to the standard deviation) to use to create the binary encoding for interval variables.

Default	0.1
Minimum value	1E-06

code="string"

specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.

Alias	codeString

dataGeneration={dataGenOptions}

specifies the method and options to use for data generation.

Long form	dataGeneration={method="NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"}
Shortcut form	dataGeneration="NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"

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

binaryEncoding="ALL" | "NOMINALS" | "NONE"

specifies what types of variables to map to a binary encoding. The default is ALL if the value of the preset parameter is KERNELSHAP. Otherwise the default is NONE.

Default	NONE

ALL

maps all variables to a binary encoding.

NOMINALS

maps only nominal variables to a binary encoding.

NONE

maps no variables to a binary encoding.

method="NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION"

specifies the method of data generation. The default is NONE if the value of the preset parameter is GLOBALREG. The default is REFERENCEDISTRIBUTION if the value of the preset parameter is KERNELSHAP. The default is QUERYCENTERED if the value of the preset parameter is LIME.

NONE

does not generate data and uses the input data table.

QUERYCENTERED

generates data that are centered around the query that is specified in the query parameter.

REFERENCEDISTRIBUTION

generates data that have variable values from the variable distributions of the input data table.

sampleSize=64-bit-integer

specifies the number of observations to generate. The default is the minimum of 500 times the number of variables that are listed in the input parameter and 1,000,000.

Minimum value	2

display={displayTables}

specifies a list of results tables to send to the client for display.

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

distance={distanceOptions}

specifies the options to use for distance calculation between the observations and the query.

Long form	distance={measure="EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"}
Shortcut form	distance="EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"

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

exponentialKernel=double

specifies the denominator in the exponential kernel when the value of the measure parameter is EUCLIDEAN or NORMEUCLIDEAN.

Minimum value	1E-06

impute="MEAN" | "NONE" | "WEIGHTEDMEAN"

specifies how to impute missing values.

Default	NONE

MEAN

imputes missing values of interval variables by using the mean, and imputes missing values of nominal variables by using the mode.

NONE

does not impute missing values.

WEIGHTEDMEAN

imputes missing values of interval variables by using the weighted mean, and imputes missing values of nominal variables by using the mode.

measure="EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM"

specifies the method of distance calculation. The default is UNIFORM if the value of the preset parameter is GLOBALREG. The default is SHAPKERNEL if the value of the preset parameter is KERNELSHAP. The default is NORMEUCLIDEAN if the value of the preset parameter is LIME.

EUCLIDEAN

uses the Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

NORMEUCLIDEAN

uses the normalized Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

SHAPKERNEL

uses the Shapley kernel weighting of distance to calculate the weights for the weighted regression.

UNIFORM

uses equal weights for all observations, resulting in an unweighted regression.

mixedDistanceWeight=double

specifies the distance calculation weighting that balances interval and nominal inputs. The default is a function based upon the input data, described in the details. The default is 1 if the value of the measure parameter is NORMEUCLIDEAN.

Minimum value	1E-06

explainer={explainerOptions}

specifies the explainer type and options to use.

Long form	explainer={method="LASSOREGRESSION" \| "REGRESSION"}
Shortcut form	explainer="LASSOREGRESSION" \| "REGRESSION"

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

maxEffects=integer

specifies the maximum number of effects that the lasso regression can select.

Minimum value	1

method="LASSOREGRESSION" | "REGRESSION"

specifies the method to use to explain the input model. The default is LASSOREGRESSION if the value of the preset parameter is LIME. The default is REGRESSION otherwise.

LASSOREGRESSION

uses a linear regression with lasso penalty as the linear explainer.

REGRESSION

uses a linear regression without penalty as the linear explainer.

minEffects=integer

specifies the minimum number of effects that the lasso regression can select.

Minimum value	0

standardizeEstimates="INTERVALS" | "NONE"

specifies which variables should have their parameter estimates standardized.

Default	NONE

INTERVALS

specifies that all interval variables that are not encoded using the binaryEncoding parameter have their parameter estimates standardized.

NONE

specifies that no variables have their parameter estimates standardized.

freq="variable-name"

names the numeric variable that contains the frequency of occurrence of each observation.

generatedOut={casouttable}

specifies the output table to contain the generated data that are created during the explanation process.

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

includeMissing=TRUE | FALSE

when set to True, treats missing values of nominal variables as a valid level.

Default	FALSE

* inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the model input variables to use in the analysis.

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

Alias	input

logLevel=integer

specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.

Default	1
Range	0–2

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.

Long form	modelTable={name="table-name"}
Shortcut form	modelTable="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.

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

* name="table-name"

specifies the name of the input table.

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.

modelTables={{castable-1} <, {castable-2}, ...>}

specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.

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.

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

* name="table-name"

specifies the name of the input table.

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.

modelTableType="ASTORE" | "DATASTEP"

specifies the type of scoring that the model table contains.

Default	ASTORE

ASTORE

specifies that the model table contains an analytic store.

DATASTEP

specifies that the model table contains DATA step score code that describes the model.

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

specifies the nominal model input variables to use in the analysis.

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

Alias	nominal

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

Alias	displayOut

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

includeAll=TRUE | FALSE

when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.

Default	FALSE

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}

specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.

The casouttable value is specified as follows:

caslib="string"

specifies the name of the caslib for the output table.

compress=TRUE | FALSE

when set to True, applies data compression to the table.

Default	FALSE

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

specifies the list of variables to create indexes for in the output data.

label="string"

specifies the descriptive label to associate with the table.

lifetime=64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

maxMemSize=64-bit-integer

specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

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

specifies the memory format for the output table.

Default	INHERIT

name="table-name"

specifies the name for the output table.

promote=TRUE | FALSE

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	FALSE

replace=TRUE | FALSE

when set to True, overwrites an existing table that has the same name.

Default	FALSE

replication=integer

specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.

Default	1
Minimum value	0

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

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

threadBlockSize=64-bit-integer

specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

timeStamp="string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

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

specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.

repeated=TRUE | FALSE

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	FALSE

replace=TRUE | FALSE

when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.

Default	TRUE

* predictedTarget="string"

specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.

preset="GLOBALREG" | "KERNELSHAP" | "LIME"

defines default values for the binaryEncoding subparameter of the dataGeneration parameter, the method subparameter of the dataGeneration parameter, the measure subparameter of the distance parameter, and the method subparameter of the explainer parameter.

Default	LIME

GLOBALREG

sets the default value of the binaryEncoding subparameter of the dataGeneration parameter to NONE, the default value of the method subparameter of the dataGeneration parameter to NONE, the default value of the measure subparameter of the distance parameter to UNIFORM, and the default value of the method subparameter of the explainer parameter to REGRESSION.

KERNELSHAP

sets the default value of the binaryEncoding subparameter of the dataGeneration parameter to ALL, the default value of the method subparameter of the dataGeneration parameter to REFERENCEDISTRIBUTION, the default value of the measure subparameter of the distance parameter to SHAPKERNEL, and the default value of the method subparameter of the explainer parameter to REGRESSION.

LIME

sets the default value of the binaryEncoding subparameter of the dataGeneration parameter to NONE, the default value of the method subparameter of the dataGeneration parameter to QUERYCENTERED, the default value of the measure subparameter of the distance parameter to NORMEUCLIDEAN, and the default value of the method subparameter of the explainer parameter to LASSOREGRESSION.

* query={castable}

specifies the query input data table, which contains the query observation.

Long form	query={name="table-name"}
Shortcut form	query="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.

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	FALSE

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

specifies the variables to use in the action.

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

seed=double

specifies the seed value for random number generation.

Default	0

* 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.

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	FALSE

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

specifies the variables to use in the action.

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

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

linearExplainer Action

Uses linear models to explain already trained models. Supports global linear surrogates as well as the local methods: LIME and KERNEL SHAP.

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:explainModel_linearExplainer{

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

binWidth=double,

code="string",

dataGeneration={

binaryEncoding="ALL" | "NOMINALS" | "NONE",

method="NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION",

sampleSize=64-bit-integer

display={

caseSensitive=true | false,

exclude=true | false,

excludeAll=true | false,

keyIsPath=true | false,

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

pathType="LABEL" | "NAME",

traceNames=true | false

distance={

exponentialKernel=double,

impute="MEAN" | "NONE" | "WEIGHTEDMEAN",

measure="EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM",

mixedDistanceWeight=double

explainer={

maxEffects=integer,

method="LASSOREGRESSION" | "REGRESSION",

minEffects=integer,

standardizeEstimates="INTERVALS" | "NONE"

freq="variable-name",

generatedOut={

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",

promote=true | false,

replace=true | false,

replication=integer,

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

threadBlockSize=64-bit-integer,

timeStamp="string",

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

includeMissing=true | false,

inputs={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

logLevel=integer,

modelTable={

caslib="string",

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

name="table-name",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

modelTables={{

caslib="string",

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

name="table-name",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

nominals={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

outputTables={

includeAll=true | false,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=true | false,

replace=true | false

predictedTarget="string",

query={

caslib="string",

computedOnDemand=true | false,

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",

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

seed=double,

table={

caslib="string",

computedOnDemand=true | false,

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",

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

weight="variable-name"

}

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
modelTable	—	specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
modelTables	—	specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
required parameterquery	—	specifies the query input data table, which contains the query observation.
required parametertable	—	specifies the input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
generatedOut	—	specifies the output table to contain the generated data that are created during the explanation process.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

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

specifies the ID variables that were used in the creation of the analytic store model. This parameter applies only when an analytic store model is used as the model table.

Aliases	id
	copyVars
	copyVar

binWidth=double

specifies the bin width (relative to the standard deviation) to use to create the binary encoding for interval variables.

Default	0.1
Minimum value	1E-06

code="string"

specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.

Alias	codeString

dataGeneration={dataGenOptions}

specifies the method and options to use for data generation.

Long form	dataGeneration={method="NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"}
Shortcut form	dataGeneration="NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"

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

binaryEncoding="ALL" | "NOMINALS" | "NONE"

specifies what types of variables to map to a binary encoding. The default is ALL if the value of the preset parameter is KERNELSHAP. Otherwise the default is NONE.

Default	NONE

ALL

maps all variables to a binary encoding.

NOMINALS

maps only nominal variables to a binary encoding.

NONE

maps no variables to a binary encoding.

method="NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION"

NONE

does not generate data and uses the input data table.

QUERYCENTERED

generates data that are centered around the query that is specified in the query parameter.

REFERENCEDISTRIBUTION

generates data that have variable values from the variable distributions of the input data table.

sampleSize=64-bit-integer

specifies the number of observations to generate. The default is the minimum of 500 times the number of variables that are listed in the input parameter and 1,000,000.

Minimum value	2

display={displayTables}

specifies a list of results tables to send to the client for display.

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

distance={distanceOptions}

specifies the options to use for distance calculation between the observations and the query.

Long form	distance={measure="EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"}
Shortcut form	distance="EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"

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

exponentialKernel=double

specifies the denominator in the exponential kernel when the value of the measure parameter is EUCLIDEAN or NORMEUCLIDEAN.

Minimum value	1E-06

impute="MEAN" | "NONE" | "WEIGHTEDMEAN"

specifies how to impute missing values.

Default	NONE

MEAN

imputes missing values of interval variables by using the mean, and imputes missing values of nominal variables by using the mode.

NONE

does not impute missing values.

WEIGHTEDMEAN

imputes missing values of interval variables by using the weighted mean, and imputes missing values of nominal variables by using the mode.

measure="EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM"

EUCLIDEAN

uses the Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

NORMEUCLIDEAN

uses the normalized Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

SHAPKERNEL

uses the Shapley kernel weighting of distance to calculate the weights for the weighted regression.

UNIFORM

uses equal weights for all observations, resulting in an unweighted regression.

mixedDistanceWeight=double

Minimum value	1E-06

explainer={explainerOptions}

specifies the explainer type and options to use.

Long form	explainer={method="LASSOREGRESSION" \| "REGRESSION"}
Shortcut form	explainer="LASSOREGRESSION" \| "REGRESSION"

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

maxEffects=integer

specifies the maximum number of effects that the lasso regression can select.

Minimum value	1

method="LASSOREGRESSION" | "REGRESSION"

specifies the method to use to explain the input model. The default is LASSOREGRESSION if the value of the preset parameter is LIME. The default is REGRESSION otherwise.

LASSOREGRESSION

uses a linear regression with lasso penalty as the linear explainer.

REGRESSION

uses a linear regression without penalty as the linear explainer.

minEffects=integer

specifies the minimum number of effects that the lasso regression can select.

Minimum value	0

standardizeEstimates="INTERVALS" | "NONE"

specifies which variables should have their parameter estimates standardized.

Default	NONE

INTERVALS

specifies that all interval variables that are not encoded using the binaryEncoding parameter have their parameter estimates standardized.

NONE

specifies that no variables have their parameter estimates standardized.

freq="variable-name"

names the numeric variable that contains the frequency of occurrence of each observation.

generatedOut={casouttable}

specifies the output table to contain the generated data that are created during the explanation process.

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

includeMissing=true | false

when set to True, treats missing values of nominal variables as a valid level.

Default	false

* inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the model input variables to use in the analysis.

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

Alias	input

logLevel=integer

specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.

Default	1
Range	0–2

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.

Long form	modelTable={name="table-name"}
Shortcut form	modelTable="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.

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

* name="table-name"

specifies the name of the input table.

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.

modelTables={{castable-1} <, {castable-2}, ...>}

specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.

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.

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

* name="table-name"

specifies the name of the input table.

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.

modelTableType="ASTORE" | "DATASTEP"

specifies the type of scoring that the model table contains.

Default	ASTORE

ASTORE

specifies that the model table contains an analytic store.

DATASTEP

specifies that the model table contains DATA step score code that describes the model.

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

specifies the nominal model input variables to use in the analysis.

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

Alias	nominal

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

Alias	displayOut

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

includeAll=true | false

Default	false

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}

The casouttable value is specified as follows:

caslib="string"

specifies the name of the caslib for the output table.

compress=true | false

when set to True, applies data compression to the table.

Default	false

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

specifies the list of variables to create indexes for in the output data.

label="string"

specifies the descriptive label to associate with the table.

lifetime=64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

maxMemSize=64-bit-integer

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

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

specifies the memory format for the output table.

Default	INHERIT

name="table-name"

specifies the name for the output table.

promote=true | false

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	false

replace=true | false

when set to True, overwrites an existing table that has the same name.

Default	false

replication=integer

Default	1
Minimum value	0

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

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

threadBlockSize=64-bit-integer

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

timeStamp="string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

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

repeated=true | false

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	false

replace=true | false

Default	true

* predictedTarget="string"

specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.

preset="GLOBALREG" | "KERNELSHAP" | "LIME"

Default	LIME

GLOBALREG

KERNELSHAP

LIME

sets the default value of the binaryEncoding subparameter of the dataGeneration parameter to NONE, the default value of the method subparameter of the dataGeneration parameter to QUERYCENTERED, the default value of the measure subparameter of the distance parameter to NORMEUCLIDEAN, and the default value of the method subparameter of the explainer parameter to LASSOREGRESSION.

* query={castable}

specifies the query input data table, which contains the query observation.

Long form	query={name="table-name"}
Shortcut form	query="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.

singlePass=true | false

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	false

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

specifies the variables to use in the action.

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

seed=double

specifies the seed value for random number generation.

Default	0

* 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.

singlePass=true | false

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	false

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

specifies the variables to use in the action.

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

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

linearExplainer Action

Uses linear models to explain already trained models. Supports global linear surrogates as well as the local methods: LIME and KERNEL SHAP.

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.explainModel.linearExplainer(

astoreId=["variable-name-1" <, "variable-name-2", ...>],

binWidth=double,

code="string",

dataGeneration={

"binaryEncoding":"ALL" | "NOMINALS" | "NONE",

"method":"NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION",

"sampleSize":64-bit-integer

display={

"caseSensitive":True | False,

"exclude":True | False,

"excludeAll":True | False,

"keyIsPath":True | False,

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

"pathType":"LABEL" | "NAME",

"traceNames":True | False

distance={

"exponentialKernel":double,

"impute":"MEAN" | "NONE" | "WEIGHTEDMEAN",

"measure":"EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM",

"mixedDistanceWeight":double

explainer={

"maxEffects":integer,

"method":"LASSOREGRESSION" | "REGRESSION",

"minEffects":integer,

"standardizeEstimates":"INTERVALS" | "NONE"

freq="variable-name",

generatedOut={

"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",

"promote":True | False,

"replace":True | False,

"replication":integer,

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

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

includeMissing=True | False,

inputs=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

logLevel=integer,

modelTable={

"caslib":"string",

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

"name":"table-name",

"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}

"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"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

modelTables=[{

"caslib":"string",

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

"name":"table-name",

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

}<, {...}>],

nominals=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

outputTables={

"includeAll":True | False,

"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>},

"repeated":True | False,

"replace":True | False

predictedTarget="string",

query={

"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",

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

seed=double,

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",

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

weight="variable-name"

)

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
modelTable	—	specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
modelTables	—	specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
required parameterquery	—	specifies the query input data table, which contains the query observation.
required parametertable	—	specifies the input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
generatedOut	—	specifies the output table to contain the generated data that are created during the explanation process.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

astoreId=["variable-name-1" <, "variable-name-2", ...>]

specifies the ID variables that were used in the creation of the analytic store model. This parameter applies only when an analytic store model is used as the model table.

Aliases	id
	copyVars
	copyVar

binWidth=double

specifies the bin width (relative to the standard deviation) to use to create the binary encoding for interval variables.

Default	0.1
Minimum value	1E-06

code="string"

specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.

Alias	codeString

dataGeneration={dataGenOptions}

specifies the method and options to use for data generation.

Long form	dataGeneration={"method":"NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"}
Shortcut form	dataGeneration="NONE" \| "QUERYCENTERED" \| "REFERENCEDISTRIBUTION"

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

"binaryEncoding":"ALL" | "NOMINALS" | "NONE"

specifies what types of variables to map to a binary encoding. The default is ALL if the value of the preset parameter is KERNELSHAP. Otherwise the default is NONE.

Default	NONE

ALL

maps all variables to a binary encoding.

NOMINALS

maps only nominal variables to a binary encoding.

NONE

maps no variables to a binary encoding.

"method":"NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION"

NONE

does not generate data and uses the input data table.

QUERYCENTERED

generates data that are centered around the query that is specified in the query parameter.

REFERENCEDISTRIBUTION

generates data that have variable values from the variable distributions of the input data table.

"sampleSize":64-bit-integer

specifies the number of observations to generate. The default is the minimum of 500 times the number of variables that are listed in the input parameter and 1,000,000.

Minimum value	2

display={displayTables}

specifies a list of results tables to send to the client for display.

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

distance={distanceOptions}

specifies the options to use for distance calculation between the observations and the query.

Long form	distance={"measure":"EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"}
Shortcut form	distance="EUCLIDEAN" \| "NORMEUCLIDEAN" \| "SHAPKERNEL" \| "UNIFORM"

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

"exponentialKernel":double

specifies the denominator in the exponential kernel when the value of the measure parameter is EUCLIDEAN or NORMEUCLIDEAN.

Minimum value	1E-06

"impute":"MEAN" | "NONE" | "WEIGHTEDMEAN"

specifies how to impute missing values.

Default	NONE

MEAN

imputes missing values of interval variables by using the mean, and imputes missing values of nominal variables by using the mode.

NONE

does not impute missing values.

WEIGHTEDMEAN

imputes missing values of interval variables by using the weighted mean, and imputes missing values of nominal variables by using the mode.

"measure":"EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM"

EUCLIDEAN

uses the Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

NORMEUCLIDEAN

uses the normalized Euclidean distance in the exponential kernel to calculate weights for the weighted regression.

SHAPKERNEL

uses the Shapley kernel weighting of distance to calculate the weights for the weighted regression.

UNIFORM

uses equal weights for all observations, resulting in an unweighted regression.

"mixedDistanceWeight":double

Minimum value	1E-06

explainer={explainerOptions}

specifies the explainer type and options to use.

Long form	explainer={"method":"LASSOREGRESSION" \| "REGRESSION"}
Shortcut form	explainer="LASSOREGRESSION" \| "REGRESSION"

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

"maxEffects":integer

specifies the maximum number of effects that the lasso regression can select.

Minimum value	1

"method":"LASSOREGRESSION" | "REGRESSION"

specifies the method to use to explain the input model. The default is LASSOREGRESSION if the value of the preset parameter is LIME. The default is REGRESSION otherwise.

LASSOREGRESSION

uses a linear regression with lasso penalty as the linear explainer.

REGRESSION

uses a linear regression without penalty as the linear explainer.

"minEffects":integer

specifies the minimum number of effects that the lasso regression can select.

Minimum value	0

"standardizeEstimates":"INTERVALS" | "NONE"

specifies which variables should have their parameter estimates standardized.

Default	NONE

INTERVALS

specifies that all interval variables that are not encoded using the binaryEncoding parameter have their parameter estimates standardized.

NONE

specifies that no variables have their parameter estimates standardized.

freq="variable-name"

names the numeric variable that contains the frequency of occurrence of each observation.

generatedOut={casouttable}

specifies the output table to contain the generated data that are created during the explanation process.

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

includeMissing=True | False

when set to True, treats missing values of nominal variables as a valid level.

Default	False

* inputs=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the model input variables to use in the analysis.

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

Alias	input

logLevel=integer

specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.

Default	1
Range	0–2

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.

Long form	modelTable={"name":"table-name"}
Shortcut form	modelTable="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.

"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

* "name":"table-name"

specifies the name of the input table.

"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.

modelTables=[{castable-1} <, {castable-2}, ...>]

specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.

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.

"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

* "name":"table-name"

specifies the name of the input table.

"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.

modelTableType="ASTORE" | "DATASTEP"

specifies the type of scoring that the model table contains.

Default	ASTORE

ASTORE

specifies that the model table contains an analytic store.

DATASTEP

specifies that the model table contains DATA step score code that describes the model.

nominals=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the nominal model input variables to use in the analysis.

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

Alias	nominal

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

Alias	displayOut

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

"includeAll":True | False

Default	False

"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>}

The casouttable value is specified as follows:

"caslib":"string"

specifies the name of the caslib for the output table.

"compress":True | False

when set to True, applies data compression to the table.

Default	False

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

specifies the list of variables to create indexes for in the output data.

"label":"string"

specifies the descriptive label to associate with the table.

"lifetime":64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

"maxMemSize":64-bit-integer

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

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

specifies the memory format for the output table.

Default	INHERIT

"name":"table-name"

specifies the name for the output table.

"promote":True | False

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	False

"replace":True | False

when set to True, overwrites an existing table that has the same name.

Default	False

"replication":integer

Default	1
Minimum value	0

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

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

"threadBlockSize":64-bit-integer

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"timeStamp":"string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

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

"repeated":True | False

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	False

"replace":True | False

Default	True

* predictedTarget="string"

specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.

preset="GLOBALREG" | "KERNELSHAP" | "LIME"

Default	LIME

GLOBALREG

KERNELSHAP

LIME

sets the default value of the binaryEncoding subparameter of the dataGeneration parameter to NONE, the default value of the method subparameter of the dataGeneration parameter to QUERYCENTERED, the default value of the measure subparameter of the distance parameter to NORMEUCLIDEAN, and the default value of the method subparameter of the explainer parameter to LASSOREGRESSION.

* query={castable}

specifies the query input data table, which contains the query observation.

Long form	query={"name":"table-name"}
Shortcut form	query="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.

"singlePass":True | False

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	False

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

specifies the variables to use in the action.

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

seed=double

specifies the seed value for random number generation.

Default	0

* 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.

"singlePass":True | False

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Default	False

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

specifies the variables to use in the action.

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

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

linearExplainer Action

Uses linear models to explain already trained models. Supports global linear surrogates as well as the local methods: LIME and KERNEL SHAP.

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.explainModel.linearExplainer(s,

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

binWidth=double,

code="string",

dataGeneration=list(

binaryEncoding="ALL" | "NOMINALS" | "NONE",

method="NONE" | "QUERYCENTERED" | "REFERENCEDISTRIBUTION",

sampleSize=64-bit-integer

display=list(

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

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

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

distance=list(

exponentialKernel=double,

impute="MEAN" | "NONE" | "WEIGHTEDMEAN",

measure="EUCLIDEAN" | "NORMEUCLIDEAN" | "SHAPKERNEL" | "UNIFORM",

mixedDistanceWeight=double

explainer=list(

maxEffects=integer,

method="LASSOREGRESSION" | "REGRESSION",

minEffects=integer,

standardizeEstimates="INTERVALS" | "NONE"

freq="variable-name",

generatedOut=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",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

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

threadBlockSize=64-bit-integer,

timeStamp="string",

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

includeMissing=TRUE | FALSE,

inputs=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

logLevel=integer,

modelTable=list(

caslib="string",

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

name="table-name",

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"

)

modelTables=list( list(

caslib="string",

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

name="table-name",

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(...)>),

nominals=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

outputTables=list(

includeAll=TRUE | FALSE,

names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>),

repeated=TRUE | FALSE,

replace=TRUE | FALSE

predictedTarget="string",