Boolean Rule Action Set: Syntax
Provides actions for Boolean rule extraction and scoring
brTrain Action
Extracts Boolean rules from text.
CASL Syntax
Parameter Descriptions
casOuts={output_parm}
specifies the data tables that contain the results generated by the action.
candidateTerms={casouttable}
specifies a data table to contain the terms that have been selected for rule creation.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
ruleTerms={casouttable}
specifies a data table to contain the terms in each rule that is generated by the action.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
rules={casouttable}
specifies a data table to contain the rules that have been generated by the action for each category.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
* docId="variable-name"
specifies the variable in the TABLE= data table that contains the document ID.
| Default | "_document_" |
docInfo={docinfo_parm}
specifies the information about the document table.
events={"string-1" <, "string-2", ...>}
specifies the values of target variables that are considered as positive events; incompatible with MULTICLASS target type.
* id="variable-name"
specifies the variable that contains the document ID.
table={castable}
specifies the input data table that contains information about documents.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
targetType="BINARY" | "MULTICLASS" | "MULTILABEL"
specifies the type of the target variables, either BINARY or MULTICLASS.
| Default | BINARY |
targets={"variable-name-1" <, "variable-name-2", ...>}
specifies the target variables.
gNegative=integer
specifies the minimum g-score needed for a negative term to be considered for rule extraction.
| Alias | gNeg |
| Default | 8 |
| Range | 0–32767 |
gPositive=integer
specifies the minimum g-score needed for a positive.
| Alias | gPos |
| Default | 8 |
| Range | 1–32767 |
mNegative=integer
specifies the m value for computing estimated precision for negative terms.
| Alias | mNeg |
| Default | 4 |
| Range | 0–32767 |
mPositive=integer
specifies the m value for computing estimated precision for positive terms.
| Alias | mPos |
| Default | 2 |
| Range | 1–32767 |
maxCandidates=integer
specifies the number of term candidates to be selected for each category.
| Default | 500 |
| Range | 0–32767 |
maxTriesIn=integer
specifies the k-in value for k-best search in the term ensemble process for creating rules.
| Default | 150 |
| Range | 0–32767 |
maxTriesOut=integer
specifies the k-out value for k-best search in the rule ensemble process for creating a rule set.
| Default | 50 |
| Range | 0–32767 |
minSupports=integer
specifies the minimum number of documents in which a term needs to appear in order for the term to be used for creating a rule.
| Default | 3 |
| Range | 0–32767 |
nThreads=integer
specifies the number of threads to be used per node. The value must be an integer.
| Default | 0 |
| Range | 0–1024 |
* table={castable}
specifies the input data table for rule extraction.
| Long form | table={name="table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* termId="variable-name"
specifies the variable in the TABLE= data table that contains the term ID.
| Default | "_termnum_" |
termInfo={terminfo_parm}
specifies the information about the terms table.
* id="variable-name"
specifies the variable that contains the term ID.
label="variable-name"
specifies the variable that contains the text of the terms. This variable must be a text variable.
table={castable}
specifies the input data table that contains information about terms.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
useOldNames=TRUE | FALSE
specifies whether to use the old variable names used in HPBOOLRULE
| Alias | legacyName, legacyNames |
| Default | FALSE |
brTrain Action
Extracts Boolean rules from text.
Lua Syntax
Parameter Descriptions
casOuts={output_parm}
specifies the data tables that contain the results generated by the action.
candidateTerms={casouttable}
specifies a data table to contain the terms that have been selected for rule creation.
caslib="string"
specifies the name of the caslib to use.
compress=true | false
when set to True, data compression is applied to the table.
| Default | false |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=true | false
This parameter is deprecated.
| Default | true |
promote=true | false
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | false |
replace=true | false
when set to True, overwrites an existing table with the same name.
| Default | false |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
ruleTerms={casouttable}
specifies a data table to contain the terms in each rule that is generated by the action.
caslib="string"
specifies the name of the caslib to use.
compress=true | false
when set to True, data compression is applied to the table.
| Default | false |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=true | false
This parameter is deprecated.
| Default | true |
promote=true | false
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | false |
replace=true | false
when set to True, overwrites an existing table with the same name.
| Default | false |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
rules={casouttable}
specifies a data table to contain the rules that have been generated by the action for each category.
caslib="string"
specifies the name of the caslib to use.
compress=true | false
when set to True, data compression is applied to the table.
| Default | false |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=true | false
This parameter is deprecated.
| Default | true |
promote=true | false
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | false |
replace=true | false
when set to True, overwrites an existing table with the same name.
| Default | false |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
* docId="variable-name"
specifies the variable in the TABLE= data table that contains the document ID.
| Default | "_document_" |
docInfo={docinfo_parm}
specifies the information about the document table.
events={"string-1" <, "string-2", ...>}
specifies the values of target variables that are considered as positive events; incompatible with MULTICLASS target type.
* id="variable-name"
specifies the variable that contains the document ID.
table={castable}
specifies the input data table that contains information about documents.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
This parameter is deprecated.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
targetType="BINARY" | "MULTICLASS" | "MULTILABEL"
specifies the type of the target variables, either BINARY or MULTICLASS.
| Default | BINARY |
targets={"variable-name-1" <, "variable-name-2", ...>}
specifies the target variables.
gNegative=integer
specifies the minimum g-score needed for a negative term to be considered for rule extraction.
| Alias | gNeg |
| Default | 8 |
| Range | 0–32767 |
gPositive=integer
specifies the minimum g-score needed for a positive.
| Alias | gPos |
| Default | 8 |
| Range | 1–32767 |
mNegative=integer
specifies the m value for computing estimated precision for negative terms.
| Alias | mNeg |
| Default | 4 |
| Range | 0–32767 |
mPositive=integer
specifies the m value for computing estimated precision for positive terms.
| Alias | mPos |
| Default | 2 |
| Range | 1–32767 |
maxCandidates=integer
specifies the number of term candidates to be selected for each category.
| Default | 500 |
| Range | 0–32767 |
maxTriesIn=integer
specifies the k-in value for k-best search in the term ensemble process for creating rules.
| Default | 150 |
| Range | 0–32767 |
maxTriesOut=integer
specifies the k-out value for k-best search in the rule ensemble process for creating a rule set.
| Default | 50 |
| Range | 0–32767 |
minSupports=integer
specifies the minimum number of documents in which a term needs to appear in order for the term to be used for creating a rule.
| Default | 3 |
| Range | 0–32767 |
nThreads=integer
specifies the number of threads to be used per node. The value must be an integer.
| Default | 0 |
| Range | 0–1024 |
* table={castable}
specifies the input data table for rule extraction.
| Long form | table={name="table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
This parameter is deprecated.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* termId="variable-name"
specifies the variable in the TABLE= data table that contains the term ID.
| Default | "_termnum_" |
termInfo={terminfo_parm}
specifies the information about the terms table.
* id="variable-name"
specifies the variable that contains the term ID.
label="variable-name"
specifies the variable that contains the text of the terms. This variable must be a text variable.
table={castable}
specifies the input data table that contains information about terms.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
This parameter is deprecated.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
useOldNames=true | false
specifies whether to use the old variable names used in HPBOOLRULE
| Alias | legacyName, legacyNames |
| Default | false |
brTrain Action
Extracts Boolean rules from text.
Python Syntax
Parameter Descriptions
casOuts={output_parm}
specifies the data tables that contain the results generated by the action.
"candidateTerms":{casouttable}
specifies a data table to contain the terms that have been selected for rule creation.
"caslib":"string"
specifies the name of the caslib to use.
"compress":True | False
when set to True, data compression is applied to the table.
| Default | False |
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
specifies the list of variables to create indexes for in the output data
"label":"string"
specifies the descriptive label to associate with the table.
"maxMemSize":64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
"name":"table-name"
specifies the name to associate with the table.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"promote":True | False
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | False |
"replace":True | False
when set to True, overwrites an existing table with the same name.
| Default | False |
"replication":integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
"timeStamp":"string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
"where":["string-1" <, "string-2", ...>]
specifies an expression for subsetting the output data.
"ruleTerms":{casouttable}
specifies a data table to contain the terms in each rule that is generated by the action.
"caslib":"string"
specifies the name of the caslib to use.
"compress":True | False
when set to True, data compression is applied to the table.
| Default | False |
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
specifies the list of variables to create indexes for in the output data
"label":"string"
specifies the descriptive label to associate with the table.
"maxMemSize":64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
"name":"table-name"
specifies the name to associate with the table.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"promote":True | False
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | False |
"replace":True | False
when set to True, overwrites an existing table with the same name.
| Default | False |
"replication":integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
"timeStamp":"string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
"where":["string-1" <, "string-2", ...>]
specifies an expression for subsetting the output data.
"rules":{casouttable}
specifies a data table to contain the rules that have been generated by the action for each category.
"caslib":"string"
specifies the name of the caslib to use.
"compress":True | False
when set to True, data compression is applied to the table.
| Default | False |
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
specifies the list of variables to create indexes for in the output data
"label":"string"
specifies the descriptive label to associate with the table.
"maxMemSize":64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
"name":"table-name"
specifies the name to associate with the table.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"promote":True | False
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | False |
"replace":True | False
when set to True, overwrites an existing table with the same name.
| Default | False |
"replication":integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
"timeStamp":"string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
"where":["string-1" <, "string-2", ...>]
specifies an expression for subsetting the output data.
* docId="variable-name"
specifies the variable in the TABLE= data table that contains the document ID.
| Default | "_document_" |
docInfo={docinfo_parm}
specifies the information about the document table.
"events":["string-1" <, "string-2", ...>]
specifies the values of target variables that are considered as positive events; incompatible with MULTICLASS target type.
* "id":"variable-name"
specifies the variable that contains the document ID.
"table":{castable}
specifies the input data table that contains information about documents.
| The castable value can be one or more of the following: |
"caslib":"string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Alias | options, dataSource |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the input data.
"targetType":"BINARY" | "MULTICLASS" | "MULTILABEL"
specifies the type of the target variables, either BINARY or MULTICLASS.
| Default | BINARY |
"targets":["variable-name-1" <, "variable-name-2", ...>]
specifies the target variables.
gNegative=integer
specifies the minimum g-score needed for a negative term to be considered for rule extraction.
| Alias | gNeg |
| Default | 8 |
| Range | 0–32767 |
gPositive=integer
specifies the minimum g-score needed for a positive.
| Alias | gPos |
| Default | 8 |
| Range | 1–32767 |
mNegative=integer
specifies the m value for computing estimated precision for negative terms.
| Alias | mNeg |
| Default | 4 |
| Range | 0–32767 |
mPositive=integer
specifies the m value for computing estimated precision for positive terms.
| Alias | mPos |
| Default | 2 |
| Range | 1–32767 |
maxCandidates=integer
specifies the number of term candidates to be selected for each category.
| Default | 500 |
| Range | 0–32767 |
maxTriesIn=integer
specifies the k-in value for k-best search in the term ensemble process for creating rules.
| Default | 150 |
| Range | 0–32767 |
maxTriesOut=integer
specifies the k-out value for k-best search in the rule ensemble process for creating a rule set.
| Default | 50 |
| Range | 0–32767 |
minSupports=integer
specifies the minimum number of documents in which a term needs to appear in order for the term to be used for creating a rule.
| Default | 3 |
| Range | 0–32767 |
nThreads=integer
specifies the number of threads to be used per node. The value must be an integer.
| Default | 0 |
| Range | 0–1024 |
* table={castable}
specifies the input data table for rule extraction.
| Long form | table={"name":"table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
"caslib":"string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Alias | options, dataSource |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
* termId="variable-name"
specifies the variable in the TABLE= data table that contains the term ID.
| Default | "_termnum_" |
termInfo={terminfo_parm}
specifies the information about the terms table.
* "id":"variable-name"
specifies the variable that contains the term ID.
"label":"variable-name"
specifies the variable that contains the text of the terms. This variable must be a text variable.
"table":{castable}
specifies the input data table that contains information about terms.
| The castable value can be one or more of the following: |
"caslib":"string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Alias | options, dataSource |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the input data.
useOldNames=True | False
specifies whether to use the old variable names used in HPBOOLRULE
| Alias | legacyName, legacyNames |
| Default | False |
brTrain Action
Extracts Boolean rules from text.
R Syntax
Parameter Descriptions
casOuts=list(output_parm)
specifies the data tables that contain the results generated by the action.
candidateTerms=list(casouttable)
specifies a data table to contain the terms that have been selected for rule creation.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where=list("string-1" <, "string-2", ...>)
specifies an expression for subsetting the output data.
ruleTerms=list(casouttable)
specifies a data table to contain the terms in each rule that is generated by the action.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where=list("string-1" <, "string-2", ...>)
specifies an expression for subsetting the output data.
rules=list(casouttable)
specifies a data table to contain the rules that have been generated by the action for each category.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where=list("string-1" <, "string-2", ...>)
specifies an expression for subsetting the output data.
* docId="variable-name"
specifies the variable in the TABLE= data table that contains the document ID.
| Default | "_document_" |
docInfo=list(docinfo_parm)
specifies the information about the document table.
events=list("string-1" <, "string-2", ...>)
specifies the values of target variables that are considered as positive events; incompatible with MULTICLASS target type.
* id="variable-name"
specifies the variable that contains the document ID.
table=list(castable)
specifies the input data table that contains information about documents.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Alias | options, dataSource |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
targetType="BINARY" | "MULTICLASS" | "MULTILABEL"
specifies the type of the target variables, either BINARY or MULTICLASS.
| Default | BINARY |
targets=list("variable-name-1" <, "variable-name-2", ...>)
specifies the target variables.
gNegative=integer
specifies the minimum g-score needed for a negative term to be considered for rule extraction.
| Alias | gNeg |
| Default | 8 |
| Range | 0–32767 |
gPositive=integer
specifies the minimum g-score needed for a positive.
| Alias | gPos |
| Default | 8 |
| Range | 1–32767 |
mNegative=integer
specifies the m value for computing estimated precision for negative terms.
| Alias | mNeg |
| Default | 4 |
| Range | 0–32767 |
mPositive=integer
specifies the m value for computing estimated precision for positive terms.
| Alias | mPos |
| Default | 2 |
| Range | 1–32767 |
maxCandidates=integer
specifies the number of term candidates to be selected for each category.
| Default | 500 |
| Range | 0–32767 |
maxTriesIn=integer
specifies the k-in value for k-best search in the term ensemble process for creating rules.
| Default | 150 |
| Range | 0–32767 |
maxTriesOut=integer
specifies the k-out value for k-best search in the rule ensemble process for creating a rule set.
| Default | 50 |
| Range | 0–32767 |
minSupports=integer
specifies the minimum number of documents in which a term needs to appear in order for the term to be used for creating a rule.
| Default | 3 |
| Range | 0–32767 |
nThreads=integer
specifies the number of threads to be used per node. The value must be an integer.
| Default | 0 |
| Range | 0–1024 |
* table=list(castable)
specifies the input data table for rule extraction.
| Long form | table=list(name="table-name") |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Alias | options, dataSource |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* termId="variable-name"
specifies the variable in the TABLE= data table that contains the term ID.
| Default | "_termnum_" |
termInfo=list(terminfo_parm)
specifies the information about the terms table.
* id="variable-name"
specifies the variable that contains the term ID.
label="variable-name"
specifies the variable that contains the text of the terms. This variable must be a text variable.
table=list(castable)
specifies the input data table that contains information about terms.
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Alias | options, dataSource |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
useOldNames=TRUE | FALSE
specifies whether to use the old variable names used in HPBOOLRULE
| Alias | legacyName, legacyNames |
| Default | FALSE |