com.sas.cas.actions.factmac

Class FactmacOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.factmac.FactmacOptions

All Implemented Interfaces:

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

public class FactmacOptions
extends CASGeneratedActionOptions

Options for factmac: Learns a factorization machine model.

See Also:

Serialized Form

Nested Class Summary

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_ATTRIBUTES
static java.lang.String	KEY_CODE
static java.lang.String	KEY_CODEGROUP
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_ID
static java.lang.String	KEY_INPUTS
static java.lang.String	KEY_LEARNSTEP
static java.lang.String	KEY_MAXITER
static java.lang.String	KEY_MODELID
static java.lang.String	KEY_NFACTORS
static java.lang.String	KEY_NOMINALS
static java.lang.String	KEY_NONNEGATIVE
static java.lang.String	KEY_OUTMODEL
static java.lang.String	KEY_OUTPUT
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_SAVESTATE
static java.lang.String	KEY_SEED
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_TARGET

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
FactmacOptions()
FactmacOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
Casinvardesc[]	getAttribute()
Casinvardesc[]	getAttributes()
Aircodegen	getCode()
java.lang.String	getCodeGroup()
DisplayTables	getDisplay()
java.lang.String	getFreq()
java.lang.String[]	getId()
Casinvardesc[]	getInput()
Casinvardesc[]	getInputs()
java.lang.Double	getLearnStep()
java.lang.Integer	getMaxIter()
java.lang.String	getModelId()
java.lang.Integer	getNFactors()
Casinvardesc[]	getNominal()
Casinvardesc[]	getNominals()
java.lang.Boolean	getNonNegative()
Casouttable	getOutModel()
OutputStatement	getOutput()
OutputTables	getOutputTables()
Casouttable	getSaveState()
java.lang.Double	getSeed()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Castable	getTable()
java.lang.String	getTarget()
FactmacOptions	setAttribute(Casinvardesc[] value)
FactmacOptions	setAttributes(Casinvardesc[] value) Sets the value of parameter 'attributes': specifies the variable attributes.
FactmacOptions	setCode(Aircodegen value) Sets the value of parameter 'code': requests that the action produce SAS score code.
FactmacOptions	setCodeGroup(java.lang.String value) Sets the value of parameter 'codeGroup': specifies the code group.
FactmacOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
FactmacOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq': specifies the frequency variable.
FactmacOptions	setId(java.lang.String[] value) Sets the value of parameter 'id': specifies the variables to use as record identifiers and to transfer to the state output table.
FactmacOptions	setInput(Casinvardesc[] value)
FactmacOptions	setInputs(Casinvardesc[] value) Sets the value of parameter 'inputs': specifies the variables to be used in the training.
FactmacOptions	setLearnStep(java.lang.Double value) Sets the value of parameter 'learnStep': specifies the learning step size for the optimization.
FactmacOptions	setMaxIter(java.lang.Integer value) Sets the value of parameter 'maxIter': specifies the maximum number of iterations.
FactmacOptions	setModelId(java.lang.String value) Sets the value of parameter 'modelId': specifies the model ID variable name.
FactmacOptions	setNFactors(java.lang.Integer value) Sets the value of parameter 'nFactors': specifies the number of factors to be estimated.
FactmacOptions	setNominal(Casinvardesc[] value)
FactmacOptions	setNominals(Casinvardesc[] value) Sets the value of parameter 'nominals': specifies the nominal variables to be used in the training.
FactmacOptions	setNonNegative(java.lang.Boolean value) Sets the value of parameter 'nonNegative': requests that the action perform non-negative factorization.
FactmacOptions	setOutModel(Casouttable value) Sets the value of parameter 'outModel': specifies the output data table in which to save the estimated factorization machine parameters.
FactmacOptions	setOutput(OutputStatement value) Sets the value of parameter 'output'.
FactmacOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
FactmacOptions	setSaveState(Casouttable value) Sets the value of parameter 'saveState': specifies the output data table in which to save the state of the factorization machine for future scoring.
FactmacOptions	setSeed(java.lang.Double value) Sets the value of parameter 'seed': specifies the seed value for random number generation.
FactmacOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the settings for an input table.
FactmacOptions	setTarget(java.lang.String value) Sets the value of parameter 'target': specifies the target variable.

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_OUTMODEL

public static final java.lang.String KEY_OUTMODEL

See Also:

Constant Field Values

KEY_INPUTS

public static final java.lang.String KEY_INPUTS

See Also:

Constant Field Values

KEY_NOMINALS

public static final java.lang.String KEY_NOMINALS

See Also:

Constant Field Values

KEY_TARGET

public static final java.lang.String KEY_TARGET

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

See Also:

Constant Field Values

KEY_ATTRIBUTES

public static final java.lang.String KEY_ATTRIBUTES

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

KEY_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_CODE

public static final java.lang.String KEY_CODE

See Also:

Constant Field Values

KEY_CODEGROUP

public static final java.lang.String KEY_CODEGROUP

See Also:

Constant Field Values

KEY_MODELID

public static final java.lang.String KEY_MODELID

See Also:

Constant Field Values

KEY_OUTPUT

public static final java.lang.String KEY_OUTPUT

See Also:

Constant Field Values

KEY_SEED

public static final java.lang.String KEY_SEED

See Also:

Constant Field Values

KEY_MAXITER

public static final java.lang.String KEY_MAXITER

See Also:

