pdstools.infinity.resources.prediction_studio.v24_2.model

Classes

Model

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

Module Contents

class Model(client: pdstools.infinity.client.SyncAPIClient, *, 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: pdstools.infinity.resources.prediction_studio.base.Model

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

Parameters:

  • client (pdstools.infinity.client.SyncAPIClient)

  • modelId (str)

  • label (str)

  • modelType (str)

  • status (str)

  • componentName (Union[str, None])

  • source (Union[str, None])

  • lastUpdateTime (Union[str, None])

  • modelingTechnique (Union[str, None])

  • updatedBy (Union[str, None])

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.

Return type:

ModelAttributes

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.

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.

Parameters:

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

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

Returns:

A list of notifications or a DataFrame containing the notifications, depending on the value of return_df.

Return type:

PaginatedList[Notification] or polars.DataFrame