orbit package

Subpackages

• orbit.constants package
  • Submodules
  • orbit.constants.constants module
    • BacktestFitKeys
      • BacktestFitKeys.ACTUAL
      • BacktestFitKeys.DATE
      • BacktestFitKeys.METRIC_NAME
      • BacktestFitKeys.METRIC_VALUES
      • BacktestFitKeys.PREDICTED
      • BacktestFitKeys.SPLIT_KEY
      • BacktestFitKeys.TEST_ACTUAL
      • BacktestFitKeys.TEST_PREDICTED
      • BacktestFitKeys.TRAIN_ACTUAL
      • BacktestFitKeys.TRAIN_FLAG
      • BacktestFitKeys.TRAIN_METRIC_FLAG
      • BacktestFitKeys.TRAIN_PREDICTED
    • CompiledStanModelPath
      • CompiledStanModelPath.CHILD
      • CompiledStanModelPath.PARENT
    • EstimatorsKeys
      • EstimatorsKeys.CmdStanMAP
      • EstimatorsKeys.CmdStanMCMC
      • EstimatorsKeys.PyroSVI
      • EstimatorsKeys.StanMAP
      • EstimatorsKeys.StanMCMC
    • KTRTimePointPriorKeys
      • KTRTimePointPriorKeys.NAME
      • KTRTimePointPriorKeys.PRIOR_END_TP_IDX
      • KTRTimePointPriorKeys.PRIOR_MEAN
      • KTRTimePointPriorKeys.PRIOR_REGRESSOR_COL
      • KTRTimePointPriorKeys.PRIOR_SD
      • KTRTimePointPriorKeys.PRIOR_START_TP_IDX
    • PlotLabels
      • PlotLabels.ACTUAL_RESPONSE
      • PlotLabels.PREDICTED_RESPONSE
      • PlotLabels.TRAINING_ACTUAL_RESPONSE
    • PredictMethod
      • PredictMethod.FULL_SAMPLING
      • PredictMethod.MAP
      • PredictMethod.MEAN
      • PredictMethod.MEDIAN
    • PredictionKeys
      • PredictionKeys.PREDICTION
      • PredictionKeys.REGRESSION
      • PredictionKeys.REGRESSOR
      • PredictionKeys.SEASONALITY
      • PredictionKeys.TREND
    • PredictionMetaKeys
      • PredictionMetaKeys.DATE_ARRAY
      • PredictionMetaKeys.END
      • PredictionMetaKeys.END_INDEX
      • PredictionMetaKeys.FUTURE_STEPS
      • PredictionMetaKeys.PREDICTION_DF_LEN
      • PredictionMetaKeys.START
      • PredictionMetaKeys.START_INDEX
    • TimeSeriesSplitSchemeKeys
      • TimeSeriesSplitSchemeKeys.MODEL
      • TimeSeriesSplitSchemeKeys.SPLIT_TYPE_EXPANDING
      • TimeSeriesSplitSchemeKeys.SPLIT_TYPE_ROLLING
      • TimeSeriesSplitSchemeKeys.TEST_IDX
      • TimeSeriesSplitSchemeKeys.TRAIN_END_DATE
      • TimeSeriesSplitSchemeKeys.TRAIN_IDX
      • TimeSeriesSplitSchemeKeys.TRAIN_START_DATE
    • TrainingMetaKeys
      • TrainingMetaKeys.DATE_ARRAY
      • TrainingMetaKeys.DATE_COL
      • TrainingMetaKeys.END
      • TrainingMetaKeys.NUM_OF_OBS
      • TrainingMetaKeys.RESPONSE
      • TrainingMetaKeys.RESPONSE_COL
      • TrainingMetaKeys.RESPONSE_MEAN
      • TrainingMetaKeys.RESPONSE_SD
      • TrainingMetaKeys.START
  • orbit.constants.dlt module
  • orbit.constants.lgt module
  • orbit.constants.palette module
    • KTRPalette
      • KTRPalette.KNOTS_REGION
      • KTRPalette.KNOTS_SEGMENT
    • OrbitColorMap
      • OrbitColorMap.BLACK_GRADIENT
      • OrbitColorMap.BLUE_GRADIENT
      • OrbitColorMap.GREEN_GRADIENT
      • OrbitColorMap.PURPLE_GRADIENT
      • OrbitColorMap.RAINBOW
      • OrbitColorMap.RED_GRADIENT
      • OrbitColorMap.YELLOW_GRADIENT
    • OrbitPalette
      • OrbitPalette.BLACK
      • OrbitPalette.BLUE
      • OrbitPalette.BLUE600
      • OrbitPalette.BROWN
      • OrbitPalette.GREEN
      • OrbitPalette.GREEN600
      • OrbitPalette.ORANGE
      • OrbitPalette.PURPLE
      • OrbitPalette.RED
      • OrbitPalette.WHITE
      • OrbitPalette.YELLOW
      • OrbitPalette.YELLOW400
    • PredictionPaletteClassic
      • PredictionPaletteClassic.ACTUAL_OBS
      • PredictionPaletteClassic.HOLDOUT_VERTICAL_LINE
      • PredictionPaletteClassic.PREDICTION_INTERVAL
      • PredictionPaletteClassic.PREDICTION_LINE
      • PredictionPaletteClassic.TEST_OBS
  • Module contents
