public class Logistic extends AbstractClassifier implements OptionHandler, WeightedInstancesHandler, TechnicalInformationHandler, PMMLProducer, Aggregateable<Logistic>
@article{leCessie1992,
author = {le Cessie, S. and van Houwelingen, J.C.},
journal = {Applied Statistics},
number = {1},
pages = {191-201},
title = {Ridge Estimators in Logistic Regression},
volume = {41},
year = {1992}
}
Valid options are:
-D Turn on debugging output.
-R <ridge> Set the ridge in the log-likelihood.
-M <number> Set the maximum number of iterations (default -1, until convergence).
BATCH_SIZE_DEFAULT, NUM_DECIMAL_PLACES_DEFAULT| Constructor and Description |
|---|
Logistic()
Constructor that sets the default number of decimal places to 4.
|
| Modifier and Type | Method and Description |
|---|---|
Logistic |
aggregate(Logistic toAggregate)
Aggregate an object with this one
|
void |
buildClassifier(Instances train)
Builds the classifier
|
double[][] |
coefficients()
Returns the coefficients for this logistic model.
|
java.lang.String |
debugTipText()
Returns the tip text for this property
|
double[] |
distributionForInstance(Instance instance)
Computes the distribution for a given instance
|
void |
finalizeAggregation()
Call to complete the aggregation process.
|
Capabilities |
getCapabilities()
Returns default capabilities of the classifier.
|
boolean |
getDebug()
Gets whether debugging output will be printed.
|
int |
getMaxIts()
Get the value of MaxIts.
|
java.lang.String[] |
getOptions()
Gets the current settings of the classifier.
|
java.lang.String |
getRevision()
Returns the revision string.
|
double |
getRidge()
Gets the ridge in the log-likelihood.
|
TechnicalInformation |
getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed
information about the technical background of this class, e.g., paper
reference or book this class is based on.
|
boolean |
getUseConjugateGradientDescent()
Gets whether to use conjugate gradient descent rather than BFGS updates.
|
java.lang.String |
globalInfo()
Returns a string describing this classifier
|
java.util.Enumeration<Option> |
listOptions()
Returns an enumeration describing the available options
|
static void |
main(java.lang.String[] argv)
Main method for testing this class.
|
java.lang.String |
maxItsTipText()
Returns the tip text for this property
|
java.lang.String |
ridgeTipText()
Returns the tip text for this property
|
void |
setDebug(boolean debug)
Sets whether debugging output will be printed.
|
void |
setMaxIts(int newMaxIts)
Set the value of MaxIts.
|
void |
setOptions(java.lang.String[] options)
Parses a given list of options.
|
void |
setRidge(double ridge)
Sets the ridge in the log-likelihood.
|
void |
setUseConjugateGradientDescent(boolean useConjugateGradientDescent)
Sets whether conjugate gradient descent is used.
|
java.lang.String |
toPMML(Instances train)
Produce a PMML representation of this logistic model
|
java.lang.String |
toString()
Gets a string describing the classifier.
|
java.lang.String |
useConjugateGradientDescentTipText()
Returns the tip text for this property
|
batchSizeTipText, classifyInstance, distributionsForInstances, doNotCheckCapabilitiesTipText, forName, getBatchSize, getDoNotCheckCapabilities, getNumDecimalPlaces, implementsMoreEfficientBatchPrediction, makeCopies, makeCopy, numDecimalPlacesTipText, postExecution, preExecution, run, runClassifier, setBatchSize, setDoNotCheckCapabilities, setNumDecimalPlacespublic Logistic()
public java.lang.String globalInfo()
public TechnicalInformation getTechnicalInformation()
getTechnicalInformation in interface TechnicalInformationHandlerpublic java.util.Enumeration<Option> listOptions()
listOptions in interface OptionHandlerlistOptions in class AbstractClassifierpublic void setOptions(java.lang.String[] options)
throws java.lang.Exception
-D Turn on debugging output.
-R <ridge> Set the ridge in the log-likelihood.
-M <number> Set the maximum number of iterations (default -1, until convergence).
setOptions in interface OptionHandlersetOptions in class AbstractClassifieroptions - the list of options as an array of stringsjava.lang.Exception - if an option is not supportedpublic java.lang.String[] getOptions()
getOptions in interface OptionHandlergetOptions in class AbstractClassifierpublic java.lang.String debugTipText()
debugTipText in class AbstractClassifierpublic void setDebug(boolean debug)
setDebug in class AbstractClassifierdebug - true if debugging output should be printedpublic boolean getDebug()
getDebug in class AbstractClassifierpublic java.lang.String useConjugateGradientDescentTipText()
public void setUseConjugateGradientDescent(boolean useConjugateGradientDescent)
useConjugateGradientDescent - true if CGD is to be used.public boolean getUseConjugateGradientDescent()
public java.lang.String ridgeTipText()
public void setRidge(double ridge)
ridge - the ridgepublic double getRidge()
public java.lang.String maxItsTipText()
public int getMaxIts()
public void setMaxIts(int newMaxIts)
newMaxIts - Value to assign to MaxIts.public Capabilities getCapabilities()
getCapabilities in interface ClassifiergetCapabilities in interface CapabilitiesHandlergetCapabilities in class AbstractClassifierCapabilitiespublic void buildClassifier(Instances train) throws java.lang.Exception
buildClassifier in interface Classifiertrain - the training data to be used for generating the boosted
classifier.java.lang.Exception - if the classifier could not be built successfullypublic double[] distributionForInstance(Instance instance) throws java.lang.Exception
distributionForInstance in interface ClassifierdistributionForInstance in class AbstractClassifierinstance - the instance for which distribution is computedjava.lang.Exception - if the distribution can't be computed successfullypublic double[][] coefficients()
public java.lang.String toString()
toString in class java.lang.Objectpublic java.lang.String getRevision()
getRevision in interface RevisionHandlergetRevision in class AbstractClassifierpublic Logistic aggregate(Logistic toAggregate) throws java.lang.Exception
aggregate in interface Aggregateable<Logistic>toAggregate - the object to aggregatejava.lang.Exception - if the supplied object can't be aggregated for some
reasonpublic void finalizeAggregation()
throws java.lang.Exception
finalizeAggregation in interface Aggregateable<Logistic>java.lang.Exception - if the aggregation can't be finalized for some reasonpublic static void main(java.lang.String[] argv)
argv - should contain the command line arguments to the scheme (see
Evaluation)public java.lang.String toPMML(Instances train)
toPMML in interface PMMLProducertrain - the training data that was used to construct the model