ATSCAlgorithm (jaicore-ml 0.2.0 API)

java.lang.Object
- ai.libs.jaicore.ml.classification.singlelabel.timeseries.learner.ATSCAlgorithm<Y,D,C>

Type Parameters:

Y - The type of the target that the to be trained

V - The value type of the target that the to be trained predicts.

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

C - The time series classifier which is modified and returned as algorithm result.

All Implemented Interfaces:

java.lang.Iterable<org.api4.java.algorithm.events.IAlgorithmEvent>, java.util.concurrent.Callable<C>, java.util.Iterator<org.api4.java.algorithm.events.IAlgorithmEvent>, org.api4.java.algorithm.IAlgorithm<TimeSeriesDataset,C>, org.api4.java.common.control.ICancelable
```
public abstract class ATSCAlgorithm<Y,D extends TimeSeriesDataset,C extends ATimeSeriesClassificationModel<Y,D>>
extends java.lang.Object
implements org.api4.java.algorithm.IAlgorithm<TimeSeriesDataset,C>
```
Abstract algorithm class which is able to take TimeSeriesDataset objects and builds ATimeSeriesClassificationModel instances specified by the generic parameter .

Field Summary

Fields
Modifier and Type	Field	Description
`protected D`	`input`	The `TimeSeriesDataset` object used for maintaining the `model`.
`protected C`	`model`	The model which is maintained during algorithm calls

Constructor Summary

Constructors
Constructor Description

ATSCAlgorithm()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`D`	`getInput()`	Getter for the data set input used during algorithm calls.
`void`	`setInput(D input)`	Setter for the data set input used during algorithm calls.
`<T extends ATimeSeriesClassificationModel<Y,D>> void`	`setModel(T model)`	Setter for the model to be maintained.

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

Methods inherited from interface org.api4.java.algorithm.IAlgorithm
call, getConfig, getId, getNumCPUs, getTimeout, nextWithException, registerListener, setMaxNumThreads, setNumCPUs, setTimeout, setTimeout

Methods inherited from interface org.api4.java.common.control.ICancelable
cancel

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

- Field Detail
  - model
```
protected C extends ATimeSeriesClassificationModel<Y,D> model
```
    The model which is maintained during algorithm calls
  - input
```
protected D extends TimeSeriesDataset input
```
    The TimeSeriesDataset object used for maintaining the model.
- Constructor Detail
  - ATSCAlgorithm
```
public ATSCAlgorithm()
```
- Method Detail
  - setModel
```
public <T extends ATimeSeriesClassificationModel<Y,D>> void setModel(T model)
```
    Setter for the model to be maintained.
    
    Parameters:
    
    model - The ATimeSeriesClassificationModel model which is maintained during algorithm calls.
  - setInput
```
public void setInput(D input)
```
    Setter for the data set input used during algorithm calls.
    
    Parameters:
    
    input - The TimeSeriesDataset object (or a subtype) used for the model maintenance
  - getInput
```
public D getInput()
```
    Getter for the data set input used during algorithm calls.
    
    Specified by:
    
    getInput in interface org.api4.java.algorithm.IAlgorithm<Y,D extends TimeSeriesDataset>