pdstools.infinity.resources.prediction_studio.v24_2.model
=========================================================

.. py:module:: pdstools.infinity.resources.prediction_studio.v24_2.model


Classes
-------

.. autoapisummary::

   pdstools.infinity.resources.prediction_studio.v24_2.model.Model


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

.. py:class:: Model(client: pdstools.infinity.client.SyncAPIClient, *, modelId: str, label: str, modelType: str, status: str, componentName: Union[str, None] = None, source: Union[str, None] = None, lastUpdateTime: Union[str, None] = None, modelingTechnique: Union[str, None] = None, updatedBy: Union[str, None] = None)

   Bases: :py:obj:`pdstools.infinity.resources.prediction_studio.base.Model`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: describe() -> pdstools.infinity.resources.prediction_studio.base.ModelAttributes

      Fetches details about a model, including target labels, alternate labels, monitoring information, predictor information etc.

      :returns: An object containing information about the model.
      :rtype: ModelAttributes



   .. py:method:: get_notifications(category: Optional[pdstools.infinity.resources.prediction_studio.types.NotificationCategory] = None, return_df: Literal[False] = False) -> pdstools.infinity.internal._pagination.PaginatedList[pdstools.infinity.resources.prediction_studio.base.Notification]
                  get_notifications(category: Optional[pdstools.infinity.resources.prediction_studio.types.NotificationCategory] = None, return_df: Literal[True] = True) -> polars.DataFrame

      Fetches a list of notifications for a specific model.

      This function retrieves notifications related to a model. You can filter these notifications by their category.
      Optionally, the notifications can be returned as a DataFrame for easier analysis and visualization.

      :param category: The category of notifications to retrieve. If not specified, all notifications are fetched.
      :type category: {"All", "Responses", "Performance", "Model approval", "Output", "Predictors", "Prediction deployment", "Generic"} or None, optional
      :param return_df: If True, returns the notifications as a DataFrame. Otherwise, returns a list.
      :type return_df: bool, default False

      :returns: A list of notifications or a DataFrame containing the notifications, depending on the value of `return_df`.
      :rtype: PaginatedList[Notification] or polars.DataFrame