• orbit.diagnostics package
  • Submodules
  • orbit.diagnostics.plot module
    • metric_horizon_barplot()
    • params_comparison_boxplot()
    • plot_bt_predictions()
    • plot_bt_predictions2()
    • plot_predicted_components()
    • plot_predicted_data()
    • residual_diagnostic_plot()
  • Module contents
• orbit.estimators package
  • Submodules
  • orbit.estimators.base_estimator module
    • BaseEstimator
      • BaseEstimator.fit()
  • orbit.estimators.pyro_estimator module
    • PyroEstimator
      • PyroEstimator.fit()
    • PyroEstimatorSVI
      • PyroEstimatorSVI.fit()
  • orbit.estimators.stan_estimator module
    • StanEstimator
      • StanEstimator.fit()
    • StanEstimatorMAP
      • StanEstimatorMAP.fit()
    • StanEstimatorMCMC
      • StanEstimatorMCMC.fit()
  • Module contents
• orbit.models package
  • Submodules
  • orbit.models.ets module
    • ETS()
  • orbit.models.lgt module
    • LGT()
  • orbit.models.dlt module
    • DLT()
  • orbit.models.ktrlite module
    • KTRLite()
  • Module contents
• orbit.pyro package
  • Submodules
  • orbit.pyro.lgt module
    • Model
      • Model.max_plate_nesting
  • Module contents
• orbit.utils package
  • Submodules
  • orbit.utils.general module
    • expand_grid()
    • get_parent_path()
    • is_empty_dataframe()
    • is_even_gap_datetime()
    • is_ordered_datetime()
    • regenerate_base_df()
    • update_dict()
  • orbit.utils.pyro module
    • get_pyro_model()
  • orbit.utils.stan module
    • get_compiled_stan_model()
    • suppress_stdout_stderr
  • Module contents

Submodules

orbit.exceptions module

exception orbit.exceptions.AbstractMethodException

Bases: Exception

exception orbit.exceptions.BacktestException

Bases: Exception

exception orbit.exceptions.DataInputException

Bases: Exception

exception orbit.exceptions.EstimatorException

Bases: Exception

exception orbit.exceptions.ForecasterException

Bases: Exception

exception orbit.exceptions.IllegalArgument

Bases: Exception

exception orbit.exceptions.ModelException

Bases: Exception

exception orbit.exceptions.PlotException

Bases: Exception

exception orbit.exceptions.PredictionException

Bases: Exception

orbit.orbit module

Top level Orbit class

class orbit.orbit.Orbit

Bases: object

Module contents