Package com.datarobot.prediction
Interface ITimeSeriesModelInfo
-
- All Superinterfaces:
IPredictorInfo
- All Known Subinterfaces:
ITimeSeriesRegressionPredictor
- All Known Implementing Classes:
TimeSeriesRegressionPredictorImpl
public interface ITimeSeriesModelInfo extends IPredictorInfo
Time Series Models Specific Information.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDateColumnName()Getter for Date Column Name.StringgetDateFormat()Expected date format for the input dates.Map.Entry<Integer,Integer>getFeatureDerivationWindow()Getter for Feature Derivation Interval (FDW).Map.Entry<Integer,Integer>getForecastWindow()Getter for Forecast Interval.StringgetSeriesIdColumnName()Getter for Series ID Column Name.Map.Entry<Integer,String>getTimeStep()Getter for Time Step.-
Methods inherited from interface com.datarobot.prediction.IPredictorInfo
getDefaultPredictionExplanationParams, getFeatures, getModelId, getModelInfo, getPredictorClass
-
-
-
-
Method Detail
-
getSeriesIdColumnName
String getSeriesIdColumnName()
Getter for Series ID Column Name.- Returns:
- series id used during training.
-
getDateColumnName
String getDateColumnName()
Getter for Date Column Name.- Returns:
- date column name used for indexing.
-
getTimeStep
Map.Entry<Integer,String> getTimeStep()
Getter for Time Step. Pair of quantity to time unit. Time Unit could be: - ROW - MILLISECOND - SECOND - MINUTE - HOUR - DAY - WEEK - MONTH - QUARTER - YEAR- Returns:
- time step used for the time series processing.
-
getFeatureDerivationWindow
Map.Entry<Integer,Integer> getFeatureDerivationWindow()
Getter for Feature Derivation Interval (FDW). See documentation https://app.datarobot.com/docs/time/time-series.html#framework Pair of min units number and max units number. So window is calculated date based formulas similar to: [ forecast_point - max * time_step_millis, forecast_point - min * time_step_millis ]- Returns:
- feature derivation window used for feature extraction.
-
getForecastWindow
Map.Entry<Integer,Integer> getForecastWindow()
Getter for Forecast Interval. Pair of min units number and max units number So window is calculated date based formulas similar to: [ forecast_point + min * time_step_millis, forecast_point + max * time_step_millis ]- Returns:
- feature derivation window used for feature extraction.
-
getDateFormat
String getDateFormat()
Expected date format for the input dates.- Returns:
- date format.
-
-