:py:mod:`abacusai.model_monitor`
================================

.. py:module:: abacusai.model_monitor


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   abacusai.model_monitor.ModelMonitor




.. py:class:: ModelMonitor(client, modelMonitorId=None, name=None, createdAt=None, projectId=None, trainingFeatureGroupId=None, predictionFeatureGroupId=None, alertConfig=None, biasMetricId=None, latestBiasMetricVersionId=None, predictionMetricId=None, latestPredictionMetricVersionId=None, metricConfigs=None, metricTypes=None, refreshSchedules={}, latestMonitorModelVersion={})

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`

   A model monitor

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param modelMonitorId: The unique identifier of the model monitor.
   :type modelMonitorId: str
   :param name: The user-friendly name for the model.
   :type name: str
   :param createdAt: Date and time at which the model was created.
   :type createdAt: str
   :param projectId: The project this model belongs to.
   :type projectId: str
   :param trainingFeatureGroupId: Feature group IDs that this model monitor is monitoring.
   :type trainingFeatureGroupId: unique string identifiers
   :param predictionFeatureGroupId: Feature group IDs that this model monitor is monitoring.
   :type predictionFeatureGroupId: unique string identifiers
   :param alertConfig: Alerting configuration for this model monitor.
   :type alertConfig: dict
   :param biasMetricId:
   :type biasMetricId: str
   :param latestBiasMetricVersionId: Lastest prediction metric instance for bias
   :type latestBiasMetricVersionId: str
   :param predictionMetricId:
   :type predictionMetricId: str
   :param latestPredictionMetricVersionId: Lastest prediction metric instance for decile and other analysis
   :type latestPredictionMetricVersionId: str
   :param metricConfigs: Configurations for model monitor
   :type metricConfigs: dict
   :param metricTypes: List of metric types
   :type metricTypes: dict
   :param latestMonitorModelVersion: The latest model monitor version.
   :type latestMonitorModelVersion: ModelMonitorVersion
   :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained.
   :type refreshSchedules: RefreshSchedule

   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict


   .. py:method:: rerun()

      Reruns the specified model monitor.

      :param model_monitor_id: The model monitor to rerun.
      :type model_monitor_id: str

      :returns: The model monitor that is being rerun.
      :rtype: ModelMonitor


   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: ModelMonitor


   .. py:method:: describe()

      Retrieves a full description of the specified model monitor.

      :param model_monitor_id: The unique ID associated with the model monitor.
      :type model_monitor_id: str

      :returns: The description of the model monitor.
      :rtype: ModelMonitor


   .. py:method:: get_summary()

      :param model_monitor_id:
      :type model_monitor_id: str

      :returns: None
      :rtype: ModelMonitorSummary


   .. py:method:: list_versions(limit = 100, start_after_version = None)

      Retrieves a list of the versions for a given model monitor.

      :param limit: The max length of the list of all model monitor versions.
      :type limit: int
      :param start_after_version: The id of the version after which the list starts.
      :type start_after_version: str

      :returns: An array of model monitor versions.
      :rtype: ModelMonitorVersion


   .. py:method:: rename(name)

      Renames a model monitor

      :param name: The name to apply to the model monitor
      :type name: str


   .. py:method:: delete()

      Deletes the specified model monitor and all its versions.

      :param model_monitor_id: The ID of the model monitor to delete.
      :type model_monitor_id: str



