|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.classifiers.timeseries.AbstractForecaster
weka.classifiers.timeseries.WekaForecaster
public class WekaForecaster
Constructor Summary | |
---|---|
WekaForecaster()
|
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). |
boolean |
getAddAMIndicator()
|
boolean |
getAddDayOfWeek()
|
boolean |
getAddMonthOfYear()
|
boolean |
getAddQuarterOfYear()
|
boolean |
getAddWeekendIndicator()
|
java.lang.String |
getAlgorithmName()
Provides a short name that describes the underlying algorithm in some way. |
Classifier |
getBaseForecaster()
|
int |
getCalculateConfLimitsForForecasts()
|
double |
getConfidenceLevel()
|
java.lang.String[] |
getOptions()
Gets the current settings of this Forecaster. |
java.lang.String |
getPrimaryPeriodicFieldName()
|
java.lang.String |
getTimeStampField()
|
TSLagMaker |
getTSLagMaker()
Get the TSLagMaker that we are using. |
java.util.Enumeration<Option> |
listOptions()
Returns an enumeration describing the available options. |
static void |
main(java.lang.String[] args)
|
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 |
setAddAMIndicator(boolean am)
|
void |
setAddDayOfWeek(boolean d)
|
void |
setAddMonthOfYear(boolean m)
|
void |
setAddQuarterOfYear(boolean q)
|
void |
setAddWeekendIndicator(boolean w)
|
void |
setBaseForecaster(Classifier f)
|
void |
setCalculateConfLimitsForForecasts(int steps)
|
void |
setConfidenceLevel(double confLevel)
|
void |
setFieldsToForecast(java.lang.String fieldsToForecast)
Set the names of the fields/attributes in the data to forecast. |
void |
setOptions(java.lang.String[] options)
|
void |
setPrimaryPeriodicFieldName(java.lang.String p)
|
void |
setTimeStampField(java.lang.String name)
|
void |
setTSLagMaker(TSLagMaker lagMaker)
Set the TSLagMaker to use. |
java.lang.String |
toString()
|
Methods inherited from class weka.classifiers.timeseries.AbstractForecaster |
---|
getFieldsToForecast, makeCopy, run, runForecaster, stringToList |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WekaForecaster()
Method Detail |
---|
public java.lang.String getAlgorithmName()
TSForecaster
getAlgorithmName
in interface TSForecaster
public void setTSLagMaker(TSLagMaker lagMaker)
TSLagUser
setTSLagMaker
in interface TSLagUser
lagMaker
- the TSLagMaker to use.public TSLagMaker getTSLagMaker()
TSLagUser
getTSLagMaker
in interface TSLagUser
public java.util.Enumeration<Option> listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
setOptions
in interface OptionHandler
java.lang.Exception
public java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public void setFieldsToForecast(java.lang.String fieldsToForecast) throws java.lang.Exception
AbstractForecaster
setFieldsToForecast
in interface TSForecaster
setFieldsToForecast
in class AbstractForecaster
fieldsToForecast
- 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.public void setTimeStampField(java.lang.String name)
public java.lang.String getTimeStampField()
public void setAddAMIndicator(boolean am)
public boolean getAddAMIndicator()
public void setAddDayOfWeek(boolean d)
public boolean getAddDayOfWeek()
public void setAddWeekendIndicator(boolean w)
public boolean getAddWeekendIndicator()
public void setAddMonthOfYear(boolean m)
public boolean getAddMonthOfYear()
public void setAddQuarterOfYear(boolean q)
public boolean getAddQuarterOfYear()
public void setPrimaryPeriodicFieldName(java.lang.String p)
public java.lang.String getPrimaryPeriodicFieldName()
public void setCalculateConfLimitsForForecasts(int steps)
public int getCalculateConfLimitsForForecasts()
public void setConfidenceLevel(double confLevel)
public double getConfidenceLevel()
public void setBaseForecaster(Classifier f)
public Classifier getBaseForecaster()
public void reset()
TSForecaster
reset
in interface TSForecaster
public void buildForecaster(Instances insts, java.io.PrintStream... progress) throws java.lang.Exception
AbstractForecaster
buildForecaster
in interface TSForecaster
buildForecaster
in class AbstractForecaster
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.public java.lang.String toString()
toString
in class java.lang.Object
public void primeForecaster(Instances insts) throws java.lang.Exception
AbstractForecaster
primeForecaster
in interface TSForecaster
primeForecaster
in class AbstractForecaster
insts
- the instances to prime the model with
java.lang.Exception
- if the model can't be primed for some
reason.public void primeForecasterIncremental(Instance inst) throws java.lang.Exception
primeForecasterIncremental
in interface TSForecaster
java.lang.Exception
public java.util.List<java.util.List<NumericPrediction>> forecast(int numSteps, java.io.PrintStream... progress) throws java.lang.Exception
AbstractForecaster
forecast
in interface TSForecaster
forecast
in class AbstractForecaster
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.public static void main(java.lang.String[] args)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |