ATimeSeriesClassificationModel (jaicore-ml 0.2.1 API)

java.lang.Object
- ai.libs.jaicore.ml.core.learner.ASupervisedLearner<ITimeSeriesInstance,D,org.api4.java.ai.ml.classification.singlelabel.evaluation.ISingleLabelClassification,org.api4.java.ai.ml.classification.singlelabel.evaluation.ISingleLabelClassificationPredictionBatch>
- - ai.libs.jaicore.ml.classification.singlelabel.timeseries.learner.ATimeSeriesClassificationModel<L,D>

Type Parameters:

L - The attribute type of the target.

V - The value type of the target attribute.

D - The type of the time series data set used to learn from and predict batches.

All Implemented Interfaces:

org.api4.java.ai.ml.core.learner.IFittable<ITimeSeriesInstance,D>, org.api4.java.ai.ml.core.learner.IFittablePredictor<ITimeSeriesInstance,D>, org.api4.java.ai.ml.core.learner.ILearnerConfigHandler, org.api4.java.ai.ml.core.learner.IPredictor<ITimeSeriesInstance,D>, org.api4.java.ai.ml.core.learner.ISupervisedLearner<ITimeSeriesInstance,D>
```
public abstract class ATimeSeriesClassificationModel<L,D extends TimeSeriesDataset>
extends ASupervisedLearner<ITimeSeriesInstance,D,org.api4.java.ai.ml.classification.singlelabel.evaluation.ISingleLabelClassification,org.api4.java.ai.ml.classification.singlelabel.evaluation.ISingleLabelClassificationPredictionBatch>
```
Time series classifier which can be trained and used as a predictor. Uses algorithm to train the model parameters (if necessary).

Field Summary

Fields
Modifier and Type	Field	Description
`protected ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>>`	`algorithm`	The algorithm object used for the training of the classifier.

Constructor Summary

Constructors
Constructor	Description
`ATimeSeriesClassificationModel(ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>> algorithm)`	Constructor for a time series classifier.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`fit(D dataset)`	{@inheritDoc ABatchLearner#train(jaicore.ml.core.dataset.IDataset)}
`ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>>`	`getAlgorithm()`	Getter for the model's training algorithm object.
`void`	`setAlgorithm(ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>> algorithm)`	Sets the training algorithm for the classifier.

Methods inherited from class ai.libs.jaicore.ml.core.learner.ASupervisedLearner
fitAndPredict, fitAndPredict, fitAndPredict, getConfig, predict, predict, predict, setConfig

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - algorithm
```
protected ATSCAlgorithm<L,D extends TimeSeriesDataset,? extends ATimeSeriesClassificationModel<L,D extends TimeSeriesDataset>> algorithm
```
    The algorithm object used for the training of the classifier.
- Constructor Detail
  - ATimeSeriesClassificationModel
```
public ATimeSeriesClassificationModel(ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>> algorithm)
```
    Constructor for a time series classifier.
    
    Parameters:
    
    algorithm - The algorithm object used for the training of the classifier
- Method Detail
  - fit
```
public void fit(D dataset)
         throws org.api4.java.ai.ml.core.exception.TrainingException
```
    {@inheritDoc ABatchLearner#train(jaicore.ml.core.dataset.IDataset)}
    
    Throws:
    
    org.api4.java.ai.ml.core.exception.TrainingException
  - getAlgorithm
```
public ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>> getAlgorithm()
```
    Getter for the model's training algorithm object.
    
    Returns:
    
    The model's training algorithm
  - setAlgorithm
```
public void setAlgorithm(ATSCAlgorithm<L,D,? extends ATimeSeriesClassificationModel<L,D>> algorithm)
```
    Sets the training algorithm for the classifier.
    
    Parameters:
    
    algorithm - The algorithm object used to maintain the model's parameters.