com.datumbox.framework.core.machinelearning.common.abstracts

Class AbstractTrainer<MP extends AbstractTrainer.AbstractModelParameters,TP extends AbstractTrainer.AbstractTrainingParameters>

java.lang.Object

com.datumbox.framework.core.machinelearning.common.abstracts.AbstractTrainer<MP,TP>

Type Parameters:

MP -

TP -

All Implemented Interfaces:

Savable, Trainable<MP,TP>, java.lang.AutoCloseable

Direct Known Subclasses:

AbstractFeatureSelector, AbstractModeler, AbstractTransformer

public abstract class AbstractTrainer<MP extends AbstractTrainer.AbstractModelParameters,TP extends AbstractTrainer.AbstractTrainingParameters>
extends java.lang.Object
implements Trainable<MP,TP>

Base class for every Trainable Algorithm of the Framework. This includes Machine Learning Models, Data Transformers, Feature Selectors etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTrainer.AbstractModelParameters Base class for every ModelParameter class in the framework.
static class	AbstractTrainer.AbstractTrainingParameters The AbstractTrainingParameters class stores the parameters that can be changed before training the algorithm.

Method Summary

Modifier and Type	Method and Description
void	close()
void	delete() Deletes the data of the object.
void	fit(Dataframe trainingData) Trains a model using the provided training parameters and data.
MP	getModelParameters() Returns the model parameters that were estimated after training.
TP	getTrainingParameters() It returns the training parameters that configure the algorithm.
void	save(java.lang.String storageName) Saves the data of the object.

Methods inherited from class java.lang.Object

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

Method Detail

getModelParameters

public MP getModelParameters()

Returns the model parameters that were estimated after training.

Specified by:

getModelParameters in interface Trainable<MP extends AbstractTrainer.AbstractModelParameters,TP extends AbstractTrainer.AbstractTrainingParameters>

Returns:

getTrainingParameters

public TP getTrainingParameters()

It returns the training parameters that configure the algorithm.

Specified by:

getTrainingParameters in interface Trainable<MP extends AbstractTrainer.AbstractModelParameters,TP extends AbstractTrainer.AbstractTrainingParameters>

Returns:

fit

public void fit(Dataframe trainingData)

Trains a model using the provided training parameters and data.

Specified by:

fit in interface Trainable<MP extends AbstractTrainer.AbstractModelParameters,TP extends AbstractTrainer.AbstractTrainingParameters>

save

public void save(java.lang.String storageName)

Saves the data of the object.

Specified by:

save in interface Savable

delete

public void delete()

Deletes the data of the object.

Specified by:

delete in interface Savable

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable