com.sas.cas.actions.decisionTree

Class ForestScoreOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.decisionTree.ForestScoreOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class ForestScoreOptions
extends CASGeneratedActionOptions

Options for forestScore: Score a table using a forest model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForestScoreOptions.VOTE

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_ASSESS
static java.lang.String	KEY_ASSESSONEROW
static java.lang.String	KEY_CASOUT
static java.lang.String	KEY_COPYVARS
static java.lang.String	KEY_IMPUTE
static java.lang.String	KEY_INCLUDEMISSING
static java.lang.String	KEY_MODELID
static java.lang.String	KEY_MODELTABLE
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_TARGET
static java.lang.String	KEY_TREEERROR
static java.lang.String	KEY_TREEVOTES
static java.lang.String	KEY_VOTE

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
ForestScoreOptions()
ForestScoreOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAssess()
java.lang.Boolean	getAssessOneRow()
Casouttable	getCasOut()
java.lang.String[]	getCopyVar()
java.lang.String[]	getCopyVars()
java.lang.Boolean	getImpute()
java.lang.Boolean	getIncludeMissing()
Castable	getModel()
java.lang.String	getModelId()
Castable	getModelTable()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Castable	getTable()
java.lang.String	getTarget()
java.lang.Boolean	getTreeError()
java.lang.Boolean	getTreeVotes()
ForestScoreOptions.VOTE	getVote()
ForestScoreOptions	setAssess(java.lang.Boolean value) Sets the value of parameter 'assess': when set to True, predicted probabilities are added to the result table for the event levels.
ForestScoreOptions	setAssessOneRow(java.lang.Boolean value) Sets the value of parameter 'assessOneRow': when set to True, predicted probabilities are added to the result table for the event levels.
ForestScoreOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut': specifies the table to store the scored results in.
ForestScoreOptions	setCopyVar(java.lang.String[] value)
ForestScoreOptions	setCopyVars(java.lang.String[] value) Sets the value of parameter 'copyVars': specifies the variables to transfer from the input table to the output table.
ForestScoreOptions	setImpute(java.lang.Boolean value) Sets the value of parameter 'impute': specifies how to handle observations with non-missing value for the target variable.
ForestScoreOptions	setIncludeMissing(java.lang.Boolean value) Sets the value of parameter 'includeMissing': by default, observations with missing values are included.
ForestScoreOptions	setModel(Castable value)
ForestScoreOptions	setModelId(java.lang.String value) Sets the value of parameter 'modelId': specifies the model ID variable name to use when generating the scored table.
ForestScoreOptions	setModelTable(Castable value) Sets the value of parameter 'modelTable': specifies the table to store the tree model in.
ForestScoreOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the settings for an input table.
ForestScoreOptions	setTarget(java.lang.String value) Sets the value of parameter 'target': specifies the target variable when scoring a data set.
ForestScoreOptions	setTreeError(java.lang.Boolean value) Sets the value of parameter 'treeError': when set to True, the error is computed for each tree.
ForestScoreOptions	setTreeVotes(java.lang.Boolean value) Sets the value of parameter 'treeVotes': requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees.
ForestScoreOptions	setVote(ForestScoreOptions.VOTE value) Sets the value of parameter 'vote': specifies the vote strategy for classification.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_TABLE

public static final java.lang.String KEY_TABLE

See Also:

Constant Field Values

KEY_MODELTABLE

public static final java.lang.String KEY_MODELTABLE

See Also:

Constant Field Values

KEY_COPYVARS

public static final java.lang.String KEY_COPYVARS

See Also:

Constant Field Values

KEY_IMPUTE

public static final java.lang.String KEY_IMPUTE

See Also:

Constant Field Values

KEY_TREEVOTES

public static final java.lang.String KEY_TREEVOTES

See Also:

Constant Field Values

KEY_ASSESS

public static final java.lang.String KEY_ASSESS

See Also:

Constant Field Values

KEY_MODELID

public static final java.lang.String KEY_MODELID

See Also:

Constant Field Values

KEY_TARGET

public static final java.lang.String KEY_TARGET

See Also:

Constant Field Values

KEY_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

KEY_ASSESSONEROW

public static final java.lang.String KEY_ASSESSONEROW

See Also:

Constant Field Values

KEY_VOTE

public static final java.lang.String KEY_VOTE

See Also:

Constant Field Values

KEY_TREEERROR

public static final java.lang.String KEY_TREEERROR

