Provides actions for explaining already trained models.
Computes the partial dependence of an already trained model.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parameteranalysisVariable |
levelsTable |
specifies the analysis variable and its related attributes. |
|
levelsTable |
specifies the second analysis variable and its related attributes. |
|
|
— |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code. |
|
|
— |
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables. |
|
|
required parametertable |
— |
specifies the input data table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametercasOut |
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
specifies the analysis variable and its related attributes.
| Alias | analysisVariable1 |
|---|
| Long form | analysisVariable={name="variable-name"} |
|---|---|
| Shortcut form | analysisVariable="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | FALSE |
|---|
specifies the second analysis variable and its related attributes.
| Long form | analysisVariable2={name="variable-name"} |
|---|---|
| Shortcut form | analysisVariable2="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | FALSE |
|---|
specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.
| Alias | codeString |
|---|
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
names the numeric variable that contains the frequency of occurrence of each observation.
specifies the model input variables to use in the analysis.
For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | input |
|---|
specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.
| Default | 1 |
|---|---|
| Range | 0–2 |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
| Long form | modelTable={name="table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the nominal model input variables to use in the analysis.
For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | nominal |
|---|
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves.
| Alias | iceTable |
|---|
The pdOutput value can be one or more of the following:
specifies the settings for an output table.
For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies a list of one or more variables to be copied from the input table to the output table. You can alternatively specify the value ALL, or ALL_NUMERIC, which respectively copies all variables, or all numeric variables from the input table to the output table.
lists the names of results tables to save as CAS tables on the server.
| Alias | displayOut |
|---|
The outputTables value can be one or more of the following:
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | FALSE |
|---|
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
The casouttable value is specified as follows:
specifies the name of the caslib for the output table.
when set to True, applies data compression to the table.
| Default | FALSE |
|---|
specifies the list of variables to create indexes for in the output data.
specifies the descriptive label to associate with the table.
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 |
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
specifies the memory format for the output table.
| Default | INHERIT |
|---|
specifies the name for the output table.
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 |
|---|
when set to True, overwrites an existing table that has the same name.
| Default | FALSE |
|---|
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Alias | blockSize |
|---|---|
| Default | 1048576 |
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | FALSE |
|---|
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | TRUE |
|---|
specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.
specifies the approximate number of observations to sample from the input data table.
| Default | 1000 |
|---|---|
| Range | 100–5000 |
specifies the seed value for random number generation.
| Default | 0 |
|---|
specifies the input data table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
names the numeric variable to use to perform a weighted analysis of the data.
Computes the partial dependence of an already trained model.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parameteranalysisVariable |
levelsTable |
specifies the analysis variable and its related attributes. |
|
levelsTable |
specifies the second analysis variable and its related attributes. |
|
|
— |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code. |
|
|
— |
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables. |
|
|
required parametertable |
— |
specifies the input data table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametercasOut |
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
specifies the analysis variable and its related attributes.
| Alias | analysisVariable1 |
|---|
| Long form | analysisVariable={name="variable-name"} |
|---|---|
| Shortcut form | analysisVariable="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | false |
|---|
specifies the second analysis variable and its related attributes.
| Long form | analysisVariable2={name="variable-name"} |
|---|---|
| Shortcut form | analysisVariable2="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | false |
|---|
specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.
| Alias | codeString |
|---|
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
names the numeric variable that contains the frequency of occurrence of each observation.
specifies the model input variables to use in the analysis.
For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | input |
|---|
specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.
| Default | 1 |
|---|---|
| Range | 0–2 |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
| Long form | modelTable={name="table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the nominal model input variables to use in the analysis.
For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | nominal |
|---|
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves.
| Alias | iceTable |
|---|
The pdOutput value can be one or more of the following:
specifies the settings for an output table.
For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies a list of one or more variables to be copied from the input table to the output table. You can alternatively specify the value ALL, or ALL_NUMERIC, which respectively copies all variables, or all numeric variables from the input table to the output table.
lists the names of results tables to save as CAS tables on the server.
| Alias | displayOut |
|---|
The outputTables value can be one or more of the following:
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | false |
|---|
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
The casouttable value is specified as follows:
specifies the name of the caslib for the output table.
when set to True, applies data compression to the table.
| Default | false |
|---|
specifies the list of variables to create indexes for in the output data.
specifies the descriptive label to associate with the table.
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 |
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
specifies the memory format for the output table.
| Default | INHERIT |
|---|
specifies the name for the output table.
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 |
|---|
when set to True, overwrites an existing table that has the same name.
| Default | false |
|---|
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Alias | blockSize |
|---|---|
| Default | 1048576 |
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | false |
|---|
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | true |
|---|
specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.
specifies the approximate number of observations to sample from the input data table.
| Default | 1000 |
|---|---|
| Range | 100–5000 |
specifies the seed value for random number generation.
| Default | 0 |
|---|
specifies the input data table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
names the numeric variable to use to perform a weighted analysis of the data.
Computes the partial dependence of an already trained model.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parameteranalysisVariable |
levelsTable |
specifies the analysis variable and its related attributes. |
|
levelsTable |
specifies the second analysis variable and its related attributes. |
|
|
— |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code. |
|
|
— |
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables. |
|
|
required parametertable |
— |
specifies the input data table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametercasOut |
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
specifies the analysis variable and its related attributes.
| Alias | analysisVariable1 |
|---|
| Long form | analysisVariable={"name":"variable-name"} |
|---|---|
| Shortcut form | analysisVariable="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | False |
|---|
specifies the second analysis variable and its related attributes.
| Long form | analysisVariable2={"name":"variable-name"} |
|---|---|
| Shortcut form | analysisVariable2="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | False |
|---|
specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.
| Alias | codeString |
|---|
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
names the numeric variable that contains the frequency of occurrence of each observation.
specifies the model input variables to use in the analysis.
For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | input |
|---|
specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.
| Default | 1 |
|---|---|
| Range | 0–2 |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
| Long form | modelTable={"name":"table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the nominal model input variables to use in the analysis.
For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | nominal |
|---|
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves.
| Alias | iceTable |
|---|
The pdOutput value can be one or more of the following:
specifies the settings for an output table.
For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies a list of one or more variables to be copied from the input table to the output table. You can alternatively specify the value ALL, or ALL_NUMERIC, which respectively copies all variables, or all numeric variables from the input table to the output table.
lists the names of results tables to save as CAS tables on the server.
| Alias | displayOut |
|---|
The outputTables value can be one or more of the following:
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | False |
|---|
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
The casouttable value is specified as follows:
specifies the name of the caslib for the output table.
when set to True, applies data compression to the table.
| Default | False |
|---|
specifies the list of variables to create indexes for in the output data.
specifies the descriptive label to associate with the table.
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 |
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
specifies the memory format for the output table.
| Default | INHERIT |
|---|
specifies the name for the output table.
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 |
|---|
when set to True, overwrites an existing table that has the same name.
| Default | False |
|---|
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Alias | blockSize |
|---|---|
| Default | 1048576 |
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | False |
|---|
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | True |
|---|
specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.
specifies the approximate number of observations to sample from the input data table.
| Default | 1000 |
|---|---|
| Range | 100–5000 |
specifies the seed value for random number generation.
| Default | 0 |
|---|
specifies the input data table.
| Long form | table={"name":"table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
names the numeric variable to use to perform a weighted analysis of the data.
Computes the partial dependence of an already trained model.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parameteranalysisVariable |
levelsTable |
specifies the analysis variable and its related attributes. |
|
levelsTable |
specifies the second analysis variable and its related attributes. |
|
|
— |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code. |
|
|
— |
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables. |
|
|
required parametertable |
— |
specifies the input data table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametercasOut |
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
specifies the analysis variable and its related attributes.
| Alias | analysisVariable1 |
|---|
| Long form | analysisVariable=list(name="variable-name") |
|---|---|
| Shortcut form | analysisVariable="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | FALSE |
|---|
specifies the second analysis variable and its related attributes.
| Long form | analysisVariable2=list(name="variable-name") |
|---|---|
| Shortcut form | analysisVariable2="variable-name" |
The analysisVariable value can be one or more of the following:
specifies a variable that defines how to order the levels that are read from the nominal levels table.
specifies a table of levels of the nominal analysis variable(s).
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the maximum value of the analysis variable.
specifies the maximum number of levels to use for a nominal analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
specifies the minimum value of the analysis variable.
specifies the name of the analysis variable.
| Alias | variable |
|---|
specifies the number of bins to use for an interval analysis variable.
| Default | 10 |
|---|---|
| Range | 2–100 |
when set to True, reports missing values of the analysis variable.
| Default | FALSE |
|---|
specifies the DATA step code that describes the model or DS2 code that is used along with an analytic store that is specified in the modelTable or modelTables parameter.
| Alias | codeString |
|---|
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
names the numeric variable that contains the frequency of occurrence of each observation.
specifies the model input variables to use in the analysis.
For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | input |
|---|
specifies a value to control the amount of notes to print to the client log. A value of 0 prints only warnings and errors; a value of 1 prints some notes; a value of 2 prints many notes.
| Default | 1 |
|---|---|
| Range | 0–2 |
specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step score code.
| Long form | modelTable=list(name="table-name") |
|---|---|
| Shortcut form | modelTable="table-name" |
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the input tables that contain the model to explain. These table must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies these tables.
The castable value can be one or more of the following:
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.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the name of the input table.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the nominal model input variables to use in the analysis.
For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | nominal |
|---|
specifies the output table of scored data replicates. This table can be used to plot individual conditional expectation curves.
| Alias | iceTable |
|---|
The pdOutput value can be one or more of the following:
specifies the settings for an output table.
For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies a list of one or more variables to be copied from the input table to the output table. You can alternatively specify the value ALL, or ALL_NUMERIC, which respectively copies all variables, or all numeric variables from the input table to the output table.
lists the names of results tables to save as CAS tables on the server.
| Alias | displayOut |
|---|
The outputTables value can be one or more of the following:
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | FALSE |
|---|
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
The casouttable value is specified as follows:
specifies the name of the caslib for the output table.
when set to True, applies data compression to the table.
| Default | FALSE |
|---|
specifies the list of variables to create indexes for in the output data.
specifies the descriptive label to associate with the table.
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 |
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
specifies the memory format for the output table.
| Default | INHERIT |
|---|
specifies the name for the output table.
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 |
|---|
when set to True, overwrites an existing table that has the same name.
| Default | FALSE |
|---|
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Alias | blockSize |
|---|---|
| Default | 1048576 |
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | FALSE |
|---|
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | TRUE |
|---|
specifies the variable that contains the model's predictions. The variable typically has a P_ prefix.
specifies the approximate number of observations to sample from the input data table.
| Default | 1000 |
|---|---|
| Range | 100–5000 |
specifies the seed value for random number generation.
| Default | 0 |
|---|
specifies the input data table.
| Long form | table=list(name="table-name") |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
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.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
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).
specifies the name of the input table.
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 |
|---|
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
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:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common 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).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
names the numeric variable to use to perform a weighted analysis of the data.