oracle.dmt.odm.settings.function
Class SupervisedFunctionSettings

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.settings.function.MiningFunctionSettings
                    |
                    +--oracle.dmt.odm.settings.function.SupervisedFunctionSettings

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClassificationFunctionSettings, RegressionFunctionSettings

public abstract class SupervisedFunctionSettings

extends MiningFunctionSettings

SupervisedFunctionSettings describes settings for supervised learning functions. Currently, ODM supports only classification.

See Also:

Serialized Form

Constructor Summary

SupervisedFunctionSettings(float accuracy, LogicalDataSpecification lds, DataUsageSpecification dus, MiningFunction function)
Deprecated. As of ODM 9.2.0. The parameter accuracy is not used. Use other constructor without accuracy parameter.

SupervisedFunctionSettings(float accuracy, LogicalDataSpecification lds, DataUsageSpecification dus, MiningFunction function, MiningAlgorithmSettings algorithm)
Deprecated. As of ODM 9.2.0. The parameter accuracy is not used. Use other constructor without accuracy parameter.

SupervisedFunctionSettings(LogicalDataSpecification lds, DataUsageSpecification dus, MiningFunction function, MiningAlgorithmSettings algorithm)
Creates an instance of SupervisedFunctionSettings object.

Method Summary

float	getDesiredAccuracy() Deprecated. The parameter accuracy is not used.
MiningAttribute[]	getPredictorAttributes() Returns a list of predictor attributes in this MFS.
MiningAttribute[]	getTargetAttributes() Returns a list of target attributes in this MFS.
MiningAttribute[]	getUnpreparedPredictorAttributes() Returns a list of unprepared predictor attributes in this MFS.
void	setDesiredAccuracy(float accuracy) Deprecated. The parameter accuracy is not used.

Methods inherited from class oracle.dmt.odm.settings.function.MiningFunctionSettings

activateAll, adjustAttributesType, adjustAttributeUsage, adjustAttributeUsage, adjustDataPreparationStatus, adjustSparsitySpecification, getDataUsageSpecification, getLogicalDataSpecification, getMiningAlgorithmName, getMiningAlgorithmSettings, getMiningAttributes, getMiningFunction, getName, getSettingsID, getSupplementalAttributes, getValidateBeforeStore, listContents, listContents, listContents, listContents, remove, rename, restore, restore, restorePastVersion, restorePastVersion, setDataUsageSpecification, setLogicalDataSpecification, setMiningAlgorithmName, setMiningAlgorithmSettings, setMiningFunction, setValidateBeforeStore, store, storeInternal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupervisedFunctionSettings

public SupervisedFunctionSettings(float accuracy,
LogicalDataSpecification lds,
DataUsageSpecification dus,
MiningFunction function,
MiningAlgorithmSettings algorithm)
                           throws InvalidArgumentException

Deprecated. As of ODM 9.2.0. The parameter accuracy is not used. Use other constructor without accuracy parameter.

Creates an instance of SupervisedFunctionSettings object.

Parameters:

accuracy - The desired minimum accuracy of the model to be built

lds - A LogicalDataSpecification object that specifies the logical data to be used for model building

dus - A DataUsageSpecification object that defines how the logical data is to be used for model building

function - The type of supervised function to be performed.

algorithm - A MiningAlgorithmSettings object that specifies the algorithm to be used for model building. If null, a default algorithm is chosen.

Throws:

InvalidArgumentException - when lds or dus is null.

SupervisedFunctionSettings

public SupervisedFunctionSettings(LogicalDataSpecification lds,
DataUsageSpecification dus,
MiningFunction function,
MiningAlgorithmSettings algorithm)
                           throws InvalidArgumentException

Creates an instance of SupervisedFunctionSettings object.

Parameters:

lds - A LogicalDataSpecification object that specifies the logical data to be used for model building

dus - A DataUsageSpecification object that defines how the logical data is to be used for model building

function - The type of supervised function to be performed.

algorithm - A MiningAlgorithmSettings object that specifies the algorithm to be used for model building. If null, a default algorithm is chosen.

Throws:

InvalidArgumentException - when lds or dus is null.

Since:

9.2.0

SupervisedFunctionSettings

public SupervisedFunctionSettings(float accuracy,
LogicalDataSpecification lds,
DataUsageSpecification dus,
MiningFunction function)
                           throws InvalidArgumentException

Deprecated. As of ODM 9.2.0. The parameter accuracy is not used. Use other constructor without accuracy parameter.

Creates an instance of SupervisedFunctionSettings object.

Parameters:

accuracy - The desired minimum accuracy of the model to be built

lds - A LogicalDataSpecification object that specifies the logical data to be used for model building

dus - A DataUsageSpecification object that defines how the logical data is to be used for model building

function - The type of supervised function to be performed.

Throws:

InvalidArgumentException - when lds or dus is null.

Method Detail

getDesiredAccuracy

public float getDesiredAccuracy()

Deprecated. The parameter accuracy is not used.

Returns the user-specified desired accuracy for this mining functional specification.

Returns:

User-specified accuracy

setDesiredAccuracy

public void setDesiredAccuracy(float accuracy)

Deprecated. The parameter accuracy is not used.

Sets the desired accuracy for this mining functional specification.

Parameters:

accuracy - Desired accuracy for this MFS

getTargetAttributes

public MiningAttribute[] getTargetAttributes()

Returns a list of target attributes in this MFS. Currently, ODM supports only single-target supervised learning.

Returns:

An array of target mining attributes

See Also:

AttributeUsage

getPredictorAttributes

public MiningAttribute[] getPredictorAttributes()

Returns a list of predictor attributes in this MFS.

Returns:

An array of predictor mining attributes

See Also:

AttributeUsage

getUnpreparedPredictorAttributes

public MiningAttribute[] getUnpreparedPredictorAttributes()

Returns a list of unprepared predictor attributes in this MFS.

Returns:

An array of unprepared predictor attributes

See Also:

AttributeUsage, DataPreparationStatus