Boolean Rule Action Set

Provides actions for Boolean rule extraction and scoring

brTrain Action

Extracts Boolean rules from text.

CASL Syntax
Summary: Input and Output Tables
Parameter Descriptions

CASL Syntax

boolRule.brTrain <result=results> <status=rc> /

casOuts={

candidateTerms={

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

rules={

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

ruleTerms={

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

}

docId="variable-name",

docInfo={

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

id="variable-name",

table={

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

groupByMode="NOSORT" | "REDISTRIBUTE"

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

name="table-name"

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

singlePass=TRUE | FALSE

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

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

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

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

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

gNegative=double,

gPositive=double,

maxCandidates=integer,

maxTriesIn=integer,

maxTriesOut=integer,

minSupports=integer,

mNegative=integer,

mPositive=integer,

nThreads=integer,

table={

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

termId="variable-name",

termInfo={

id="variable-name",

label="variable-name",

table={

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

groupByMode="NOSORT" | "REDISTRIBUTE"

name="table-name"

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

singlePass=TRUE | FALSE

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

useOldNames=TRUE | FALSE

;

indicates a required parameter

Summary: Input and Output Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
docInfo	table	specifies the information about the document table.
required parametertable	—	specifies the input data table for rule extraction.
termInfo	table	specifies the information about the terms table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOuts	rules, ruleTerms, candidateTerms	specifies the data tables that contain the results generated by the action.

Parameter Descriptions

casOuts={output_parm}

specifies the data tables that contain the results generated by the action.

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

candidateTerms={casouttable}

specifies a data table to contain the terms that have been selected for rule creation.

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

rules={casouttable}

specifies a data table to contain the rules that have been generated by the action for each category.

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

ruleTerms={casouttable}

specifies a data table to contain the terms in each rule that is generated by the action.

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

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

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

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.

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

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

specifies the target variables.

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

specifies the type of the target variables, either BINARY or MULTICLASS.

Default	BINARY

gNegative=double

specifies the minimum g-score needed for a negative term to be considered for rule extraction.

Alias	gNeg
Default	8
Range	0–32767

gPositive=double

specifies the minimum g-score needed for a positive.

Alias	gPos
Default	8
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

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

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.

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

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

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

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

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

useOldNames=TRUE | FALSE

specifies whether to use the old variable names used in HPBOOLRULE

Aliases	legacyName
Aliases	legacyNames
Default	FALSE

brTrain Action

Extracts Boolean rules from text.

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:boolRule_brTrain{

casOuts={

candidateTerms={

caslib="string"

compress=true | false

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=true | false

replace=true | false

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

rules={

caslib="string"

compress=true | false

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=true | false

replace=true | false

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

ruleTerms={

caslib="string"

compress=true | false

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=true | false

replace=true | false

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

}

docId="variable-name",

docInfo={

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

id="variable-name",

table={

caslib="string"

computedOnDemand=true | false

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

groupByMode="NOSORT" | "REDISTRIBUTE"

name="table-name"

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

singlePass=true | false

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

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

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

gNegative=double,

gPositive=double,

maxCandidates=integer,

maxTriesIn=integer,

maxTriesOut=integer,

minSupports=integer,

mNegative=integer,

mPositive=integer,

nThreads=integer,

table={

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

termId="variable-name",

termInfo={

id="variable-name",

label="variable-name",

table={

caslib="string"

computedOnDemand=true | false

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

computedVarsProgram="string"

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

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

groupByMode="NOSORT" | "REDISTRIBUTE"

name="table-name"

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

singlePass=true | false

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

useOldNames=true | false

}

indicates a required parameter

Summary: Input and Output Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
docInfo	table	specifies the information about the document table.
required parametertable	—	specifies the input data table for rule extraction.
termInfo	table	specifies the information about the terms table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOuts	rules, ruleTerms, candidateTerms	specifies the data tables that contain the results generated by the action.

Parameter Descriptions

casOuts={output_parm}

specifies the data tables that contain the results generated by the action.

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

candidateTerms={casouttable}

specifies a data table to contain the terms that have been selected for rule creation.

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

rules={casouttable}

specifies a data table to contain the rules that have been generated by the action for each category.

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

ruleTerms={casouttable}

specifies a data table to contain the terms in each rule that is generated by the action.

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

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

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

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.

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

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

specifies the target variables.

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

specifies the type of the target variables, either BINARY or MULTICLASS.

Default	BINARY

gNegative=double

specifies the minimum g-score needed for a negative term to be considered for rule extraction.

Alias	gNeg
Default	8
Range	0–32767

gPositive=double

specifies the minimum g-score needed for a positive.

Alias	gPos
Default	8
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

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

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.

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

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

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

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

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

useOldNames=true | false

specifies whether to use the old variable names used in HPBOOLRULE

Aliases	legacyName
Aliases	legacyNames
Default	false

brTrain Action

Extracts Boolean rules from text.

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.boolRule.brTrain(

casOuts={

"candidateTerms":{

"caslib":"string"

"compress":True | False

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

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

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

"name":"table-name"

"promote":True | False

"replace":True | False

"replication":integer

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

"threadBlockSize":64-bit-integer

"timeStamp":"string"

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

"rules":{

"caslib":"string"

"compress":True | False

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

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

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

"name":"table-name"

"promote":True | False

"replace":True | False

"replication":integer

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

"threadBlockSize":64-bit-integer

"timeStamp":"string"

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

"ruleTerms":{

"caslib":"string"

"compress":True | False

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

"label":"string"

"lifetime":64-bit-integer

"maxMemSize":64-bit-integer

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

"name":"table-name"

"promote":True | False

"replace":True | False

"replication":integer

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

"threadBlockSize":64-bit-integer

"timeStamp":"string"

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

}

docId="variable-name",

docInfo={

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

"id":"variable-name",

"table":{

"caslib":"string"

"computedOnDemand":True | False

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"computedVarsProgram":"string"

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

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"groupByMode":"NOSORT" | "REDISTRIBUTE"

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

"name":"table-name"

"orderBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"singlePass":True | False

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

"whereTable":{

"casLib":"string"

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

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

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

"targetType":"BINARY" | "MULTICLASS" | "MULTILABEL"

gNegative=double,

gPositive=double,

maxCandidates=integer,

maxTriesIn=integer,

maxTriesOut=integer,

minSupports=integer,

mNegative=integer,

mPositive=integer,

nThreads=integer,

table={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

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

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"groupByMode":"NOSORT" | "REDISTRIBUTE",

"name":"table-name",

"orderBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

termId="variable-name",

termInfo={

"id":"variable-name",

"label":"variable-name",

"table":{

"caslib":"string"

"computedOnDemand":True | False

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"computedVarsProgram":"string"

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

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"groupByMode":"NOSORT" | "REDISTRIBUTE"

"name":"table-name"

"orderBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"singlePass":True | False

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

useOldNames=True | False

)

indicates a required parameter

Summary: Input and Output Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
docInfo	table	specifies the information about the document table.
required parametertable	—	specifies the input data table for rule extraction.
termInfo	table	specifies the information about the terms table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOuts	rules, ruleTerms, candidateTerms	specifies the data tables that contain the results generated by the action.

Parameter Descriptions

casOuts={output_parm}

specifies the data tables that contain the results generated by the action.

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

"candidateTerms":{casouttable}

specifies a data table to contain the terms that have been selected for rule creation.

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

"rules":{casouttable}

specifies a data table to contain the rules that have been generated by the action for each category.

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

"ruleTerms":{casouttable}

specifies a data table to contain the terms in each rule that is generated by the action.

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

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

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

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

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

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

specifies the target variables.

"targetType":"BINARY" | "MULTICLASS" | "MULTILABEL"

specifies the type of the target variables, either BINARY or MULTICLASS.

Default	BINARY

gNegative=double

specifies the minimum g-score needed for a negative term to be considered for rule extraction.

Alias	gNeg
Default	8
Range	0–32767

gPositive=double

specifies the minimum g-score needed for a positive.

Alias	gPos
Default	8
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

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

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.

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

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

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

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

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

useOldNames=True | False

specifies whether to use the old variable names used in HPBOOLRULE

Aliases	legacyName
Aliases	legacyNames
Default	False

brTrain Action

Extracts Boolean rules from text.

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.boolRule.brTrain(s,

casOuts=list(

candidateTerms=list(

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

rules=list(

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

ruleTerms=list(

caslib="string"

compress=TRUE | FALSE

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

label="string"

lifetime=64-bit-integer

maxMemSize=64-bit-integer

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

name="table-name"

promote=TRUE | FALSE

replace=TRUE | FALSE

replication=integer

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

threadBlockSize=64-bit-integer

timeStamp="string"

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

)

docId="variable-name",

docInfo=list(

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

id="variable-name",

table=list(

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

computedVarsProgram="string"

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

groupBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

groupByMode="NOSORT" | "REDISTRIBUTE"

name="table-name"

orderBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

singlePass=TRUE | FALSE

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

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

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

gNegative=double,

gPositive=double,

maxCandidates=integer,

maxTriesIn=integer,

maxTriesOut=integer,

minSupports=integer,

mNegative=integer,

mPositive=integer,

nThreads=integer,

table=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

computedVarsProgram="string",

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

groupBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

termId="variable-name",

termInfo=list(

id="variable-name",

label="variable-name",

table=list(

caslib="string"

computedOnDemand=TRUE | FALSE

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

computedVarsProgram="string"

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

groupBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

groupByMode="NOSORT" | "REDISTRIBUTE"

name="table-name"

orderBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

singlePass=TRUE | FALSE

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

useOldNames=TRUE | FALSE

)

indicates a required parameter

Summary: Input and Output Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
docInfo	table	specifies the information about the document table.
required parametertable	—	specifies the input data table for rule extraction.
termInfo	table	specifies the information about the terms table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOuts	rules, ruleTerms, candidateTerms	specifies the data tables that contain the results generated by the action.

Parameter Descriptions

casOuts=list(output_parm)

specifies the data tables that contain the results generated by the action.

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

candidateTerms=list(casouttable)

specifies a data table to contain the terms that have been selected for rule creation.

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

rules=list(casouttable)

specifies a data table to contain the rules that have been generated by the action for each category.

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

ruleTerms=list(casouttable)

specifies a data table to contain the terms in each rule that is generated by the action.

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

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

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

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.

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

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

specifies the target variables.

targetType="BINARY" | "MULTICLASS" | "MULTILABEL"

specifies the type of the target variables, either BINARY or MULTICLASS.

Default	BINARY

gNegative=double

specifies the minimum g-score needed for a negative term to be considered for rule extraction.

Alias	gNeg
Default	8
Range	0–32767

gPositive=double

specifies the minimum g-score needed for a positive.

Alias	gPos
Default	8
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

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

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.

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

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

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

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

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

useOldNames=TRUE | FALSE

specifies whether to use the old variable names used in HPBOOLRULE

Aliases	legacyName
Aliases	legacyNames
Default	FALSE

Last updated: November 23, 2025