Method
createForecastingMonitor POST
Copy POST

Runs a forecasting monitor for the specified project.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes projectId str Unique string identifier of the project.
Yes name str The name you want your model monitor to have. Defaults to " Model Monitor".
Yes predictionFeatureGroupId str Unique string identifier of the prediction data feature group.
Yes trainingFeatureGroupId str Unique string identifier of the training data feature group.
Yes trainingForecastConfig ForecastingMonitorConfig The configuration for the training data.
KEY TYPE Description
windowConfig TimeWindowConfig The windowing configuration for the time series data.
KEY TYPE Description
windowDuration int The duration of the window.
windowFromStart bool Whether the window should be from the start of the time series.
endTime str The end time of the time series data.
startTime str The start time of the time series data.
idColumn str The name of the column that contains the unique identifier for the time series.
targetColumn str The name of the column that contains the target value for the time series.
timestampColumn str The name of the column that contains the timestamp for the time series.
Yes predictionForecastConfig ForecastingMonitorConfig The configuration for the prediction data.
KEY TYPE Description
windowConfig TimeWindowConfig The windowing configuration for the time series data.
KEY TYPE Description
windowDuration int The duration of the window.
windowFromStart bool Whether the window should be from the start of the time series.
endTime str The end time of the time series data.
startTime str The start time of the time series data.
idColumn str The name of the column that contains the unique identifier for the time series.
targetColumn str The name of the column that contains the target value for the time series.
timestampColumn str The name of the column that contains the timestamp for the time series.
Yes forecastFrequency str The frequency of the forecast. Defaults to the frequency of the prediction data.
No refreshSchedule str A cron-style string that describes a schedule in UTC to automatically rerun the created forecasting monitor.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result ModelMonitor
KEY TYPE Description
modelMonitorId str The unique identifier of the model monitor.
name str The user-friendly name for the model monitor.
createdAt str Date and time at which the model was created.
projectId str The project this model belongs to.
trainingFeatureGroupId List[str] Feature group IDs that this model monitor is monitoring.
predictionFeatureGroupId List[str] Feature group IDs that this model monitor is monitoring.
predictionFeatureGroupVersion List[str] Feature group versions that this model monitor is monitoring.
trainingFeatureGroupVersion List[str] Feature group versions that this model monitor is monitoring.
alertConfig dict Alerting configuration for this model monitor.
biasMetricId str The bias metric ID
metricConfigs dict Configurations for model monitor
featureGroupMonitorConfigs dict Configurations for feature group monitor
metricTypes dict List of metric types
modelId str Model ID that this model monitor is monitoring.
starred bool Whether this model monitor is starred.
batchPredictionId str The batch prediction ID this model monitor monitors
monitorType str The type of the monitor, one of MODEL_MONITOR, or FEATURE_GROUP_MONITOR
edaConfigs dict The configs for EDA
trainingForecastConfig dict The tarining config for forecast monitors
predictionForecastConfig dict The prediction config for forecast monitors
forecastFrequency str The frequency of the forecast
trainingFeatureGroupSampling bool Whether or not we sample from training feature group
predictionFeatureGroupSampling bool Whether or not we sample from prediction feature group
monitorDriftConfig dict The monitor drift config for the monitor
predictionDataUseMappings dict The data_use mapping of the prediction features
trainingDataUseMappings dict The data_use mapping of the training features
latestMonitorModelVersion ModelMonitorVersion The latest model monitor version.
KEY TYPE Description
modelMonitorVersion str The unique identifier of a model monitor version.
status str The current status of the model.
modelMonitorId str A reference to the model monitor this version belongs to.
monitoringStartedAt str The start time and date of the monitoring process.
monitoringCompletedAt str The end time and date of the monitoring process.
trainingFeatureGroupVersion List[str] Feature group version IDs that this refresh pipeline run is monitoring.
predictionFeatureGroupVersion List[str] Feature group version IDs that this refresh pipeline run is monitoring.
error str Relevant error if the status is FAILED.
pendingDeploymentIds list List of deployment IDs where deployment is pending.
failedDeploymentIds list List of failed deployment IDs.
metricConfigs List[dict] List of metric configs for the model monitor instance.
featureGroupMonitorConfigs dict Configurations for feature group monitor
metricTypes list List of metric types.
modelVersion List[str] Model version IDs that this refresh pipeline run is monitoring.
batchPredictionVersion str The batch prediction version this model monitor is monitoring
edaConfigs list The list of eda configs for the version
trainingForecastConfig dict The training forecast config for the monitor version
predictionForecastConfig dict The prediction forecast config for the monitor version
forecastFrequency str The forecast frequency for the monitor version
monitorDriftConfig dict The monitor drift config for the monitor version
predictionDataUseMappings dict The mapping of prediction data use to feature group version
trainingDataUseMappings dict The mapping of training data use to feature group version
refreshSchedules RefreshSchedule List of refresh schedules that indicate when the next model version will be trained.
KEY TYPE Description
refreshPolicyId str The unique identifier of the refresh policy
nextRunTime str The next run time of the refresh policy. If null, the policy is paused.
cron str A cron-style string that describes the when this refresh policy is to be executed in UTC
refreshType str The type of refresh that will be run
error str An error message for the last pipeline run of a policy

Exceptions:

TYPE WHEN
DataNotFoundError

projectId is not found.
DataNotFoundError

predictionFeatureGroupId is not found.
DataNotFoundError

trainingFeatureGroupId is not found.
InvalidEnumParameterError

An invalid value is passed for forecastFrequency.
Language:

© Copyright