abacusai.forecasting_monitor_summary — AbacusAI documentation

# abacusai.forecasting_monitor_summary

## Classes

`ForecastingMonitorSummary` | Forecasting Monitor Summary of the latest version of the data.

## Module Contents

class abacusai.forecasting_monitor_summary.ForecastingMonitorSummary(client, predictionTimestampCol=None, predictionTargetCol=None, trainingTimestampCol=None, trainingTargetCol=None, predictionItemId=None, trainingItemId=None, forecastFrequency=None, trainingTargetAcrossTime={}, predictionTargetAcrossTime={}, actualsHistogram={}, predictionsHistogram={}, trainHistoryData={}, predictHistoryData={}, targetDrift={}, historyDrift={})

  Bases: `abacusai.return_class.AbstractApiClass`

  Forecasting Monitor Summary of the latest version of the data.

  Parameters:

    - client (ApiClient) – An authenticated API Client instance

    - predictionTimestampCol (str) – Feature in the data that represents the timestamp column.

    - predictionTargetCol (str) – Feature in the data that represents the target.

    - trainingTimestampCol (str) – Feature in the data that represents the timestamp column.

    - trainingTargetCol (str) – Feature in the data that represents the target.

    - predictionItemId (str) – Feature in the data that represents the item id.

    - trainingItemId (str) – Feature in the data that represents the item id.

    - forecastFrequency (str) – Frequency of data, could be hourly, daily, weekly, monthly, quarterly or yearly.

    - trainingTargetAcrossTime (ForecastingAnalysisGraphData) – Data showing average, p10, p90, median sales across time

    - predictionTargetAcrossTime (ForecastingAnalysisGraphData) – Data showing average, p10, p90, median sales across time

    - actualsHistogram (ForecastingAnalysisGraphData) – Data showing actuals histogram

    - predictionsHistogram (ForecastingAnalysisGraphData) – Data showing predictions histogram

    - trainHistoryData (ForecastingAnalysisGraphData) – Data showing length of history distribution

    - predictHistoryData (ForecastingAnalysisGraphData) – Data showing length of history distribution

    - targetDrift (FeatureDriftRecord) – Data showing drift of the target for all drift types: distance (KL divergence), js_distance, ws_distance, ks_statistic, psi, csi, chi_square

    - historyDrift (FeatureDriftRecord) – Data showing drift of the history for all drift types: distance (KL divergence), js_distance, ws_distance, ks_statistic, psi, csi, chi_square

  prediction_timestamp_col
  prediction_target_col
  training_timestamp_col
  training_target_col
  prediction_item_id
  training_item_id
  forecast_frequency
  training_target_across_time
  prediction_target_across_time
  actuals_histogram
  predictions_histogram
  train_history_data
  predict_history_data
  target_drift
  history_drift
  deprecated_keys
  __repr__()
  to_dict()

    Get a dict representation of the parameters in this class

    Returns:

      The dict value representation of the class parameters

    Return type:

      dict