Skip navigation links

Oracle Data Mining Java API Reference
11g Release 2 (11.2)

E12219-01


oracle.dmt.jdm.algorithm.glm
Interface OraGLMSettings

All Superinterfaces:
javax.datamining.base.AlgorithmSettings, javax.datamining.supervised.SupervisedAlgorithmSettings
All Known Subinterfaces:
OraGLMClassificationSettings, OraGLMRegressionSettings

public interface OraGLMSettings
extends javax.datamining.supervised.SupervisedAlgorithmSettings

OraGLMSettings is the super interface for GLM classification and regression algorithm settings interface. It defines the common GLM setting, that includes:

Since:
OJDM 11.1.0

Field Summary
static java.lang.String TREAT_MISSING_VALUE_AS_CASE_EXCLUSION
          Constant used to specify missing values are treated by excluding the whole case when any of the model singature attribute values are missing.
static java.lang.String TREAT_MISSING_VALUE_AS_MEAN_OR_MODE
          Constant used to specify missing values are treated using the mean value for numerical attributes and mode value for categorical attributes.

 

Method Summary
 double getConfidenceLevel()
          Returns the specified confidence level for coefficient bounds.
 java.lang.String getDiagnosticsTableName()
          Returns the specified diagnostics table name.
 java.lang.String getMissingValueTreatmentType()
          Returns the missing value treatment type.
 java.lang.Double getRidgeValue()
          Returns the user specified ridge value.
 void setConfidenceLevel(double confidenceLevel)
          Sets confidence level for coefficient bounds.
 void setDiagnosticsTableName(java.lang.String diagnosticsTableName)
          Sets the optional row diagnostics table name.
 void setMissingValueTreatmentType(java.lang.String treatmentType)
          Set the missing value treatment type.
 void setRidgeValue(java.lang.Double ridgeVal)
          Sets the user specified ridge value.
 java.lang.Boolean useRidgeRegression()
          Returns true when ridge regression is enabled.
 void useRidgeRegression(java.lang.Boolean enableRidgeRegression)
          Enables ridge regression when it is set to true.

 

Methods inherited from interface javax.datamining.base.AlgorithmSettings
getMiningAlgorithm, verify

 

Field Detail

TREAT_MISSING_VALUE_AS_MEAN_OR_MODE

public static final java.lang.String TREAT_MISSING_VALUE_AS_MEAN_OR_MODE
Constant used to specify missing values are treated using the mean value for numerical attributes and mode value for categorical attributes.
See Also:
Constant Field Values

TREAT_MISSING_VALUE_AS_CASE_EXCLUSION

public static final java.lang.String TREAT_MISSING_VALUE_AS_CASE_EXCLUSION
Constant used to specify missing values are treated by excluding the whole case when any of the model singature attribute values are missing.
See Also:
Constant Field Values

Method Detail

useRidgeRegression

public java.lang.Boolean useRidgeRegression()
Returns true when ridge regression is enabled. Otherwise returns false. Returns null when the system determines the ridge regression to be enabled or disabled.
Returns:

useRidgeRegression

public void useRidgeRegression(java.lang.Boolean enableRidgeRegression)
Enables ridge regression when it is set to true. Otherwise ridge regression is diabled. When specified as null system determines whether to enable/disable ridge regression.
Parameters:
enableRidgeRegression -

getRidgeValue

public java.lang.Double getRidgeValue()
Returns the user specified ridge value. Returns null when the ridge value is set to be determined by the algorithm implemenation.

setRidgeValue

public void setRidgeValue(java.lang.Double ridgeVal)
Sets the user specified ridge value. When specified as a not-null value then ridge regression is implicitely enabled. When specified as a null value then the algorithm implementation will determine the ridge value.
Parameters:
ridgeVal -

setConfidenceLevel

public void setConfidenceLevel(double confidenceLevel)
Sets confidence level for coefficient bounds. By default it is pre-set to 0.95.
Parameters:
confidenceLevel - valid value is greater than 0 and less than 1

getConfidenceLevel

public double getConfidenceLevel()
Returns the specified confidence level for coefficient bounds.
Returns:

setDiagnosticsTableName

public void setDiagnosticsTableName(java.lang.String diagnosticsTableName)
Sets the optional row diagnostics table name. When diagnostics table is not specified, algorithm do not create this table.
Parameters:
diagnosticsTableName -

getDiagnosticsTableName

public java.lang.String getDiagnosticsTableName()
Returns the specified diagnostics table name.
Returns:

setMissingValueTreatmentType

public void setMissingValueTreatmentType(java.lang.String treatmentType)
Set the missing value treatment type. There are two types of missing value treatments allowed:

By default mean or mode value settings are used.

getMissingValueTreatmentType

public java.lang.String getMissingValueTreatmentType()
Returns the missing value treatment type.
Returns:

Skip navigation links

Oracle Data Mining Java API Reference
11g Release 2 (11.2)

E12219-01


Copyright © 2005, 2009 Oracle. All rights reserved.