weka.classifiers.sklearn

Enum ScikitLearnClassifier.Learner

java.lang.Object

java.lang.Enum<ScikitLearnClassifier.Learner>

weka.classifiers.sklearn.ScikitLearnClassifier.Learner

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScikitLearnClassifier.Learner>

Enclosing class:

ScikitLearnClassifier

public static enum ScikitLearnClassifier.Learner
extends java.lang.Enum<ScikitLearnClassifier.Learner>

Holds info on the different learners available

Enum Constant Summary

Enum Constants

Enum Constant and Description
AdaBoostClassifier
AdaBoostRegressor
ARDRegression
BaggingClassifier
BaggingRegressor
BayesianRidge
BernoulliNB
DecisionTreeClassifier
DecisionTreeRegressor
ElasticNet
ExtraTreeClassifier
ExtraTreeRegressor
GaussianNB
GaussianProcess
GradientBoostingClassifier
GradientBoostingRegressor
KernelRidge
KNeighborsClassifier
KNeighborsRegressor
Lars
LarsCV
Lasso
LassoCV
LassoLars
LassoLarsCV
LassoLarsIC
LDA
LinearRegression
LinearSVC
LogisticRegression
LogisticRegressionCV
MLPClassifier
MLPRegressor
MultinomialNB
NuSVC
NuSVR
OrthogonalMatchingPursuit
OrthogonalMatchingPursuitCV
PassiveAggressiveClassifier
PassiveAggressiveRegressor
Perceptron
QDA
RadiusNeighborsClassifier
RadiusNeighborsRegressor
RandomForestClassifier
RandomForestRegressor
RANSACRegressor
Ridge
RidgeClassifier
RidgeClassifierCV
RidgeCV
SGDClassifier
SGDRegressor
SVC
SVR
TheilSenRegressor
XGBClassifier
XGBRegressor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultParameters() Get the default settings for parameters for this scheme
java.lang.String	getModule() Get the scikit-learn module of this scheme
boolean	isClassifier() Return true if this scheme is a classifier
boolean	isRegressor() Return true if this scheme is a regressor
boolean	producesProbabilities(java.lang.String params) Default implementation of producesProbabilities given parameter settings.
boolean	removeModelFromPythonPostTrainPredict() Return true if the variable containing the model in python should be cleared after training and each batch prediction operation.
static ScikitLearnClassifier.Learner	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScikitLearnClassifier.Learner[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DecisionTreeClassifier

public static final ScikitLearnClassifier.Learner DecisionTreeClassifier

DecisionTreeRegressor

public static final ScikitLearnClassifier.Learner DecisionTreeRegressor

GaussianNB

public static final ScikitLearnClassifier.Learner GaussianNB

MultinomialNB

public static final ScikitLearnClassifier.Learner MultinomialNB

BernoulliNB

public static final ScikitLearnClassifier.Learner BernoulliNB

LDA

public static final ScikitLearnClassifier.Learner LDA

QDA

public static final ScikitLearnClassifier.Learner QDA

LogisticRegression

public static final ScikitLearnClassifier.Learner LogisticRegression

LogisticRegressionCV

public static final ScikitLearnClassifier.Learner LogisticRegressionCV

LinearRegression

public static final ScikitLearnClassifier.Learner LinearRegression

ARDRegression

public static final ScikitLearnClassifier.Learner ARDRegression

BayesianRidge

public static final ScikitLearnClassifier.Learner BayesianRidge

ElasticNet

public static final ScikitLearnClassifier.Learner ElasticNet

Lars

public static final ScikitLearnClassifier.Learner Lars

LarsCV

public static final ScikitLearnClassifier.Learner LarsCV

Lasso

public static final ScikitLearnClassifier.Learner Lasso

LassoCV

public static final ScikitLearnClassifier.Learner LassoCV

LassoLars

public static final ScikitLearnClassifier.Learner LassoLars

LassoLarsCV

public static final ScikitLearnClassifier.Learner LassoLarsCV

LassoLarsIC

public static final ScikitLearnClassifier.Learner LassoLarsIC

MLPClassifier

public static final ScikitLearnClassifier.Learner MLPClassifier

MLPRegressor

public static final ScikitLearnClassifier.Learner MLPRegressor

OrthogonalMatchingPursuit

public static final ScikitLearnClassifier.Learner OrthogonalMatchingPursuit

OrthogonalMatchingPursuitCV

public static final ScikitLearnClassifier.Learner OrthogonalMatchingPursuitCV

PassiveAggressiveClassifier

public static final ScikitLearnClassifier.Learner PassiveAggressiveClassifier

PassiveAggressiveRegressor

public static final ScikitLearnClassifier.Learner PassiveAggressiveRegressor

Perceptron

public static final ScikitLearnClassifier.Learner Perceptron

RANSACRegressor

public static final ScikitLearnClassifier.Learner RANSACRegressor

Ridge

public static final ScikitLearnClassifier.Learner Ridge

RidgeClassifier

public static final ScikitLearnClassifier.Learner RidgeClassifier

RidgeClassifierCV

public static final ScikitLearnClassifier.Learner RidgeClassifierCV

RidgeCV

public static final ScikitLearnClassifier.Learner RidgeCV

SGDClassifier

public static final ScikitLearnClassifier.Learner SGDClassifier

SGDRegressor

public static final ScikitLearnClassifier.Learner SGDRegressor

TheilSenRegressor

public static final ScikitLearnClassifier.Learner TheilSenRegressor

GaussianProcess

public static final ScikitLearnClassifier.Learner GaussianProcess

KernelRidge

public static final ScikitLearnClassifier.Learner KernelRidge

KNeighborsClassifier

public static final ScikitLearnClassifier.Learner KNeighborsClassifier

RadiusNeighborsClassifier

public static final ScikitLearnClassifier.Learner RadiusNeighborsClassifier

KNeighborsRegressor

public static final ScikitLearnClassifier.Learner KNeighborsRegressor

RadiusNeighborsRegressor

public static final ScikitLearnClassifier.Learner RadiusNeighborsRegressor

SVC

public static final ScikitLearnClassifier.Learner SVC

LinearSVC

public static final ScikitLearnClassifier.Learner LinearSVC

NuSVC

public static final ScikitLearnClassifier.Learner NuSVC

SVR

public static final ScikitLearnClassifier.Learner SVR

NuSVR

public static final ScikitLearnClassifier.Learner NuSVR

AdaBoostClassifier

public static final ScikitLearnClassifier.Learner AdaBoostClassifier

AdaBoostRegressor

public static final ScikitLearnClassifier.Learner AdaBoostRegressor

BaggingClassifier

public static final ScikitLearnClassifier.Learner BaggingClassifier

BaggingRegressor

public static final ScikitLearnClassifier.Learner BaggingRegressor

ExtraTreeClassifier

public static final ScikitLearnClassifier.Learner ExtraTreeClassifier

ExtraTreeRegressor

public static final ScikitLearnClassifier.Learner ExtraTreeRegressor

GradientBoostingClassifier

public static final ScikitLearnClassifier.Learner GradientBoostingClassifier

GradientBoostingRegressor

public static final ScikitLearnClassifier.Learner GradientBoostingRegressor

RandomForestClassifier

public static final ScikitLearnClassifier.Learner RandomForestClassifier

RandomForestRegressor

public static final ScikitLearnClassifier.Learner RandomForestRegressor

XGBClassifier

public static final ScikitLearnClassifier.Learner XGBClassifier

XGBRegressor

public static final ScikitLearnClassifier.Learner XGBRegressor

Method Detail

values

public static ScikitLearnClassifier.Learner[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScikitLearnClassifier.Learner c : ScikitLearnClassifier.Learner.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScikitLearnClassifier.Learner valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getModule

public java.lang.String getModule()

Get the scikit-learn module of this scheme

Returns:

the scikit-learn module of this scheme

producesProbabilities

public boolean producesProbabilities(java.lang.String params)

Default implementation of producesProbabilities given parameter settings. Specific enum values can override if there are specific parameter settings where probabilities can or can't be produced

Parameters:

params - the current parameter settings for the scheme

Returns:

true if probabilities can be produced given the parameter settings

removeModelFromPythonPostTrainPredict

public boolean removeModelFromPythonPostTrainPredict()

Return true if the variable containing the model in python should be cleared after training and each batch prediction operation. This can be advantageous for specific methods that might either consume lots of host memory or device (e.g. GPU) memory. The disadvantage is that the model will need to be transferred into python prior to each batch prediction call (cross-validation will be slower).

Returns:

true if the model variable should be cleared in python

isClassifier

public boolean isClassifier()

Return true if this scheme is a classifier

Returns:

true if this scheme is a classifier

isRegressor

public boolean isRegressor()

Return true if this scheme is a regressor

Returns:

true if this scheme is a regressor

getDefaultParameters

public java.lang.String getDefaultParameters()

Get the default settings for parameters for this scheme

Returns:

the default parameter settings of this scheme