pdstools.infinity.resources.prediction_studio.v26_1.model

Classes

Model	v26 Model — inherits all v24.2 functionality.
AsyncModel	v26 async Model — inherits all v24.2 functionality.

Module Contents

class Model(client, **payload)

Bases: _Modelv26_1Mixin, pdstools.infinity.resources.prediction_studio.base.Model

v26 Model — inherits all v24.2 functionality.

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

list_instances(return_df: Literal[False] = False) → pdstools.infinity.internal._pagination.PaginatedList[pdstools.infinity.resources.prediction_studio.base.ModelInstance]

list_instances(return_df: Literal[True] = True) → polars.DataFrame

Fetches a list of model instances for a specific model.

Parameters:

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

Returns:

A list of model instances or a DataFrame.

Return type:

PaginatedList[ModelInstance] or polars.DataFrame

class AsyncModel(client, **payload)

Bases: _Modelv26_1Mixin, pdstools.infinity.resources.prediction_studio.base.AsyncModel

v26 async Model — inherits all v24.2 functionality.

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

async list_instances(return_df: Literal[False] = False) → pdstools.infinity.internal._pagination.AsyncPaginatedList[pdstools.infinity.resources.prediction_studio.base.AsyncModelInstance]

async list_instances(return_df: Literal[True] = True) → polars.DataFrame

Fetches a list of model instances for a specific model.

Parameters:

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

Returns:

A list of model instances or a DataFrame.

Return type:

AsyncPaginatedList[AsyncModelInstance] or polars.DataFrame