oracle.dmt.odm.model
Class NMFModel

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.model.MiningModel
                    |
                    +--oracle.dmt.odm.model.FeatureExtractionModel
                          |
                          +--oracle.dmt.odm.model.NMFModel

All Implemented Interfaces:

java.io.Serializable

public abstract class NMFModel

extends oracle.dmt.odm.model.FeatureExtractionModel

The abstract class NMFModel is a Java representation of the Non-negative matrix factorization(NMF) model. NMF is a feature extraction algorithm that creates a new set of attributes (features).Each feature is a linear combination of the original attribute set. In NMF, the coefficients of these linear combinations are constrained to be non-negative. During apply a NMF model recodes the original data into the new set of attributes (features) discovered by the model.

See Also:

Serialized Form

Method Summary

static void	apply(Connection dmsConn, LocationAccessData applyData, PhysicalDataSpecification pds, java.lang.String modelName, MiningApplyOutput applyOutput, LocationAccessData outputLoc, java.lang.String applyResultName)
float	getErrorRate() Returns the overall error rate
NMFFeature[]	getFeatures(Connection dmsConn, int topNCoefficients) Returns a array of Encoded Feature Objects
int	getNumberOfIterations() Returns the actual number of iterations required for the NMF convergence
static NMFModel	restore(Connection dmsConn, java.lang.String modelName) Returns the specified NMFModel and populates the complex model object for reading by a user program.

Methods inherited from class oracle.dmt.odm.model.MiningModel

build, getBinCategoricalTableName, getBinNumericTableName, getMiningAlgorithm, getMiningFunction, getMiningFunctionSettings, getModelAlgorithm, getModelMiningFunction, getModelName, getSignature, listContents, listContents, listContents, listContents, remove, rename, storeLocationdata

Methods inherited from class java.lang.Object

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

Method Detail

getErrorRate

public float getErrorRate()

Returns the overall error rate

Returns:

The overall error rate.

getNumberOfIterations

public int getNumberOfIterations()

Returns the actual number of iterations required for the NMF convergence

Returns:

The actual number of iterations required for the NMF convergence.

getFeatures

public NMFFeature[] getFeatures(Connection dmsConn,
                                int topNCoefficients)
                                              throws ODMException,
InvalidArgumentException,
                                                     java.sql.SQLException

Returns a array of Encoded Feature Objects

Throws:

ODMException - when model table name is null.

InvalidArgumentException -

• when dmsConn is null,
• when topNCoefficients <= 0, or
• when modelName is null.

java.sql.SQLException - when the model meta data cannot be retrieved.

restore

public static NMFModel restore(Connection dmsConn,
                               java.lang.String modelName)
                                             throws java.sql.SQLException,
MiningObjectException,
InvalidArgumentException,
ODMException

Returns the specified NMFModel and populates the complex model object for reading by a user program.

Parameters:

dmsConn - The connection to the DMS

modelName - Name of the model to retrieve

Returns:

NMFModel

Throws:

InvalidArgumentException - when the dmsConn/modelName is null.

MiningObjectException - when the model cannot be opened.

java.sql.SQLException - when the model meta data cannot be retrieved.

ODMException

apply

public static void apply(Connection dmsConn,
LocationAccessData applyData,
PhysicalDataSpecification pds,
                         java.lang.String modelName,
MiningApplyOutput applyOutput,
LocationAccessData outputLoc,
                         java.lang.String applyResultName)
                  throws InvalidArgumentException,
                         java.sql.SQLException,
ODMException

InvalidArgumentException

java.sql.SQLException

ODMException