See Also:

Constant Field Values

KEY_INCLUDEMISSING

public static final java.lang.String KEY_INCLUDEMISSING

See Also:

Constant Field Values

Constructor Detail

ForestScoreOptions

public ForestScoreOptions()

ForestScoreOptions

public ForestScoreOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getTable

public Castable getTable()

setTable

public ForestScoreOptions setTable(Castable value)

Sets the value of parameter 'table': specifies the settings for an input table.

Parameters:

value - The value

Returns:

The options object

getModelTable

public Castable getModelTable()

getModel

public Castable getModel()

setModelTable

public ForestScoreOptions setModelTable(Castable value)

Sets the value of parameter 'modelTable': specifies the table to store the tree model in.

Parameters:

value - The value

Returns:

The options object

setModel

public ForestScoreOptions setModel(Castable value)

getCopyVars

public java.lang.String[] getCopyVars()

getCopyVar

public java.lang.String[] getCopyVar()

setCopyVars

public ForestScoreOptions setCopyVars(java.lang.String[] value)

Sets the value of parameter 'copyVars': specifies the variables to transfer from the input table to the output table.

Parameters:

value - The value

Returns:

The options object

setCopyVar

public ForestScoreOptions setCopyVar(java.lang.String[] value)

getImpute

public java.lang.Boolean getImpute()

setImpute

public ForestScoreOptions setImpute(java.lang.Boolean value)

Sets the value of parameter 'impute': specifies how to handle observations with non-missing value for the target variable. When true, the observed values are assumed to be known without error and are used as the predicted values. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getTreeVotes

public java.lang.Boolean getTreeVotes()

setTreeVotes

public ForestScoreOptions setTreeVotes(java.lang.Boolean value)

Sets the value of parameter 'treeVotes': requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getAssess

public java.lang.Boolean getAssess()

setAssess

public ForestScoreOptions setAssess(java.lang.Boolean value)

Sets the value of parameter 'assess': when set to True, predicted probabilities are added to the result table for the event levels. You can use these predicted probabilities with the assess action. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getModelId

public java.lang.String getModelId()

setModelId

public ForestScoreOptions setModelId(java.lang.String value)

Sets the value of parameter 'modelId': specifies the model ID variable name to use when generating the scored table. By default, the variable name is _DT_PredName_ for classifications, _DT_PredLowerbd_ and _DT_PredUpperbd_ for a binned target, and _DT_PredMean_ for regressions.

Parameters:

value - The value

Returns:

The options object

getTarget

public java.lang.String getTarget()

setTarget

public ForestScoreOptions setTarget(java.lang.String value)

Sets the value of parameter 'target': specifies the target variable when scoring a data set. If the target variable name in the tree model is the same in the scored table, then this option is not required.

Parameters:

value - The value

Returns:

The options object

getCasOut

public Casouttable getCasOut()

setCasOut

public ForestScoreOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut': specifies the table to store the scored results in. When not specified, the action scores the data set and compute only the mis-classification rate for classifications and mean squared error for regressions.

Parameters:

value - The value

Returns:

The options object

getAssessOneRow

public java.lang.Boolean getAssessOneRow()

setAssessOneRow

public ForestScoreOptions setAssessOneRow(java.lang.Boolean value)

Sets the value of parameter 'assessOneRow': when set to True, predicted probabilities are added to the result table for the event levels. All event probabilities are included as separate columns and are named with the prefix _DT_P_. You can use these predicted probabilities with the assess action. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getVote

public ForestScoreOptions.VOTE getVote()

setVote

public ForestScoreOptions setVote(ForestScoreOptions.VOTE value)

Sets the value of parameter 'vote': specifies the vote strategy for classification. The specified value influences the generated SAS scoring code and the OOB error computations. The server default is VOTE.MAJORITY.

Parameters:

value - The value

Returns:

The options object

getTreeError

public java.lang.Boolean getTreeError()

setTreeError

public ForestScoreOptions setTreeError(java.lang.Boolean value)

Sets the value of parameter 'treeError': when set to True, the error is computed for each tree. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getIncludeMissing

public java.lang.Boolean getIncludeMissing()

setIncludeMissing

public ForestScoreOptions setIncludeMissing(java.lang.Boolean value)

Sets the value of parameter 'includeMissing': by default, observations with missing values are included. When set to False, observations with missing values for the variables used in the tree model are ignored when scoring. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object