Consumption Group Settings
Author: Connor Catallo, Created: 2024-12-02
A consumption group in OneStream's SensibleAI Forecast is the interface through which project-related data can be exported to a relational table in a database. This includes model predictions and feature insight information. The data export parameters are highly configurable to get the output in a desired format.
This article was originally written against the SensibleAI Forecast v3.0.0 release. Some of the datatypes and settings may have changed in the v4.0.0 and may continue to evolve in future versions.
Here are the possible export options within the Consumption Group page in SensibleAI Forecast:
- Feature Effect: This type contains data that shows how a given feature and its values compare to a target's actual and predicted values. It provides insights into correlations between feature values and predictions or actuals.
- Feature Impact: This type contains data that indicates how much a given feature influences the model for a target. A large Feature Impact Value suggests that the feature is a significant driver for the model predictions.
- Backtest Model Forecast: This type includes backtest results (if an automatic backtest could be generated during SensibleAI Forecast’s model build) made by models for each target.
- Deployed Model Forecast: This type contains predictions created in the Utilization phase for all deployed models for each target.
- Deployed Prediction Explanation: This type contains the values found in the “Tug of War” feature explainability chart, detailing the quantitative influence (positive or negative) that each feature had on the predicted value.
- Backtest Prediction Explanation: The prediction explanations backtest consumption type contains the amount that the feature influenced (positive or negative) the prediction of a given model for a given target for a given date during the backtest of model build.
When creating consumption groups, you will have the options below, or a subset of them, to customize based on the following selection options.
Export Action: The type of action this consumption group should be auto-attached to. If auto-attached, it automatically runs and exports as a part of that type of action. Examples include prediction and pipeline jobs.
Actuals Types: The type of actuals (engine cleaned, engine uncleaned, source) to include in the consumption group.
Target Frequency: The frequency to export data in.
Merge Method: The type of merge to perform on data if there are multiple forecasts across a date.
Models to Return: The number of models to return in the consumption group.
Prediction Intervals: Indicates if prediction intervals should be included in the export.
Extraction Type: Select Batch to export only the latest prediction run. Select Time to use Start Date Type and End Date Type fields for the earliest prediction to the latest prediction or custom time frames.
Start Date Type: If the earliest start date or a custom beginning date should be used.
Start Date Time, Start Date Hour: The beginning date and hour of the day of the consumption group (inclusive). Available if the If Start Date Type is set to Custom.
End Date Type: If the latest end date or a custom end date should be used.
End Date Time, End Date Hour: The end date and end hour of the day of the consumption group (inclusive). Available if the If End Date Type is set to Custom.
Group Name: The consumption group name within SensibleAI Forecast.
Output Table Name: The name of the outputted table; this is how it will be displayed within the database. Note that the consumption group will automatically prepend a “SML_” to the table name (only on pre-4.0 versions). This is in the same database as the target data set.
When creating a consumption group, the option to choose Consumption Type, Group Name, and Table Name will always be present. Specific details regarding inputs and outputs surrounding consumption groups can be found in the subsequent sections.
Deployed Model Forecast Settings
Export Actions
Export Actions
| Value | Result |
|---|
| Prediction Cluster Orchestrator | Selecting Prediction Cluster Orchestrator will automatically export the results of every prediction into the output table after each prediction job. The export action is tied to each prediction job. Forecast Number and Forecast Name within the export will clarify which prediction the table resulted from. If a table already exists within the group, the results are appended on to the existing table following completion. |
| None | Selecting None will not automatically export the Consumption Group with the most recent predictions of the deployed model. A manual run of the consumption job must occur before table export. |
Actuals Types
| Value | Result |
|---|
| Source Actuals | Source Actuals is the only option for Deployed Model Forecast tables. Actuals are specified in the output table by “Actuals” in the ModelCategory column. |
Target Frequency
Target Frequency
| Value | Result |
|---|
| D | Value will be exported at the daily level. |
| W | Value will be exported at the weekly level. |
| W-SUN | Value will be exported at the weekly level, week starting Sunday. |
| W-MON | Value will be exported at the weekly level, week starting Monday. |
| W-TUE | Value will be exported at the weekly level, week starting Tuesday. |
| W-WED | Value will be exported at the weekly level, week starting Wednesday. |
| W-THU | Value will be exported at the weekly level, week starting Thursday. |
| W-FRI | Value will be exported at the weekly level, week starting Friday. |
| W-SAT | Value will be exported at the weekly level, week starting Saturday. |
| M | Value will be exported at the monthly level, with the Date column representing the last day of the month. |
| MS | Value will be exported at the monthly level, with the Date column representing the first day of the month. |
| Q | Value will be exported at the quarterly level, with the Date column representing the last day of the quarter. |
| QS | Value will be exported at the quarterly level, with the Date column representing the first day of the quarter. |
| A | Value will be exported at the annual level, with the Date column representing the last day of the year. |
| AS | Value will be exported at the annual level, with the Date column representing the first day of the year. |
| Project Frequency | Value will be exported at the frequency of the actuals within the project. |
Merge Method
Merge Method
| Value | Result |
|---|
| No Merge | No Merge is the only option in this instance, as all forecasts are kept distinct and included within the export table. If there are multiple predictions on the same day, the group will capture all of them in the export. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only export prediction results for the best model for each target in the project. ModelRank in this instance will be “1”, and Model will be the name of the associated model. |
| Best Three | Selecting Best Three will export prediction results for the three best models for each target in the project. ModelRank in this instance will be “1”, “2”, or “3”. |
| All | Selecting All will export predictions from all deployed models of the project. |
Prediction Intervals
Prediction Intervals
| Value | Result |
|---|
| Included | By selecting Included, the consumption group export will have populated values for Lower PI and Upper PI, displaying the confidence bands surrounding the prediction. |
| Excluded | Choosing Excluded will populate null values in Lower PI and Upper PI regardless of how the model was configured. |
| Value | Result |
|---|
| Batch | Selecting Batch will only capture results corresponding to the most recent prediction job. When selecting Batch with Prediction Cluster Orchestrator, this will automatically export the prediction after completion. |
| Time | Selecting Time will prompt Start Date Type and End Date Type fields for the earliest prediction to the latest prediction. If a different range is desired, a custom option is also available. |
| Value | Result |
|---|
| Earliest Start | Earliest Start is a default that chooses a date going back to the start of the Actuals data, allowing all predictions to be captured. |
| Custom | Selecting Custom will prompt Start Date and Start Date Hour to manually choose a beginning date for data export (inclusive). |
| Value | Result |
|---|
| Latest End | Latest End is a default that chooses a date corresponding to the end of the most recent prediction. |
| Custom | Selecting Custom will prompt End Date and End Date Hour to manually choose the last day (inclusive) to include in the export. |
Deployed Model Forecast Table Output
| Column Name | Data Type | Desc. |
|---|
| Model | String | Description of model used in forecast, or “Actuals” |
| ModelCategory | String | Type of model used. “Actuals”, “baseline”, “statistical”, or “ml” |
| TargetName | String | Concatenated target name |
| Value | Decimal | Prediction value, or Actuals value |
| LowerPI | nullable Decimal | Lower prediction bound - can be null |
| UpperPI | nullable Decimal | Upper prediction bound - can be null |
| Date | DateTime | Prediction date |
| ModelRank | int | Model rankingActuals is “-1” |
| PredictionCallID | String | Unique ID for each prediction job |
| PredictionScheduledTime | DateTime | Date and time the prediction job started |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to the kernel used for the experiment |
| XperimentBuildID | String | Specific to a single build. Changes upon a rebuild |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single build |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the consumption group that was used for export |
| ConsumptionRunTime | DateTime | Date and time the consumption group started |
| ForecastStartDate | DateTime | Date of starting prediction |
| ForecastNumber | int | Forecast count for that ForecastStartDate |
| ForecastName | String | Scenario Name as entered in prediction run |
| [Target Dim 1] | String | Column name of the first target dimensionDimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimensionDimension columns are ordered alphabetically |
Backtest Model Forecast
Backtest Model Forecast
Export Actions
Export Actions
| Value | Result |
|---|
| Pipeline Orchestrator | Selecting Pipeline Orchestrator will automatically export the backtest model forecast after the Pipeline job is complete. Any Pipeline job, including from rebuild prompt the automatic export. |
| None | Selecting None will not automatically export the Consumption Group after a pipeline. The consumption group will need to be run manually. |
Actuals Types
Actuals Types
| Value | Result |
|---|
| Source Actuals | Selecting Source Actuals includes the target actuals data into the table. In the ModelCategory column of the output table, there will be rows specified for the “Actuals” that are specified in this field. These actuals will cover the range of the backtest period. |
| Engine Cleaned | Selecting Engine Cleaned uses the missing method logic in the consumption group for dates with missing actuals. This is only relevant if an option other than “Zero” is chosen in the Clean Missing Method model settings. In this instance, when ModelCategory is “Actuals” and the value is missing, the cleaned value will be represented in the consumption group. |
| Engine Uncleaned | Selecting Engine Uncleaned will produce the same results as Source Actuals. |
Target Frequency
Target Frequency
| Value | Result |
|---|
| D | Value will be exported at the daily level. |
| W | Value will be exported at the weekly level. |
| W-SUN | Value will be exported at the weekly level, week starting Sunday. |
| W-MON | Value will be exported at the weekly level, week starting Monday. |
| W-TUE | Value will be exported at the weekly level, week starting Tuesday. |
| W-WED | Value will be exported at the weekly level, week starting Wednesday. |
| W-THU | Value will be exported at the weekly level, week starting Thursday. |
| W-FRI | Value will be exported at the weekly level, week starting Friday. |
| W-SAT | Value will be exported at the weekly level, week starting Saturday. |
| M | Value will be exported at the monthly level, with the Date column representing the last day of the month. |
| MS | Value will be exported at the monthly level, with the Date column representing the first day of the month. |
| Q | Value will be exported at the quarterly level, with the Date column representing the last day of the quarter. |
| QS | Value will be exported at the quarterly level, with the Date column representing the first day of the quarter. |
| A | Value will be exported at the annual level, with the Date column representing the last day of the year. |
| AS | Value will be exported at the annual level, with the Date column representing the first day of the year. |
| Project Frequency | Value will be exported at the frequency of the actuals within the project. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only export backtest results for the best model for each target in the project. ModelRank in this instance will be “1”, and Model will be the name of the associated model. |
| Best Three | Selecting Best Three will export backtest results for the three best models for each target in the project. ModelRank in this instance will be “1”, “2”, or “3”. |
| All | Selecting All will export backtest results from all deployed models of the project. |
Prediction Intervals
Prediction Intervals
| Value | Result |
|---|
| Included | In order to export prediction interval data, models must be built with prediction intervals when configuring. By selecting Included, the consumption group export will have populated values for Lower PI and Upper PI, displaying the confidence bands surrounding the prediction. |
| Excluded | Choosing Excluded will populate null values in Lower PI and Upper PI regardless of how the model was configured. |
Backtest Model Forecast Table Output
| Column Name | Data Type | Desc. |
|---|
| Model | String | Description of model used in forecast, or “Actuals” |
| ModelCategory | String | Type of model used. “Actuals”, “baseline”, “statistical”, or “ml” |
| TargetName | String | Concatenated target name |
| Value | Decimal | Prediction value, or Actuals value |
| LowerPI | nullable Decimal | Lower prediction bound - can be null |
| UpperPI | nullable Decimal | Upper prediction bound - can be null |
| Date | DateTime | Backtest prediction date. |
| ModelRank | int | Model ranking. Actuals is “-1” |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to a single model and single target |
| XperimentBuildID | String | Specific to a single model and single target |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| PipelineJobID | String | Specific to a pipeline job |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the consumption run |
| ConsumptionRunTime | DateTime | Date and time the consumption group started |
| ForecastStartDate | DateTime | 1/1/1900 12:00:00 AM. There is no ForecastStartDate in a Backtest |
| ForecastNumber | int | Default of “0” for Backtest |
| ForecastName | String | Backtest. ForecastName will always be “Backtest” |
| PredictionCallID | String | Default value. No Prediction call in a backtest |
| PredictionScheduledTime | DateTime | 1/1/1900 12:00:00 AM. There is no Prediction in a backtest |
| [Target Dim 1] | String | Exact name of target dimension 1, as in actuals. Dimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimension. Dimension columns are ordered alphabetically |
Feature Impact
Feature Impact
Export Actions
Export Actions
| Value | Result |
|---|
| Pipeline Orchestrator | Selecting Pipeline Orchestrator will automatically export the Feature Impact table after the Pipeline job is complete. Any Pipeline job, including from rebuild prompt the automatic export. |
| None | Selecting None will not automatically export the Consumption Group after a pipeline. The consumption group will need to be run manually. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only export feature impact results for the best model for each target in the project. ModelRank in this instance will be “1”, and Model will be the name of the associated model. |
| Best Three | Selecting Best Three will export feature impact results for the three best models for each target in the project. ModelRank in this instance will be “1”, “2”, or “3”. |
| All | Selecting All will export feature impact results from all deployed models of the project. |
Feature Impact Table Output
| Column Name | Data Type | Desc. |
|---|
| FeatureName | String | Full name of feature trail |
| FeatureShortName | String | Abbreviated name of feature trail |
| FeatureImpactValue | Decimal | The absolute mean impact contribution to a specific target over the largest train/val/test split, if there is a holdout period |
| FeatureImpactType | String | Default to “Forecast Overlay Feature Impact”. This is based on the type of feature impact algorithm. |
| Model | String | The model used for the specific target and feature |
| TargetName | String | Concatenated target name |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to a single model and single target |
| XperimentBuildID | String | Specific to a single model and single target. Changes upon a rebuild. |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| PipelineJobID | String | Specific to a pipeline job |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the consumption run |
| ConsumptionRunTime | DateTime | Date and time the consumption group started |
| [Target Dim 1] | String | Exact name of target dimension 1, as in actuals. Dimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimension. Dimension columns are ordered alphabetically |
Feature Effect
Feature Effect
Export Actions
Export Actions
| Value | Result |
|---|
| Pipeline Orchestrator | Selecting Pipeline Orchestrator will automatically export the Feature Effect table after the Pipeline job is complete. Any Pipeline job, including from rebuild prompt the automatic export. |
| None | Selecting None will not automatically export the Consumption Group after a pipeline. The consumption group will need to be run manually. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only include feature effect results for the best model for each target in the project. Model will be the name of the associated model. |
| Best Three | Selecting Best Three will include feature effect results for the three best models for each target in the project. |
| All | Selecting All will include feature effect results for all models for each target in the project. |
Feature Effect Table Output
| Column Name | Data Type | Desc. |
|---|
| ----------- | --------- | ----- |
| ----------- | --------- | ----- |
| Model | String | Model used for target, feature, and average feature value |
| FeatureLowerBound | Decimal | Lower bound value for the bin the feature recorded value occupies |
| FeatureUpperBound | Decimal | Upper bound value for the bin the feature recorded value occupies |
| FeatureAvgValue | Decimal | Average value for the feature if it exists in the feature bound bin |
| PredictionAvgValue | Decimal | Average value for the model prediction when the feature value exists in the feature bound bin |
| TargetAvgValue | Decimal | Average value for the target actuals when the feature value exists in the feature bound bin |
| FeatureName | String | Full name of feature trail |
| FeatureShortName | String | Abbreviated name of feature trail |
| TargetName | String | Concatenated target name |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to a single model and single target |
| XperimentBuildID | String | Specific to a single model and single target. Changes upon a rebuild. |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the consumption run |
| ConsumptionRunTime | DateTime | Date and time the consumption group started |
| [Target Dim 1] | String | Exact name of target dimension 1, as in actuals. Dimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimension. Dimension columns are ordered alphabetically |
Deployed Prediction Explanations
Deployed Prediction Explanations
Export Actions
Export Actions
| Value | Result |
|---|
| Prediction Cluster Orchestrator | Selecting Prediction Cluster Orchestrator will automatically export prediction explanations into the output table after each prediction job. Forecast Number and Forecast Name within the export will clarify which prediction the table resulted from. If a table already exists within the group, the results are appended on to the existing table following completion. |
| None | Selecting None will not automatically export the Consumption Group with the most recent predictions explanations of the deployed model. A manual run of the consumption job must occur before table export. |
Merge Method
Merge Method
| Value | Result |
|---|
| No Merge | No Merge is the only option. Keep all forecasts distinct. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only include prediction explanations for the best model for each target in the project. |
| Best Three | Selecting Best Three will include prediction explanations for the three best models for each target in the project. |
| All | Selecting All will include prediction explanations for all models for each target in the project. |
| Value | Result |
|---|
| Batch | Selecting Batch will only export explanations for the latest prediction that was ran. |
| Time | Selecting Time will prompt Start Date Type and End Date Type fields for the earliest prediction to the latest prediction. If a different range is desired, a custom option is also available. If a forecast value is wanted in the table, the Date should fall in this range. |
| Value | Result |
|---|
| Earliest Start | Earliest Start is a default that chooses a date going back to the start of the Actuals data, allowing all predictions to be captured. |
| Custom | Selecting Custom will prompt Start Date and Start Date Hour to manually choose a beginning date for predictions (inclusive). |
| Value | Result |
|---|
| Latest End | Latest End is a default that chooses a date corresponding to the end of the most recent prediction. |
| Custom | Selecting Custom will prompt End Date to manually choose an end date for the last day of predictions (inclusive). |
Deployed Prediction Explanations Table Output
| Column Name | Data Type | Desc. |
|---|
| ----------- | --------- | ----- |
| Date | DateTime | Prediction date |
| FeatureName | String | Full name of feature trail |
| FeatureShortName | String | Abbreviated name of feature trail |
| PredictionExplanationValue | Decimal | The amount that the feature influenced (positive or negative) the prediction of a given model for a given target for a given date for a project in utilization |
| FeatureValue | Decimal | Value of feature designated to a model, target, and date |
| PredictionExplanationType | String | Description of the type of prediction explanation used to get the value. This is model dependent |
| TargetName | String | Concatenated target name |
| Model | String | Description of model used |
| ModelStage | String | Description of where the value was generated: “prediction” for a deployed prediction explanations table |
| ModelCategory | String | Description of model category prediction explanation was calculated from |
| ModelIterationID | String | Specific to a single prediction run, target, and model |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to the consumption group that was used for export |
| XperimentBuildID | String | Specific to a single target or group of targets Changes upon a rebuild |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| PipelineJobID | String | Specific to a pipeline job |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the project |
| ConsumptionRunTime | DateTime | Specific to the time the consumption group was run |
| PredictionCallID | String | Unique ID for each prediction job |
| PredictionScheduledTime | DateTime | Date and time the prediction job was scheduled |
| PredictionStartTime | DateTime | Date and time the prediction job started |
| ForecastStartDate | DateTime | Date of starting prediction |
| ForecastNumber | Integer | Forecast count for that ForecastStartDate |
| ForecastName | String | Scenario Name as entered in prediction run |
| [Target Dim 1] | String | Exact name of target dimension 1, as in actuals Dimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimensionDimension columns are ordered alphabetically |
Backtest Prediction Explanations
Backtest Prediction Explanations
Export Actions
Export Actions
| Value | Result |
|---|
| Prediction Cluster Orchestrator | Selecting Prediction Cluster Orchestrator will automatically export prediction explanations into the output table after each Pipeline job, including rebuilds. |
| None | Selecting None will not automatically export the Consumption Group with the most recent predictions explanations. A manual run of the consumption job must occur before table export. |
Models to Return
Models to Return
| Value | Result |
|---|
| Best | Selecting Best will only include prediction explanation backtest results for the best model for each target in the project. |
| Best Three | Selecting Best Three will include prediction explanation backtest results for the three best models for each target in the project. |
| All | Selecting All will include prediction explanation backtest results for all models for each target in the project. |
Backtest Prediction Explanations Table Output
| Column Name | Data Type | Desc. |
|---|
| Date | DateTime | Prediction date |
| FeatureName | String | Full name of feature trail |
| FeatureShortName | String | Abbreviated name of feature trail |
| PredictionExplanationValue | Decimal | The amount that the feature influenced (positive or negative) the prediction of a given model for a given target for a given date for a project in utilization |
| FeatureValue | Decimal | Value of feature designated to a model, target, and date |
| PredictionExplanationType | String | Description of the type of prediction explanation used to get the value. This is model dependent |
| TargetName | String | Concatenated target name |
| Model | String | Description of model used |
| ModelStage | String | Description of where the value was generated: “prediction” for a deployed prediction explanations table |
| ModelCategory | String | Description of model category prediction explanation was calculated from |
| ModelIterationID | String | Specific to a single prediction run, target, and model |
| ConsumptionID | String | Specific to the consumption group that was used for export |
| XperimentKernelID | String | Specific to the consumption group that was used for export |
| XperimentBuildID | String | Specific to a single target or group of targets Changes upon a rebuild |
| XperimentSetID | String | Specific to a single target |
| BuildInfoID | String | Specific to a single target |
| PipelineJobID | String | Specific to a pipeline job |
| ProjectID | String | Specific to the project |
| ConsumptionRunID | String | Specific to the project |
| ConsumptionRunTime | DateTime | Specific to the time the consumption group was run |
| PredictionCallID | String | Unique ID for each prediction job |
| PredictionScheduledTime | DateTime | Date and time the prediction job was scheduled |
| PredictionStartTime | DateTime | Date and time the prediction job started |
| ForecastStartDate | DateTime | Date of starting prediction |
| ForecastNumber | Integer | Forecast count for that ForecastStartDate |
| ForecastName | String | Scenario Name as entered in prediction run |
| [Target Dim 1] | String | Exact name of target dimension 1, as in actuals Dimension columns are ordered alphabetically |
| … | String | … |
| [Target Dim N] | String | Column name of the n-th target dimensionDimension columns are ordered alphabetically |