|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TSForecaster
Interface for something that can produce time series predictions.
Method Summary | |
---|---|
void |
buildForecaster(Instances insts,
java.io.PrintStream... progress)
Builds a new forecasting model using the supplied training data. |
java.util.List<java.util.List<NumericPrediction>> |
forecast(int numSteps,
java.io.PrintStream... progress)
Produce a forecast for the target field(s). |
java.lang.String |
getAlgorithmName()
Provides a short name that describes the underlying algorithm in some way. |
java.lang.String |
getFieldsToForecast()
Get the fields to forecast. |
void |
primeForecaster(Instances insts)
Supply the (potentially) trained model with enough historical data, up to and including the current time point, in order to produce a forecast. |
void |
primeForecasterIncremental(Instance inst)
|
void |
reset()
Reset this forecaster so that it is ready to construct a new model. |
void |
runForecaster(TSForecaster forecaster,
java.lang.String[] options)
Run the supplied forecaster with the supplied options on the command line. |
void |
setFieldsToForecast(java.lang.String targets)
Set the names of the fields/attributes in the data to forecast. |
Method Detail |
---|
java.lang.String getAlgorithmName()
void reset()
void setFieldsToForecast(java.lang.String targets) throws java.lang.Exception
targets
- a list of names of fields to forecast
java.lang.Exception
- if a field(s) can't be found, or if multiple
fields are specified and this forecaster can't predict multiple
fields.java.lang.String getFieldsToForecast()
void buildForecaster(Instances insts, java.io.PrintStream... progress) throws java.lang.Exception
insts
- the training instances.progress
- an optional varargs parameter supplying progress objects
to report to
java.lang.Exception
- if the model can't be constructed for some
reason.void primeForecaster(Instances insts) throws java.lang.Exception
insts
- the instances to prime the model with
java.lang.Exception
- if the model can't be primed for some
reason.void primeForecasterIncremental(Instance inst) throws java.lang.Exception
java.lang.Exception
java.util.List<java.util.List<NumericPrediction>> forecast(int numSteps, java.io.PrintStream... progress) throws java.lang.Exception
numSteps
- number of forecasted values to produce for each target. E.g.
a value of 5 would produce a prediction for t+1, t+2, ..., t+5.progress
- an optional varargs parameter supplying progress objects
to report to
java.lang.Exception
- if the forecast can't be produced for some reason.void runForecaster(TSForecaster forecaster, java.lang.String[] options)
forecaster
- the forecaster to runoptions
- the options to pass to the forecaster
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |