pdstools.infinity.resources.prediction_studio.v25_1.model
=========================================================

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


Classes
-------

.. autoapisummary::

   pdstools.infinity.resources.prediction_studio.v25_1.model.Model
   pdstools.infinity.resources.prediction_studio.v25_1.model.AsyncModel


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

.. py:class:: Model(client, *, modelId: str, label: str, modelType: str, status: str, componentName: str | None = None, source: str | None = None, lastUpdateTime: str | None = None, modelingTechnique: str | None = None, updatedBy: str | None = None)

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


   v25 Model — no performance fields.


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

      Fetches a list of notifications for a specific model.

      :param category: The category of notifications to retrieve.
      :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.
      :type return_df: bool, default False

      :returns: A list of notifications or a DataFrame.
      :rtype: PaginatedList[Notification] or polars.DataFrame



.. py:class:: AsyncModel(client, *, modelId: str, label: str, modelType: str, status: str, componentName: str | None = None, source: str | None = None, lastUpdateTime: str | None = None, modelingTechnique: str | None = None, updatedBy: str | None = None)

   Bases: :py:obj:`_Modelv25_1Mixin`, :py:obj:`pdstools.infinity.resources.prediction_studio.base.AsyncModel`


   v25 async Model — no performance fields.


   .. py:method:: get_notifications(category: pdstools.infinity.resources.prediction_studio.types.NotificationCategory | None = None, return_df: bool = False) -> pdstools.infinity.internal._pagination.AsyncPaginatedList[pdstools.infinity.resources.prediction_studio.base.AsyncNotification] | polars.DataFrame
      :async:


      Fetches a list of notifications for a specific model.

      :param category: The category of notifications to retrieve.
      :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.
      :type return_df: bool, default False

      :returns: A list of notifications or a DataFrame.
      :rtype: AsyncPaginatedList[AsyncNotification] or polars.DataFrame