pdstools.infinity.resources.prediction_studio.v25_1.model

Classes

Model

v25 Model — no performance fields.

AsyncModel

v25 async Model — no performance fields.

Module Contents

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: _Modelv25_1Mixin, pdstools.infinity.resources.prediction_studio.base.Model

v25 Model — no performance fields.

Parameters:

  • modelId (str)

  • label (str)

  • modelType (str)

  • status (str)

  • componentName (str | None)

  • source (str | None)

  • lastUpdateTime (str | None)

  • modelingTechnique (str | None)

  • updatedBy (str | None)

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.

Parameters:

  • category ({"All", "Responses", "Performance", "Model approval", "Output", "Predictors", "Prediction deployment", "Generic"} or None, optional) – The category of notifications to retrieve.

  • return_df (bool, default False) – If True, returns the notifications as a DataFrame.

Returns:

A list of notifications or a DataFrame.

Return type:

PaginatedList[Notification] or polars.DataFrame

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: _Modelv25_1Mixin, pdstools.infinity.resources.prediction_studio.base.AsyncModel

v25 async Model — no performance fields.

Parameters:

  • modelId (str)

  • label (str)

  • modelType (str)

  • status (str)

  • componentName (str | None)

  • source (str | None)

  • lastUpdateTime (str | None)

  • modelingTechnique (str | None)

  • updatedBy (str | None)

async 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

Fetches a list of notifications for a specific model.

Parameters:

  • category ({"All", "Responses", "Performance", "Model approval", "Output", "Predictors", "Prediction deployment", "Generic"} or None, optional) – The category of notifications to retrieve.

  • return_df (bool, default False) – If True, returns the notifications as a DataFrame.

Returns:

A list of notifications or a DataFrame.

Return type:

AsyncPaginatedList[AsyncNotification] or polars.DataFrame