Constant Field Values

KEY_NFACTORS

public static final java.lang.String KEY_NFACTORS

See Also:

Constant Field Values

KEY_LEARNSTEP

public static final java.lang.String KEY_LEARNSTEP

See Also:

Constant Field Values

KEY_SAVESTATE

public static final java.lang.String KEY_SAVESTATE

See Also:

Constant Field Values

KEY_ID

public static final java.lang.String KEY_ID

See Also:

Constant Field Values

KEY_NONNEGATIVE

public static final java.lang.String KEY_NONNEGATIVE

See Also:

Constant Field Values

Constructor Detail

FactmacOptions

public FactmacOptions()

FactmacOptions

public FactmacOptions(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 FactmacOptions setTable(Castable value)

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

Parameters:

value - The value

Returns:

The options object

getOutModel

public Casouttable getOutModel()

setOutModel

public FactmacOptions setOutModel(Casouttable value)

Sets the value of parameter 'outModel': specifies the output data table in which to save the estimated factorization machine parameters.

Parameters:

value - The value

Returns:

The options object

getInputs

public Casinvardesc[] getInputs()

getInput

public Casinvardesc[] getInput()

setInputs

public FactmacOptions setInputs(Casinvardesc[] value)

Sets the value of parameter 'inputs': specifies the variables to be used in the training.

Parameters:

value - The value

Returns:

The options object

setInput

public FactmacOptions setInput(Casinvardesc[] value)

getNominals

public Casinvardesc[] getNominals()

getNominal

public Casinvardesc[] getNominal()

setNominals

public FactmacOptions setNominals(Casinvardesc[] value)

Sets the value of parameter 'nominals': specifies the nominal variables to be used in the training.

Parameters:

value - The value

Returns:

The options object

setNominal

public FactmacOptions setNominal(Casinvardesc[] value)

getTarget

public java.lang.String getTarget()

setTarget

public FactmacOptions setTarget(java.lang.String value)

Sets the value of parameter 'target': specifies the target variable.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

setFreq

public FactmacOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq': specifies the frequency variable.

Parameters:

value - The value

Returns:

The options object

getAttributes

public Casinvardesc[] getAttributes()

getAttribute

public Casinvardesc[] getAttribute()

setAttributes

public FactmacOptions setAttributes(Casinvardesc[] value)

Sets the value of parameter 'attributes': specifies the variable attributes.

Parameters:

value - The value

Returns:

The options object

setAttribute

public FactmacOptions setAttribute(Casinvardesc[] value)

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public FactmacOptions setOutputTables(OutputTables value)

Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public FactmacOptions setDisplay(DisplayTables value)

Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.

Parameters:

value - The value

Returns:

The options object

getCode

public Aircodegen getCode()

setCode

public FactmacOptions setCode(Aircodegen value)

Sets the value of parameter 'code': requests that the action produce SAS score code.

Parameters:

value - The value

Returns:

The options object

getCodeGroup

public java.lang.String getCodeGroup()

setCodeGroup

public FactmacOptions setCodeGroup(java.lang.String value)

Sets the value of parameter 'codeGroup': specifies the code group.

Parameters:

value - The value

Returns:

The options object

getModelId

public java.lang.String getModelId()

setModelId

public FactmacOptions setModelId(java.lang.String value)

Sets the value of parameter 'modelId': specifies the model ID variable name.

Parameters:

value - The value

Returns:

The options object

getOutput

public OutputStatement getOutput()

setOutput

public FactmacOptions setOutput(OutputStatement value)

Sets the value of parameter 'output'.

Parameters:

value - The value

Returns:

The options object

getSeed

public java.lang.Double getSeed()

setSeed

public FactmacOptions setSeed(java.lang.Double value)

Sets the value of parameter 'seed': specifies the seed value for random number generation. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getMaxIter

public java.lang.Integer getMaxIter()

setMaxIter

public FactmacOptions setMaxIter(java.lang.Integer value)

Sets the value of parameter 'maxIter': specifies the maximum number of iterations. The server default is 30.

Parameters:

value - The value

Returns:

The options object

getNFactors

public java.lang.Integer getNFactors()

setNFactors

public FactmacOptions setNFactors(java.lang.Integer value)

Sets the value of parameter 'nFactors': specifies the number of factors to be estimated. The server default is 5.

Parameters:

value - The value

Returns:

The options object

getLearnStep

public java.lang.Double getLearnStep()

setLearnStep

public FactmacOptions setLearnStep(java.lang.Double value)

Sets the value of parameter 'learnStep': specifies the learning step size for the optimization. The server default is 0.001.

Parameters:

value - The value

Returns:

The options object

getSaveState

public Casouttable getSaveState()

setSaveState

public FactmacOptions setSaveState(Casouttable value)

Sets the value of parameter 'saveState': specifies the output data table in which to save the state of the factorization machine for future scoring.

Parameters:

value - The value

Returns:

The options object

getId

public java.lang.String[] getId()

setId

public FactmacOptions setId(java.lang.String[] value)

Sets the value of parameter 'id': specifies the variables to use as record identifiers and to transfer to the state output table.

Parameters:

value - The value

Returns:

The options object

getNonNegative

public java.lang.Boolean getNonNegative()

setNonNegative

public FactmacOptions setNonNegative(java.lang.Boolean value)

Sets the value of parameter 'nonNegative': requests that the action perform non-negative factorization. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object