oracle.dmt.odm.result
Class ApplyMultipleScoringItem

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.result.ApplyContentItem
              |
              +--oracle.dmt.odm.result.ApplyMultipleScoringItem

All Implemented Interfaces:

java.io.Serializable

public class ApplyMultipleScoringItem

extends ApplyContentItem

An instance of ApplyMultipleScoringItem is an element to construct a MiningApplyOutput object that is used as specification of the apply output. This object specifies the top/bottom n target score values (whose probabilities are highest/lowest, respectively). The target category is specified in terms of its rank, which is computed from the relative position with regard to its probability (with 1 being the highest). Two columns may appear in the apply output table for each prediction, one being the required prediction column and the other being the optional probability column.

Since:

9.2.0

See Also:

MiningApplyOutput, Serialized Form

Constructor Summary

ApplyMultipleScoringItem(Attribute predAttr, Attribute probAttr)
Creates an instance of ApplyMultipleScoringItem object with all score/probability pairs and the destination columns to appear in the apply output table.

ApplyMultipleScoringItem(Attribute predAttr, Attribute probAttr, int nPairs)
Creates an instance of ApplyMultipleScoringItem object with the number of top n score/probability pairs and the destination columns to appear in the apply output table.

ApplyMultipleScoringItem(Attribute predAttr, Attribute probAttr, int nPairs, boolean useTop)
Creates an instance of ApplyMultipleScoringItem with the number of score/probability pairs to be predicted, the destination columns to appear in the output table, and the indicator as to whether to choose from the top or the bottom.

Method Summary

Attribute	getPredictionAttribute() Returns the attribute to appear in the apply output table as prediction column.
Attribute	getProbabilityAttribute() Returns the attribute to appear in the apply output table as a probability column.
int	getScoreProbPairs() Returns the number of score/probability pairs to be scored for each input record.
boolean	getUseTop() Returns the indicator as to whether to choose from the top or bottom of the ranks.

Methods inherited from class oracle.dmt.odm.result.ApplyContentItem

getDestinationAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyMultipleScoringItem

public ApplyMultipleScoringItem(Attribute predAttr,
Attribute probAttr,
                                int nPairs,
                                boolean useTop)
                         throws InvalidArgumentException

Creates an instance of ApplyMultipleScoringItem with the number of score/probability pairs to be predicted, the destination columns to appear in the output table, and the indicator as to whether to choose from the top or the bottom.

Parameters:

predAttr - The details of the prediction column to appear in the apply output table

probAttr - The details of the probability column in the apply output table

nPairs - The number of score/probability pairs to be scored for each input record

useTop - Specifies whether to choose from the top, if true, or bottom, if false

Throws:

InvalidArgumentException -

• predAttr or probAttr is null,
• the column name in predAttr is invalid,
• the column names are the same in predAttr and probAttr, or
• nPairs is not a positive integer.

ApplyMultipleScoringItem

public ApplyMultipleScoringItem(Attribute predAttr,
Attribute probAttr,
                                int nPairs)
                         throws InvalidArgumentException

Creates an instance of ApplyMultipleScoringItem object with the number of top n score/probability pairs and the destination columns to appear in the apply output table.

Parameters:

predAttr - The details of the prediction column to appear in the apply output table

probAttr - The details of the probability column to appear in the output table

nPairs - The number of score/probability pairs to be scored for each input record

Throws:

InvalidArgumentException -

• predAttr or probAttr is null,
• the column name in predAttr is invalid,
• the column names are the same in predAttr and probAttr, or
• nPairs is not a positive integer.

ApplyMultipleScoringItem

public ApplyMultipleScoringItem(Attribute predAttr,
Attribute probAttr)
                         throws InvalidArgumentException

Creates an instance of ApplyMultipleScoringItem object with all score/probability pairs and the destination columns to appear in the apply output table.

Parameters:

predAttr - The details of the prediction column to appear in the apply output table

probAttr - The details of the probability column to appear in the output table

Throws:

InvalidArgumentException -

• predAttr or probAttr is null,
• the column name in predAttr is invalid, or
• the column names are the same in predAttr and probAttr

Method Detail

getScoreProbPairs

public int getScoreProbPairs()

Returns the number of score/probability pairs to be scored for each input record.

Returns:

int - The number of score/probability pairs to be predicted

getPredictionAttribute

public Attribute getPredictionAttribute()

Returns the attribute to appear in the apply output table as prediction column.

Returns:

Attribute - The attribute that describes the prediction column

getProbabilityAttribute

public Attribute getProbabilityAttribute()

Returns the attribute to appear in the apply output table as a probability column.

Returns:

Attribute - The attribute that describes the probability column

getUseTop

public boolean getUseTop()

Returns the indicator as to whether to choose from the top or bottom of the ranks.

Returns:

boolean - The indicator to choose from the top (if true) or bottom (if false)