|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dmt.odm.MiningObject | +--oracle.dmt.odm.LocatableObject | +--oracle.dmt.odm.model.MiningModel | +--oracle.dmt.odm.model.AttributeImportanceModel
The abstract class AttributeImportanceModel
is a Java representation of
the attribute importance model.
This class provides methods to access a set of attributes based on their
respective importance within the model such as Other statistical metadata.
Attribute Importance is used to select the relevant and important attributes
from a build dataset. For ODM 9.2.0, the AttributeImportanceModel
is applicable to supervised mining models, and provides an assessment of attribute
usefulness. It assigns an importance value and rank to each of the active
attributes used for building supervised models. From this ranking, the user
can select a subset of important attributes from the complete set of active
attributes. The attribute and the corresponding attribute importance value
and the rank are stored as a database table.
Method Summary |
Type | Method |
---|---|
AttributeImportanceEntry[] |
getAttributeImportanceEntries()
Returns all AttributeImportanceEntry objects in the model, each of
which contains an attribute name, its importance value, and its rank. |
java.lang.String |
getAttributeImportanceTableName()
Returns the table name where each row contains an attribute name, its importance value, and its rank. |
static java.lang.String |
getAttributeImportanceTableName(Connection dmsConn,
java.lang.String modelName)
Returns the table name where each row contains a attribute name, its importance value, and its rank. |
java.lang.String[] |
getAttributes(AttributeImportanceEntry[] entries)
Returns an array of attribute names that correspond to the specified array of AttributeImportanceEntry objects |
static java.lang.String[] |
getAttributesByImportance(Connection dmsConn,
java.lang.String modelName,
float threshold,
boolean aboveThreshold)
Returns an array of attribute names based on the threshold specified for attribute importance value, given the connection to the data mining server and the model name. |
static java.lang.String[] |
getAttributesByImportance(Connection dmsConn,
java.lang.String modelName,
float lowerBound,
float upperBound)
Returns an array of attribute names whose importance values fall in the specified range, given the connection to the data mining server and the model name. |
static java.lang.String[] |
getAttributesByPercentage(Connection dmsConn,
java.lang.String modelName,
float percentage,
boolean aboveThreshold)
Returns an array of attribute names whose importance ranks fall in the specified percentile, given the connection to the data mining server and the model name. |
static java.lang.String[] |
getAttributesByRank(Connection dmsConn,
java.lang.String modelName,
int rank,
boolean aboveThreshold)
Returns an array of attribute names based on the threshold specified for attribute importance rank, given the connection to the data mining server and the model name. |
static java.lang.String[] |
getAttributesByRank(Connection dmsConn,
java.lang.String modelName,
int lowerBoundRank,
int upperBoundRank)
Returns an array of attribute names whose importance ranks fall in the specified range, given the connection to the data mining server and the model name. |
static AttributeImportanceEntry[] |
getAttributeSetByImportance(Connection dmsConn,
java.lang.String modelName,
float threshold,
boolean aboveThreshold)
Returns an array of AttributeImportanceEntry objects based on
the threshold specified for attribute importance value, given the connection
to the data mining server and the model name. |
static AttributeImportanceEntry[] |
getAttributeSetByPercentage(Connection dmsConn,
java.lang.String modelName,
float percentage,
boolean aboveThreshold)
Returns an array of attribute importance entries whose importance ranks fall in the specified percentile, given the connection to the data mining server and the model name. |
static AttributeImportanceEntry[] |
getAttributeSetByRank(Connection dmsConn,
java.lang.String modelName,
int rank,
boolean aboveThreshold)
Returns an array of attribute importance entries based on the threshold specified for attribute importance rank, given the connection to the data mining server and the model name. |
static AttributeImportanceModel |
restore(Connection dmsConn,
java.lang.String modelName)
Returns an instance of AttributeImportanceModel with the specified
name persisted in the data mining server
given a connection to the data mining server and the model name. |
Methods inherited from class oracle.dmt.odm.model.MiningModel |
build, getBinCategoricalTableName, getBinNumericTableName, getMiningAlgorithm, getMiningFunction, getMiningFunctionSettings, getModelName, listContents, listContents, listContents, listContents, remove, setModelNameForMig |
Methods inherited from class oracle.dmt.odm.LocatableObject |
deserialize, serialize |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public AttributeImportanceEntry[] getAttributeImportanceEntries()
AttributeImportanceEntry
objects in the model, each of
which contains an attribute name, its importance value, and its rank.AttributeImportanceEntry[]
- An array of
AttributeImportanceEntry
objectspublic java.lang.String getAttributeImportanceTableName()
String
- The name of the tablepublic static java.lang.String getAttributeImportanceTableName(Connection dmsConn, java.lang.String modelName) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedString
- The name of the model tableSQLException
- - InvalidArgumentException
- modelName
is null dmsConn
is nullMiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static AttributeImportanceEntry[] getAttributeSetByImportance(Connection dmsConn, java.lang.String modelName, float threshold, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
AttributeImportanceEntry
objects based on
the threshold specified for attribute importance value, given the connection
to the data mining server and the model name.
The valid value for the threshold ranges between 0 and 1.
For example, list attributes importance entries with importance values above 0.01.
- threshold = 0.01, aboveThrshold
= true
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedthreshold
- The value for attribute importance valueaboveThreshold
- Returns an array of entries whose importance values are
above threashold
value if true, or returns an array
of entries whose importance values are below threshold
if false.AttributeImportanceEntry[]
- An array of
AttributeImportanceEntry
that meet the specified creteria.SQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null threshold
is less than 0 threshold
is greater than 1MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static java.lang.String[] getAttributesByImportance(Connection dmsConn, java.lang.String modelName, float threshold, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list attributes with importance value above 0.01:
- threshold = 0.01, aboveThrshold
= true
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedthreshold
- The value for attribute importance valueaboveThreshold
- Returns an array of attribute names whose importance values are
above threashold
value if true, or returns an array
of attribute names whose importance values are below threshold
if false.String[]
- An array of attribute names that meet the specified criteria
- SQLException
InvalidArgumentException
- modelName
is null dmsConn
is null threshold
is less than 0 threshold
is greater than 1MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static java.lang.String[] getAttributesByImportance(Connection dmsConn, java.lang.String modelName, float lowerBound, float upperBound) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list attributes with importance value between 0.01 and 0.02:
- lowerBound = 0.01, upperBound = 0.02
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedlowerBound
- The lower bound of the thresholdupperBound
- The upper bound for the thresholdString[]
- An array of attribute names that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null lowerBound
is less than 0 lowerBound
is greater than 1 upperBound
is less than 0 upperBound
is greater than 1 lowerBound
is greater than upperBound
MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static AttributeImportanceEntry[] getAttributeSetByRank(Connection dmsConn, java.lang.String modelName, int rank, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list attribute Importance Entries where rank >= 5:
- threshold = 5, aboveThreshold
= true
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedthreshold
- The value for attribute importance rankaboveThreshold
- Returns an array of entries whose importance ranks are
above rank
value if true, or returns an array
of entries whose importance ranks are below rank
if false.AttributeImportanceEntry[]
- An array of attribute importance entries
that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null rank
is less than 1 MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static java.lang.String[] getAttributesByRank(Connection dmsConn, java.lang.String modelName, int rank, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list attributes where rank >= 5 ordered by rank:
- threshold = 5, aboveThreshold
= true
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedthreshold
- The value for attribute importance rankaboveThreshold
- Returns an array of entries whose importance ranks are
above rank
value if true, or returns an array
of entries whose importance ranks are below rank
if false.String[]
- An array of attribute names
that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null rank
is less than 1 MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static java.lang.String[] getAttributesByRank(Connection dmsConn, java.lang.String modelName, int lowerBoundRank, int upperBoundRank) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list attributes with rank between 3 and 6:
- lowerBound
= 3, upperBound
= 6
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedlowerBound
- The lower bound of the ranksupperBound
- The upper bound for the ranksString[]
- An array of attribute names that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null lowerBound
is less than 1 upperBound
is less than 1 lowerBound
is greater than or
equal to upperBound
MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static AttributeImportanceEntry[] getAttributeSetByPercentage(Connection dmsConn, java.lang.String modelName, float percentage, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list the attributes importance entries whose rank >= (10% total number of attributes)
- percentage
= 0.1,
aboveThreshold
= false
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedpercentage
- The value for percentage of attributesaboveThreshold
- Returns an array of entries whose importance ranks are
within the top percentage
% if true, or returns an array
of entries whose importance ranks are within the bottom percentage
%
if false.AttributeImportanceEntry[]
- An array of attribute importance entries
that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null percentage
is less than 0, or percentage
is greater than 1.MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic static java.lang.String[] getAttributesByPercentage(Connection dmsConn, java.lang.String modelName, float percentage, boolean aboveThreshold) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
For example, list the attributes names whose rank >= (10% total number of attributes)
- percentage
= 0.1,
aboveThreshold
= false
dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the table name is retrievedpercentage
- The value for percentage of attributesaboveThreshold
- Returns an array of attribute names whose importance ranks are
within the top percentage
% if true, or returns an array
of attribute names whose importance ranks are within the bottom percentage
%
if false.String[]
- An array of attribute importance entries
that meet the specified criteriaSQLException
- InvalidArgumentException
- modelName
is null dmsConn
is null percentage
is less than 0, or percentage
is greater than 1.MiningObjectException
- ODMException
- if modelName
is empty or exceeds
64 characters in lengthpublic java.lang.String[] getAttributes(AttributeImportanceEntry[] entries)
AttributeImportanceEntry
objectsentries
- An array of AttributeImportanceEntry
objectspublic static AttributeImportanceModel restore(Connection dmsConn, java.lang.String modelName) throws java.sql.SQLException, MiningObjectException, InvalidArgumentException, ODMException
AttributeImportanceModel
with the specified
name persisted in the data mining server
given a connection to the data mining server and the model name.dmsConn
- The connection to the data mining servermodelName
- The name of the model to be restoredAttributeImportanceModel
- An instance of AttributeImportanceModel
restoredInvalidArgumentException
- modelName
is null dmsConn
is nullODMException
- when modelName
is empty or exceeds 64 acharacter
in length.
- SQLException
MiningObjectException
- when the restored model is not an instance of
AttributeImportanceModel
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |