Neural Network Action Set

Provides actions for training and scoring artificial neural networks

annTrain Action

Trains an artificial neural network.

CASL Syntax
Summary: Input and Output Tables
Parameter Descriptions

CASL Syntax

neuralNet.annTrain <result=results> <status=rc> /

acts={"EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"},

applyRowOrder=TRUE | FALSE,

arch="DIRECT" | "GLIM" | "MLP",

attributes={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

bias=double,

casOut={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

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

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

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

threadBlockSize=64-bit-integer,

timeStamp="string",

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

code={

casOut={

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

comment=TRUE | FALSE,

fmtWdth=integer,

indentSize=integer,

labelId=integer,

lineSize=integer,

noTrim=TRUE | FALSE,

tabForm=TRUE | FALSE

combs={"ADD", "LINEAR", "RADIAL"},

delta=double,

dropOut=double,

dropOutInput=double,

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON",

freq="variable-name",

fullWeights=TRUE | FALSE,

hiddens={64-bit-integer-1 <, 64-bit-integer-2, ...>},

includeBias=TRUE | FALSE,

inputs={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

inversePriors=TRUE | FALSE,

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT",

missing="MAX" | "MEAN" | "MIN" | "NONE",

modelId="string",

modelTable={

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

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

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

name="table-name",

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

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

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

nAnns=64-bit-integer,

nloOpts={

algorithm="ADAM" | "HF" | "LBFGS" | "SGD",

lbfgsOpt={

lineSearchMethod="ARMIJO" | "HYBRID" | "MORETHUENTE" | "STRONGWOLFE" | "WOLFE"

numCorrections=64-bit-integer

optmlOpt={

clipWeightMaxNorm=double

fConv=double

fConvWindow=64-bit-integer

gTol=double

maxEvals=64-bit-integer

maxIters=64-bit-integer

maxTime=double

regL1=double

regL2=double

printOpt={

logLevel=64-bit-integer

printFreq=64-bit-integer

printLevel="PRINTBASIC" | "PRINTDETAIL" | "PRINTNONE"

sgdOpt={

adaptiveDecay=double

adaptiveRate=TRUE | FALSE

annealingRate=double

commFreq=64-bit-integer

learningRate=double

miniBatchSize=64-bit-integer

momentum=double

seed=64-bit-integer

useLocking=TRUE | FALSE

state={

checkpointFreq=64-bit-integer

saveBest=TRUE | FALSE

table={

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

onDemand=TRUE | FALSE

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

}

validate={

frequency=64-bit-integer

goal=double

stagnation=64-bit-integer

threshold=double

thresholdIter=64-bit-integer

}

nominals={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

nTries=64-bit-integer,

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER",

resume=TRUE | FALSE,

samplingRate=double,

saveState={

caslib="string",

label="string",

lifetime=64-bit-integer,

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

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

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

scaleInit=64-bit-integer,

seed=double,

std="MIDRANGE" | "NONE" | "STD",

step=double,

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

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

target="variable-name",

targetComb="ADD" | "LINEAR" | "RADIAL",

targetMissing="MAX" | "MEAN" | "MIN" | "NONE",

targetStd="MIDRANGE" | "NONE" | "STD",

validTable={

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

whereTable={

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 table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.
required parametertable	—	specifies the settings for an input table.
validTable	—	specifies the table with the validation data. Using a validation table enables the early stopping of the iteration process with the nloOpts parameter. The validation table must have the same columns and data types as the training table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—
code	casOut	requests that the action produce SAS score code. Specify additional parameters.
nloOpts	state (and nested parameter table)	specifies the optimization options.
saveState	—	Specifies the table in which to save the model state for future model prediction.

Parameter Descriptions

acts={"EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"}

specifies the activation function for the neurons on each hidden layer.

Alias	act

applyRowOrder=TRUE | FALSE

specifies that you wish that the action uses a prespecified row ordering.

Alias	reproducibleRowOrder
Default	FALSE

arch="DIRECT" | "GLIM" | "MLP"

specifies the network architecture to be trained.

Default	GLIM
DIRECT	specifies to use an architecture that is an extension of MLP with direct connections between the input layer and the output layer.
GLIM	specifies to use the generalized linear model architecture. This uses a two-layer perceptron (one is the input layer and the other is the output layer) without hidden layers or units.
MLP	specifies to use a multilayer perceptron with one or more hidden layers.

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

specifies temporary attributes, such as a format, to apply to input variables.

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

Aliases	attribute
	attrs
	attr
	varAttrs

bias=double

specifies a fixed bias value for all the hidden and output neurons. In this case, the bias parameters are fixed and not optimized.

casOut={casouttable}

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

code={codegen}

requests that the action produce SAS score code. Specify additional parameters.

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

combs={"ADD", "LINEAR", "RADIAL"}

specifies the combination function for the neurons on each hidden layer.

Alias	comb

delta=double

specifies the annealing parameter when performing a simulated annealing (SA) global optimization. Without this value, the step size and the temperature are used to perform a Monte Carlo (MC) global optimization. When you specify a value, the optimization becomes SA where the temperature is scaled by delta*t at every MC step.

dropOut=double

specifies the dropout ratio for the hidden layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

dropOutInput=double

specifies the dropout ratio for the input layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON"

specifies the error function to train the network. If you do not specify this parameter, then the ENTROPY function is used for nominal variables. The NORMAL function is used for interval variables.

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

fullWeights=TRUE | FALSE

Generates the full weight model for LBFGS

Default	FALSE

hiddens={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies the number of hidden neurons for each hidden layer in the feedforward model. For example, hiddens={5, 3} specifies two hidden layers: one with 5 hidden neurons and the other with 3 hidden neurons. When you specify this parameter, the default architecture is multi-layer perceptron (MLP).

Alias	hidden

includeBias=TRUE | FALSE

by default, bias parameters are included for the hidden and output units. When set to False, these parameters are not included.

Default	TRUE

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

specifies the 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

inversePriors=TRUE | FALSE

calculates the weight applied to the prediction error of each nominal target variable as the total number of observations divided by the number of observations whose target class is the same as the current observation.

Default	FALSE

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT"

specifies the nodes to be included in the output table that is generated by the DATA step scoring code. When the autoencoding of input nodes is requested, the default is HIDDEN. This value is particularly useful when autoencoding is applied to reduce the dimension of the input nodes. By reusing the node output values, machine learning algorithms such as neural networks, clustering, decision tree, and forests can use the newly encoded vectors as input.

Default	HIDDEN
ALL	specifies to include all the nodes in the scored output table.
HIDDEN	specifies to include the hidden nodes only.
INPUT	specifies to include the input nodes only.
OUTPUT	specifies to include the output nodes only.

missing="MAX" | "MEAN" | "MIN" | "NONE"

specifies how to impute missing values for the input or target variables. If you do not specify this parameter or the parameter is NONE, then observations with missing values are ignored. For nominal variables, a new category is created for the missing values.

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

modelId="string"

specifies a model ID variable name that is included in the generated DATA step scoring code. By default, this variable name is the target variable name with ANN_ set as the prefix.

modelTable={castable}

specifies the table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.

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

Alias	model

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}

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.

nAnns=64-bit-integer

specifies the number of networks to select out of the specified number of tries. The networks with the smallest errors are selected as a set of optimal networks. When data is scored, the most frequent predicted values among the selected networks are used to make the final predictions. Note that you must specify a value to perform Monte Carlo or simulated annealing optimizations which also use the delta, step, and t parameters (experimental for this release).

Alias	numAnn
Default	0
Minimum value	0

nloOpts={casOptml}

specifies the optimization options.

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

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

specifies the nominal input and target 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

nTries=64-bit-integer

specifies the number of tries when training networks with random initial weights. The network with the smallest error is chosen as the optimal network. Note that you must specify a value to perform Monte Carlo or simulated annealing global optimizations which also use the delta, step, and t parameters.

Alias	numTries
Default	0

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER"

specifies the distributions for randomly generating the initial network connection weights. All the weights are in the range [-1.0, 1.0]. The initial bias values are zero. When XAVIER or MSRA is specified, the scaleinit option will be ignored.

resume=TRUE | FALSE

Resumes a training optimization using weights obtained from previous training. The initial weights for resuming the optimization are read from a temporary table with the modelTable= option. The specified framework for the model must be the same as the previous framework.

Default	FALSE

samplingRate=double

specifies the fraction of the data to use for building a neural network.

Range	(0–1]

saveState={casouttable}

Specifies the table in which to save the model state for future model prediction.

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

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

caslib="string"

specifies the name of the caslib for the output table.

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

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

specifies the memory format for the output table.

Default	INHERIT

DVR

use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.

INHERIT

use the default memory format that is set for the server. By default, the server uses the standard memory format. If an administrator sets the CAS_DEFAULT_MEMORY_FORMAT environment variable to DVR, then the DVR memory format is set as the default for the server.

STANDARD

use the standard memory format.

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

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

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

DEFER

Defer redistribution policy selection to higher-level entity.

NOREDIST

Do not redistribute table data when the number of worker pods changes on a running CAS server.

REBALANCE

Rebalance table data when the number of worker pods changes on a running CAS server.

scaleInit=64-bit-integer

specifies how to scale the initial weights. If you specify 1, then the range is scaled to [-1.0 / sqrt(n), 1.0 / sqrt(n)], where n is the number of units in the previous layer. If you specify 2, then the range is scaled to [-6.0 / sqrt(n + n1), 6.0 / sqrt(n + n1)], where n1 is the number of units in the current layer.

seed=double

specifies the random number seed for generating random numbers to initialize the network weights.

Maximum value	MACINT

std="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

step=double

specifies a step size for perturbations on the network weights when performing Monte Carlo or simulated annealing global optimizations.

t=double

specifies the artificial temperature parameter when performing Monte Carlo or simulated annealing global optimizations.

* table={castable}

specifies the settings for an input 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.

target="variable-name"

specifies the target or response variable for training. If you do not specify a target, then the artificial neural network is trained for autoencoding.

targetAct="EXP" | "IDENTITY" | "LOGISTIC" | "SIN" | "SOFTMAX" | "TANH"

specifies the activation function for the neurons on the output layer. If you do not specify this parameter, then SOFTMAX is used for nominal variables. The IDENTITY function is used for interval variables. If the target variable is not provided, for the purposes of encoding the input nodes, then the SOFTMAX function is used.

targetComb="ADD" | "LINEAR" | "RADIAL"

specifies the combination function for the neurons on the target output nodes.

Default	LINEAR
ADD	adds all the incoming values without using any weights or biases.
LINEAR	uses a linear combination of the incoming values and weights.
RADIAL	uses a radial basis function with equal heights and unequal widths for all units in the layer.

targetMissing="MAX" | "MEAN" | "MIN" | "NONE"

specifies how to impute missing values for the target variable. If you specify NONE for this parameter, then observations with missing target values are ignored. For nominal variables, a new category is created for the missing values.

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

targetStd="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

validTable={castable}

specifies the table with the validation data. Using a validation table enables the early stopping of the iteration process with the nloOpts parameter. The validation table must have the same columns and data types as the training table.

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

specifies a variable to weight the prediction errors (the difference between the output of the network and the target value specified in the input data set) for each observation during training.

annTrain Action

Trains an artificial neural network.

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:neuralNet_annTrain{

acts={"EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"},

applyRowOrder=true | false,

arch="DIRECT" | "GLIM" | "MLP",

attributes={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

bias=double,

casOut={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

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

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

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

threadBlockSize=64-bit-integer,

timeStamp="string",

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

code={

casOut={

caslib="string"

compress=true | false

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=true | false

replace=true | false

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

comment=true | false,

fmtWdth=integer,

indentSize=integer,

labelId=integer,

lineSize=integer,

noTrim=true | false,

tabForm=true | false

combs={"ADD", "LINEAR", "RADIAL"},

delta=double,

dropOut=double,

dropOutInput=double,

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON",

freq="variable-name",

fullWeights=true | false,

hiddens={64-bit-integer-1 <, 64-bit-integer-2, ...>},

includeBias=true | false,

inputs={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

inversePriors=true | false,

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT",

missing="MAX" | "MEAN" | "MIN" | "NONE",

modelId="string",

modelTable={

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

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

nAnns=64-bit-integer,

nloOpts={

algorithm="ADAM" | "HF" | "LBFGS" | "SGD",

lbfgsOpt={

lineSearchMethod="ARMIJO" | "HYBRID" | "MORETHUENTE" | "STRONGWOLFE" | "WOLFE"

numCorrections=64-bit-integer

optmlOpt={

clipWeightMaxNorm=double

fConv=double

fConvWindow=64-bit-integer

gTol=double

maxEvals=64-bit-integer

maxIters=64-bit-integer

maxTime=double

regL1=double

regL2=double

printOpt={

logLevel=64-bit-integer

printFreq=64-bit-integer

printLevel="PRINTBASIC" | "PRINTDETAIL" | "PRINTNONE"

sgdOpt={

adaptiveDecay=double

adaptiveRate=true | false

annealingRate=double

commFreq=64-bit-integer

learningRate=double

miniBatchSize=64-bit-integer

momentum=double

seed=64-bit-integer

useLocking=true | false

state={

checkpointFreq=64-bit-integer

saveBest=true | false

table={

caslib="string"

compress=true | false

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

onDemand=true | false

promote=true | false

replace=true | false

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

}

validate={

frequency=64-bit-integer

goal=double

stagnation=64-bit-integer

threshold=double

thresholdIter=64-bit-integer

}

nominals={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

nTries=64-bit-integer,

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER",

resume=true | false,

samplingRate=double,

saveState={

caslib="string",

label="string",

lifetime=64-bit-integer,

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

name="table-name",

promote=true | false,

replace=true | false,

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

scaleInit=64-bit-integer,

seed=double,

std="MIDRANGE" | "NONE" | "STD",

step=double,

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

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

target="variable-name",

targetComb="ADD" | "LINEAR" | "RADIAL",

targetMissing="MAX" | "MEAN" | "MIN" | "NONE",

targetStd="MIDRANGE" | "NONE" | "STD",

validTable={

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

whereTable={

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 table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.
required parametertable	—	specifies the settings for an input table.
validTable	—	specifies the table with the validation data. Using a validation table enables the early stopping of the iteration process with the nloOpts parameter. The validation table must have the same columns and data types as the training table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—
code	casOut	requests that the action produce SAS score code. Specify additional parameters.
nloOpts	state (and nested parameter table)	specifies the optimization options.
saveState	—	Specifies the table in which to save the model state for future model prediction.

Parameter Descriptions

acts={"EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"}

specifies the activation function for the neurons on each hidden layer.

Alias	act

applyRowOrder=true | false

specifies that you wish that the action uses a prespecified row ordering.

Alias	reproducibleRowOrder
Default	false

arch="DIRECT" | "GLIM" | "MLP"

specifies the network architecture to be trained.

Default	GLIM
DIRECT	specifies to use an architecture that is an extension of MLP with direct connections between the input layer and the output layer.
GLIM	specifies to use the generalized linear model architecture. This uses a two-layer perceptron (one is the input layer and the other is the output layer) without hidden layers or units.
MLP	specifies to use a multilayer perceptron with one or more hidden layers.

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

specifies temporary attributes, such as a format, to apply to input variables.

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

Aliases	attribute
	attrs
	attr
	varAttrs

bias=double

specifies a fixed bias value for all the hidden and output neurons. In this case, the bias parameters are fixed and not optimized.

casOut={casouttable}

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

code={codegen}

requests that the action produce SAS score code. Specify additional parameters.

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

combs={"ADD", "LINEAR", "RADIAL"}

specifies the combination function for the neurons on each hidden layer.

Alias	comb

delta=double

dropOut=double

specifies the dropout ratio for the hidden layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

dropOutInput=double

specifies the dropout ratio for the input layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON"

specifies the error function to train the network. If you do not specify this parameter, then the ENTROPY function is used for nominal variables. The NORMAL function is used for interval variables.

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

fullWeights=true | false

Generates the full weight model for LBFGS

Default	false

hiddens={64-bit-integer-1 <, 64-bit-integer-2, ...>}

Alias	hidden

includeBias=true | false

by default, bias parameters are included for the hidden and output units. When set to False, these parameters are not included.

Default	true

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

specifies the 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

inversePriors=true | false

Default	false

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT"

Default	HIDDEN
ALL	specifies to include all the nodes in the scored output table.
HIDDEN	specifies to include the hidden nodes only.
INPUT	specifies to include the input nodes only.
OUTPUT	specifies to include the output nodes only.

missing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

modelId="string"

specifies a model ID variable name that is included in the generated DATA step scoring code. By default, this variable name is the target variable name with ANN_ set as the prefix.

modelTable={castable}

specifies the table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.

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

Alias	model

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.

nAnns=64-bit-integer

Alias	numAnn
Default	0
Minimum value	0

nloOpts={casOptml}

specifies the optimization options.

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

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

specifies the nominal input and target 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

nTries=64-bit-integer

Alias	numTries
Default	0

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER"

resume=true | false

Default	false

samplingRate=double

specifies the fraction of the data to use for building a neural network.

Range	(0–1]

saveState={casouttable}

Specifies the table in which to save the model state for future model prediction.

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

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

caslib="string"

specifies the name of the caslib for the output table.

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

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

specifies the memory format for the output table.

Default	INHERIT

DVR

use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.

INHERIT

STANDARD

use the standard memory format.

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

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

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

DEFER

Defer redistribution policy selection to higher-level entity.

NOREDIST

Do not redistribute table data when the number of worker pods changes on a running CAS server.

REBALANCE

Rebalance table data when the number of worker pods changes on a running CAS server.

scaleInit=64-bit-integer

seed=double

specifies the random number seed for generating random numbers to initialize the network weights.

Maximum value	MACINT

std="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

step=double

specifies a step size for perturbations on the network weights when performing Monte Carlo or simulated annealing global optimizations.

t=double

specifies the artificial temperature parameter when performing Monte Carlo or simulated annealing global optimizations.

* table={castable}

specifies the settings for an input 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.

target="variable-name"

specifies the target or response variable for training. If you do not specify a target, then the artificial neural network is trained for autoencoding.

targetAct="EXP" | "IDENTITY" | "LOGISTIC" | "SIN" | "SOFTMAX" | "TANH"

targetComb="ADD" | "LINEAR" | "RADIAL"

specifies the combination function for the neurons on the target output nodes.

Default	LINEAR
ADD	adds all the incoming values without using any weights or biases.
LINEAR	uses a linear combination of the incoming values and weights.
RADIAL	uses a radial basis function with equal heights and unequal widths for all units in the layer.

targetMissing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

targetStd="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

validTable={castable}

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

specifies a variable to weight the prediction errors (the difference between the output of the network and the target value specified in the input data set) for each observation during training.

annTrain Action

Trains an artificial neural network.

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.neuralNet.annTrain(

acts=["EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"],

applyRowOrder=True | False,

arch="DIRECT" | "GLIM" | "MLP",

attributes=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

bias=double,

casOut={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

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

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

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

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

code={

"casOut":{

"caslib":"string"

"compress":True | False

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

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

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

"name":"table-name"

"promote":True | False

"replace":True | False

"replication":integer

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

"threadBlockSize":64-bit-integer

"timeStamp":"string"

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

"comment":True | False,

"fmtWdth":integer,

"indentSize":integer,

"labelId":integer,

"lineSize":integer,

"noTrim":True | False,

"tabForm":True | False

combs=["ADD", "LINEAR", "RADIAL"],

delta=double,

dropOut=double,

dropOutInput=double,

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON",

freq="variable-name",

fullWeights=True | False,

hiddens=[64-bit-integer-1 <, 64-bit-integer-2, ...>],

includeBias=True | False,

inputs=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

inversePriors=True | False,

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT",

missing="MAX" | "MEAN" | "MIN" | "NONE",

modelId="string",

modelTable={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

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

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

"name":"table-name",

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable":{

"casLib":"string"

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

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

nAnns=64-bit-integer,

nloOpts={

"algorithm":"ADAM" | "HF" | "LBFGS" | "SGD",

"lbfgsOpt":{

"lineSearchMethod":"ARMIJO" | "HYBRID" | "MORETHUENTE" | "STRONGWOLFE" | "WOLFE"

"numCorrections":64-bit-integer

"optmlOpt":{

"clipWeightMaxNorm":double

"fConv":double

"fConvWindow":64-bit-integer

"gTol":double

"maxEvals":64-bit-integer

"maxIters":64-bit-integer

"maxTime":double

"regL1":double

"regL2":double

"printOpt":{

"logLevel":64-bit-integer

"printFreq":64-bit-integer

"printLevel":"PRINTBASIC" | "PRINTDETAIL" | "PRINTNONE"

"sgdOpt":{

"adaptiveDecay":double

"adaptiveRate":True | False

"annealingRate":double

"commFreq":64-bit-integer

"learningRate":double

"miniBatchSize":64-bit-integer

"momentum":double

"seed":64-bit-integer

"useLocking":True | False

"state":{

"checkpointFreq":64-bit-integer

"saveBest":True | False

"table":{

"caslib":"string"

"compress":True | False

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

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

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

"name":"table-name"

"onDemand":True | False

"promote":True | False

"replace":True | False

"replication":integer

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

"threadBlockSize":64-bit-integer

"timeStamp":"string"

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

}

"validate":{

"frequency":64-bit-integer

"goal":double

"stagnation":64-bit-integer

"threshold":double

"thresholdIter":64-bit-integer

}

nominals=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

nTries=64-bit-integer,

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER",

resume=True | False,

samplingRate=double,

saveState={

"caslib":"string",

"label":"string",

"lifetime":64-bit-integer,

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

"name":"table-name",

"promote":True | False,

"replace":True | False,

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

scaleInit=64-bit-integer,

seed=double,

std="MIDRANGE" | "NONE" | "STD",

step=double,

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

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

target="variable-name",

targetComb="ADD" | "LINEAR" | "RADIAL",

targetMissing="MAX" | "MEAN" | "MIN" | "NONE",

targetStd="MIDRANGE" | "NONE" | "STD",

validTable={

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

"whereTable":{

"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 table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.
required parametertable	—	specifies the settings for an input table.
validTable	—	specifies the table with the validation data. Using a validation table enables the early stopping of the iteration process with the nloOpts parameter. The validation table must have the same columns and data types as the training table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—
code	casOut	requests that the action produce SAS score code. Specify additional parameters.
nloOpts	state (and nested parameter table)	specifies the optimization options.
saveState	—	Specifies the table in which to save the model state for future model prediction.

Parameter Descriptions

acts=["EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"]

specifies the activation function for the neurons on each hidden layer.

Alias	act

applyRowOrder=True | False

specifies that you wish that the action uses a prespecified row ordering.

Alias	reproducibleRowOrder
Default	False

arch="DIRECT" | "GLIM" | "MLP"

specifies the network architecture to be trained.

Default	GLIM
DIRECT	specifies to use an architecture that is an extension of MLP with direct connections between the input layer and the output layer.
GLIM	specifies to use the generalized linear model architecture. This uses a two-layer perceptron (one is the input layer and the other is the output layer) without hidden layers or units.
MLP	specifies to use a multilayer perceptron with one or more hidden layers.

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

specifies temporary attributes, such as a format, to apply to input variables.

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

Aliases	attribute
	attrs
	attr
	varAttrs

bias=double

specifies a fixed bias value for all the hidden and output neurons. In this case, the bias parameters are fixed and not optimized.

casOut={casouttable}

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

code={codegen}

requests that the action produce SAS score code. Specify additional parameters.

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

combs=["ADD", "LINEAR", "RADIAL"]

specifies the combination function for the neurons on each hidden layer.

Alias	comb

delta=double

dropOut=double

specifies the dropout ratio for the hidden layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

dropOutInput=double

specifies the dropout ratio for the input layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON"

specifies the error function to train the network. If you do not specify this parameter, then the ENTROPY function is used for nominal variables. The NORMAL function is used for interval variables.

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

fullWeights=True | False

Generates the full weight model for LBFGS

Default	False

hiddens=[64-bit-integer-1 <, 64-bit-integer-2, ...>]

Alias	hidden

includeBias=True | False

by default, bias parameters are included for the hidden and output units. When set to False, these parameters are not included.

Default	True

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

specifies the 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

inversePriors=True | False

Default	False

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT"

Default	HIDDEN
ALL	specifies to include all the nodes in the scored output table.
HIDDEN	specifies to include the hidden nodes only.
INPUT	specifies to include the input nodes only.
OUTPUT	specifies to include the output nodes only.

missing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

modelId="string"

specifies a model ID variable name that is included in the generated DATA step scoring code. By default, this variable name is the target variable name with ANN_ set as the prefix.

modelTable={castable}

specifies the table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.

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

Alias	model

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.

nAnns=64-bit-integer

Alias	numAnn
Default	0
Minimum value	0

nloOpts={casOptml}

specifies the optimization options.

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

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

specifies the nominal input and target 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

nTries=64-bit-integer

Alias	numTries
Default	0

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER"

resume=True | False

Default	False

samplingRate=double

specifies the fraction of the data to use for building a neural network.

Range	(0–1]

saveState={casouttable}

Specifies the table in which to save the model state for future model prediction.

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

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

"caslib":"string"

specifies the name of the caslib for the output table.

"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

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

specifies the memory format for the output table.

Default	INHERIT

DVR

use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.

INHERIT

STANDARD

use the standard memory format.

"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

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

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

DEFER

Defer redistribution policy selection to higher-level entity.

NOREDIST

Do not redistribute table data when the number of worker pods changes on a running CAS server.

REBALANCE

Rebalance table data when the number of worker pods changes on a running CAS server.

scaleInit=64-bit-integer

seed=double

specifies the random number seed for generating random numbers to initialize the network weights.

Maximum value	MACINT

std="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

step=double

specifies a step size for perturbations on the network weights when performing Monte Carlo or simulated annealing global optimizations.

t=double

specifies the artificial temperature parameter when performing Monte Carlo or simulated annealing global optimizations.

* table={castable}

specifies the settings for an input 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.

target="variable-name"

specifies the target or response variable for training. If you do not specify a target, then the artificial neural network is trained for autoencoding.

targetAct="EXP" | "IDENTITY" | "LOGISTIC" | "SIN" | "SOFTMAX" | "TANH"

targetComb="ADD" | "LINEAR" | "RADIAL"

specifies the combination function for the neurons on the target output nodes.

Default	LINEAR
ADD	adds all the incoming values without using any weights or biases.
LINEAR	uses a linear combination of the incoming values and weights.
RADIAL	uses a radial basis function with equal heights and unequal widths for all units in the layer.

targetMissing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

targetStd="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

validTable={castable}

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

specifies a variable to weight the prediction errors (the difference between the output of the network and the target value specified in the input data set) for each observation during training.

annTrain Action

Trains an artificial neural network.

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.neuralNet.annTrain(s,

acts=list("EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH"),

applyRowOrder=TRUE | FALSE,

arch="DIRECT" | "GLIM" | "MLP",

attributes=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

bias=double,

casOut=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

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

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

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

threadBlockSize=64-bit-integer,

timeStamp="string",

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

code=list(

casOut=list(

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

comment=TRUE | FALSE,

fmtWdth=integer,

indentSize=integer,

labelId=integer,

lineSize=integer,

noTrim=TRUE | FALSE,

tabForm=TRUE | FALSE

combs=list("ADD", "LINEAR", "RADIAL"),

delta=double,

dropOut=double,

dropOutInput=double,

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON",

freq="variable-name",

fullWeights=TRUE | FALSE,

hiddens=list(64-bit-integer-1 <, 64-bit-integer-2, ...>),

includeBias=TRUE | FALSE,

inputs=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

inversePriors=TRUE | FALSE,

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT",

missing="MAX" | "MEAN" | "MIN" | "NONE",

modelId="string",

modelTable=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

computedVarsProgram="string",

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

name="table-name",

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

nAnns=64-bit-integer,

nloOpts=list(

algorithm="ADAM" | "HF" | "LBFGS" | "SGD",

lbfgsOpt=list(

lineSearchMethod="ARMIJO" | "HYBRID" | "MORETHUENTE" | "STRONGWOLFE" | "WOLFE"

numCorrections=64-bit-integer

optmlOpt=list(

clipWeightMaxNorm=double

fConv=double

fConvWindow=64-bit-integer

gTol=double

maxEvals=64-bit-integer

maxIters=64-bit-integer

maxTime=double

regL1=double

regL2=double

printOpt=list(

logLevel=64-bit-integer

printFreq=64-bit-integer

printLevel="PRINTBASIC" | "PRINTDETAIL" | "PRINTNONE"

sgdOpt=list(

adaptiveDecay=double

adaptiveRate=TRUE | FALSE

annealingRate=double

commFreq=64-bit-integer

learningRate=double

miniBatchSize=64-bit-integer

momentum=double

seed=64-bit-integer

useLocking=TRUE | FALSE

state=list(

checkpointFreq=64-bit-integer

saveBest=TRUE | FALSE

table=list(

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

onDemand=TRUE | FALSE

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

)

validate=list(

frequency=64-bit-integer

goal=double

stagnation=64-bit-integer

threshold=double

thresholdIter=64-bit-integer

)

nominals=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

nTries=64-bit-integer,

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER",

resume=TRUE | FALSE,

samplingRate=double,

saveState=list(

caslib="string",

label="string",

lifetime=64-bit-integer,

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

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

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

scaleInit=64-bit-integer,

seed=double,

std="MIDRANGE" | "NONE" | "STD",

step=double,

t=double,

table=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

computedVarsProgram="string",

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

name="table-name",

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

target="variable-name",

targetComb="ADD" | "LINEAR" | "RADIAL",

targetMissing="MAX" | "MEAN" | "MIN" | "NONE",

targetStd="MIDRANGE" | "NONE" | "STD",

validTable=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

computedVarsProgram="string",

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

name="table-name",

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

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 table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.
required parametertable	—	specifies the settings for an input table.
validTable	—	specifies the table with the validation data. Using a validation table enables the early stopping of the iteration process with the nloOpts parameter. The validation table must have the same columns and data types as the training table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—
code	casOut	requests that the action produce SAS score code. Specify additional parameters.
nloOpts	state (and nested parameter table)	specifies the optimization options.
saveState	—	Specifies the table in which to save the model state for future model prediction.

Parameter Descriptions

acts=list("EXP", "IDENTITY", "LOGISTIC", "RECTIFIER", "SIN", "SOFTPLUS", "TANH")

specifies the activation function for the neurons on each hidden layer.

Alias	act

applyRowOrder=TRUE | FALSE

specifies that you wish that the action uses a prespecified row ordering.

Alias	reproducibleRowOrder
Default	FALSE

arch="DIRECT" | "GLIM" | "MLP"

specifies the network architecture to be trained.

Default	GLIM
DIRECT	specifies to use an architecture that is an extension of MLP with direct connections between the input layer and the output layer.
GLIM	specifies to use the generalized linear model architecture. This uses a two-layer perceptron (one is the input layer and the other is the output layer) without hidden layers or units.
MLP	specifies to use a multilayer perceptron with one or more hidden layers.

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

specifies temporary attributes, such as a format, to apply to input variables.

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

Aliases	attribute
	attrs
	attr
	varAttrs

bias=double

specifies a fixed bias value for all the hidden and output neurons. In this case, the bias parameters are fixed and not optimized.

casOut=list(casouttable)

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

code=list(codegen)

requests that the action produce SAS score code. Specify additional parameters.

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

combs=list("ADD", "LINEAR", "RADIAL")

specifies the combination function for the neurons on each hidden layer.

Alias	comb

delta=double

dropOut=double

specifies the dropout ratio for the hidden layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

dropOutInput=double

specifies the dropout ratio for the input layers. This parameter is valid when SGD is used for network layer optimization only and all the connections use the linear combination function.

Range	[0–1)

errorFunc="ENTROPY" | "GAMMA" | "NORMAL" | "POISSON"

specifies the error function to train the network. If you do not specify this parameter, then the ENTROPY function is used for nominal variables. The NORMAL function is used for interval variables.

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

fullWeights=TRUE | FALSE

Generates the full weight model for LBFGS

Default	FALSE

hiddens=list(64-bit-integer-1 <, 64-bit-integer-2, ...>)

Alias	hidden

includeBias=TRUE | FALSE

by default, bias parameters are included for the hidden and output units. When set to False, these parameters are not included.

Default	TRUE

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

specifies the 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

inversePriors=TRUE | FALSE

Default	FALSE

listNode="ALL" | "HIDDEN" | "INPUT" | "OUTPUT"

Default	HIDDEN
ALL	specifies to include all the nodes in the scored output table.
HIDDEN	specifies to include the hidden nodes only.
INPUT	specifies to include the input nodes only.
OUTPUT	specifies to include the output nodes only.

missing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

modelId="string"

specifies a model ID variable name that is included in the generated DATA step scoring code. By default, this variable name is the target variable name with ANN_ set as the prefix.

modelTable=list(castable)

specifies the table that contains the artificial neural network model. The weights in this table are loaded to initialize the neural network.

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

Alias	model

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

caslib="string"

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

computedOnDemand=TRUE | FALSE

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

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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=list( list(casinvardesc-1) <, list(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=list(groupbytable)

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

casLib="string"

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

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

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

nAnns=64-bit-integer

Alias	numAnn
Default	0
Minimum value	0

nloOpts=list(casOptml)

specifies the optimization options.

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

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

specifies the nominal input and target 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

nTries=64-bit-integer

Alias	numTries
Default	0

randDist="CAUCHY" | "MSRA" | "NORMAL" | "UNIFORM" | "XAVIER"

resume=TRUE | FALSE

Default	FALSE

samplingRate=double

specifies the fraction of the data to use for building a neural network.

Range	(0–1]

saveState=list(casouttable)

Specifies the table in which to save the model state for future model prediction.

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

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

caslib="string"

specifies the name of the caslib for the output table.

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

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

specifies the memory format for the output table.

Default	INHERIT

DVR

use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.

INHERIT

STANDARD

use the standard memory format.

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

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

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

DEFER

Defer redistribution policy selection to higher-level entity.

NOREDIST

Do not redistribute table data when the number of worker pods changes on a running CAS server.

REBALANCE

Rebalance table data when the number of worker pods changes on a running CAS server.

scaleInit=64-bit-integer

seed=double

specifies the random number seed for generating random numbers to initialize the network weights.

Maximum value	MACINT

std="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

step=double

specifies a step size for perturbations on the network weights when performing Monte Carlo or simulated annealing global optimizations.

t=double

specifies the artificial temperature parameter when performing Monte Carlo or simulated annealing global optimizations.

* table=list(castable)

specifies the settings for an input table.

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

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

caslib="string"

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

computedOnDemand=TRUE | FALSE

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

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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=list( list(casinvardesc-1) <, list(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=list(groupbytable)

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

casLib="string"

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

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

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

target="variable-name"

specifies the target or response variable for training. If you do not specify a target, then the artificial neural network is trained for autoencoding.

targetAct="EXP" | "IDENTITY" | "LOGISTIC" | "SIN" | "SOFTMAX" | "TANH"

targetComb="ADD" | "LINEAR" | "RADIAL"

specifies the combination function for the neurons on the target output nodes.

Default	LINEAR
ADD	adds all the incoming values without using any weights or biases.
LINEAR	uses a linear combination of the incoming values and weights.
RADIAL	uses a radial basis function with equal heights and unequal widths for all units in the layer.

targetMissing="MAX" | "MEAN" | "MIN" | "NONE"

MAX	specifies to replace missing values for each variable with its maximum value.
MEAN	specifies to replace missing values for each variable with its mean value.
MIN	specifies to replace missing values for each variable with its minimum value.
NONE	specifies to exclude the observations with missing values

targetStd="MIDRANGE" | "NONE" | "STD"

specifies the standardization to use on the interval variables.

Default	NONE
MIDRANGE	specifies to scale the variables to a midrange of 0 and a half-range of 1.
NONE	specifies not to alter the variables.
STD	specifies to scale the variables to a mean of 0 and a standard deviation of 1.

validTable=list(castable)

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

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

caslib="string"

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

computedOnDemand=TRUE | FALSE

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

Alias	compOnDemand
Default	FALSE

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

Alias	compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

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

Alias	compPgm

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

Alias	import

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

* name="table-name"

specifies the name of the input table.

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=list( list(casinvardesc-1) <, list(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=list(groupbytable)

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

casLib="string"

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

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

specifies data source options.

Aliases	options
Aliases	dataSource

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

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

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

Alias	import

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

* name="table-name"

specifies the name of the filter table.

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

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

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

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

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

weight="variable-name"

specifies a variable to weight the prediction errors (the difference between the output of the network and the target value specified in the input data set) for each observation during training.

Last updated: November 23, 2025