CaretAlgorithm (R Feedzai OpenML implementation for Caret 0.2.2 API)

java.lang.Object
- java.lang.Enum<CaretAlgorithm>
- - com.feedzai.openml.caret.CaretAlgorithm

All Implemented Interfaces:

com.feedzai.openml.util.algorithm.MLAlgorithmEnum, Serializable, Comparable<CaretAlgorithm>
```
public enum CaretAlgorithm
extends Enum<CaretAlgorithm>
implements com.feedzai.openml.util.algorithm.MLAlgorithmEnum
```
Specifies the algorithms of the models generated in Caret that are supported by Pulse to be imported.

Since:

0.1.0

Author:

Paulo Pereira (paulo.pereira@feedzai.com)

See Also:

https://topepo.github.io/caret/available-models.html to find more information about the algorithms supported by Caret and how to create models with those algorithms.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADA` Performs discrete, real, and gentle boost under both exponential and logistic loss on a given data set.
`BAM` Generalized additive (mixed) models, some of their extensions and other generalized ridge regression with multiple smoothing parameter estimation by (Restricted) Marginal Likelihood, Generalized Cross Validation and similar.
`CART` Recursive partitioning for classification, regression and survival trees.
`EARTH` Build regression models using the techniques in Friedman's papers "Fast MARS" and "Multivariate Adaptive Regression Splines".
`ELASTICNET` Functions for fitting the entire solution path of the Elastic-Net.
`GBM` An implementation of extensions to Freund and Schapire's AdaBoost algorithm and Friedman's gradient boosting machine.
`GLMBOOST` Functional gradient descent algorithm (boosting) for optimizing general risk functions utilizing component-wise (penalised) least squares estimates or regression trees as base-learners for fitting generalized linear models to potentially high-dimensional data.
`MDA` Mixture and flexible discriminant analysis.
`NNET` Software for feed-forward neural networks with a single hidden layer, and for multinomial log-linear models.
`PAM` Computes a nearest shrunken centroid for gene expression (microarray) data.
`PLS` Multivariate regression methods Partial Least Squares Regression (PLSR), Principal Component Regression (PCR) and Canonical Powered Partial Least Squares (CPPLS).
`RF` Classification and regression based on a forest of trees using random inputs, based on Breiman (2001).
`SVMLK` An implementation of Support Vector Machines based in Kernel machine learning methods.

Field Summary
- Fields inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum
  logger

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.feedzai.openml.provider.descriptor.MLAlgorithmDescriptor`	`getAlgorithmDescriptor()`
`static CaretAlgorithm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CaretAlgorithm[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum
createDescriptor, getByName, getDescriptors, getName

- Enum Constant Detail
  - GBM
```
public static final CaretAlgorithm GBM
```
    An implementation of extensions to Freund and Schapire's AdaBoost algorithm and Friedman's gradient boosting machine.
  - PLS
```
public static final CaretAlgorithm PLS
```
    Multivariate regression methods Partial Least Squares Regression (PLSR), Principal Component Regression (PCR) and Canonical Powered Partial Least Squares (CPPLS).
  - CART
```
public static final CaretAlgorithm CART
```
    Recursive partitioning for classification, regression and survival trees. An implementation of most of the functionality of the 1984 book by Breiman, Friedman, Olshen and Stone.
  - PAM
```
public static final CaretAlgorithm PAM
```
    Computes a nearest shrunken centroid for gene expression (microarray) data.
  - RF
```
public static final CaretAlgorithm RF
```
    Classification and regression based on a forest of trees using random inputs, based on Breiman (2001).
  - MDA
```
public static final CaretAlgorithm MDA
```
    Mixture and flexible discriminant analysis.
  - BAM
```
public static final CaretAlgorithm BAM
```
    Generalized additive (mixed) models, some of their extensions and other generalized ridge regression with multiple smoothing parameter estimation by (Restricted) Marginal Likelihood, Generalized Cross Validation and similar.
  - NNET
```
public static final CaretAlgorithm NNET
```
    Software for feed-forward neural networks with a single hidden layer, and for multinomial log-linear models.
  - GLMBOOST
```
public static final CaretAlgorithm GLMBOOST
```
    Functional gradient descent algorithm (boosting) for optimizing general risk functions utilizing component-wise (penalised) least squares estimates or regression trees as base-learners for fitting generalized linear models to potentially high-dimensional data.
  - EARTH
```
public static final CaretAlgorithm EARTH
```
    Build regression models using the techniques in Friedman's papers "Fast MARS" and "Multivariate Adaptive Regression Splines".
  - ADA
```
public static final CaretAlgorithm ADA
```
    Performs discrete, real, and gentle boost under both exponential and logistic loss on a given data set.
  - SVMLK
```
public static final CaretAlgorithm SVMLK
```
    An implementation of Support Vector Machines based in Kernel machine learning methods.
  - ELASTICNET
```
public static final CaretAlgorithm ELASTICNET
```
    Functions for fitting the entire solution path of the Elastic-Net.
- Method Detail
  - values
```
public static CaretAlgorithm[] 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 (CaretAlgorithm c : CaretAlgorithm.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CaretAlgorithm valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getAlgorithmDescriptor
```
public com.feedzai.openml.provider.descriptor.MLAlgorithmDescriptor getAlgorithmDescriptor()
```
    Specified by:
    
    getAlgorithmDescriptor in interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum

Enum CaretAlgorithm

Enum Constant Summary

Field Summary

Fields inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum

Enum Constant Detail

GBM

PLS

CART

PAM

RF

MDA

BAM

NNET

GLMBOOST

EARTH

ADA

SVMLK

ELASTICNET

Method Detail

values

valueOf

getAlgorithmDescriptor