abacusai.model_monitor
Module Contents
Classes
A model monitor |
- class abacusai.model_monitor.ModelMonitor(client, modelMonitorId=None, name=None, createdAt=None, projectId=None, trainingFeatureGroupId=None, predictionFeatureGroupId=None, predictionFeatureGroupVersion=None, trainingFeatureGroupVersion=None, alertConfig=None, biasMetricId=None, latestBiasMetricVersionId=None, predictionMetricId=None, latestPredictionMetricVersionId=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelId=None, starred=None, batchPredictionId=None, monitorType=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, refreshSchedules={}, latestMonitorModelVersion={})
Bases:
abacusai.return_class.AbstractApiClass
A model monitor
- Parameters:
client (ApiClient) – An authenticated API Client instance
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
latestBiasMetricVersionId (str) – Lastest prediction metric instance for bias
predictionMetricId (str) – The prediction metric ID for the model monitor
latestPredictionMetricVersionId (str) – Lastest prediction metric instance for decile and other analysis
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
latestMonitorModelVersion (ModelMonitorVersion) – The latest model monitor version.
refreshSchedules (RefreshSchedule) – List of refresh schedules that indicate when the next model version will be trained.
- __repr__()
Return repr(self).
- to_dict()
Get a dict representation of the parameters in this class
- Returns:
The dict value representation of the class parameters
- Return type:
- rerun()
Re-runs the specified model monitor.
- Parameters:
model_monitor_id (str) – Unique string identifier of the model monitor to re-run.
- Returns:
The model monitor that is being re-run.
- Return type:
- refresh()
Calls describe and refreshes the current object’s fields
- Returns:
The current object
- Return type:
- describe()
Retrieves a full description of the specified model monitor.
- Parameters:
model_monitor_id (str) – Unique string identifier associated with the model monitor.
- Returns:
Description of the model monitor.
- Return type:
- get_summary()
Gets the summary of a model monitor across versions.
- Parameters:
model_monitor_id (str) – A unique string identifier associated with the model monitor.
- Returns:
An object describing integrity, bias violations, model accuracy and drift for the model monitor.
- Return type:
- list_versions(limit=100, start_after_version=None)
Retrieves a list of versions for a given model monitor.
- Parameters:
- Returns:
A list of model monitor versions.
- Return type:
- rename(name)
Renames a model monitor
- Parameters:
name (str) – The new name to apply to the model monitor.
- delete()
Deletes the specified Model Monitor and all its versions.
- Parameters:
model_monitor_id (str) – Unique identifier of the Model Monitor to delete.