pdstools.infinity.resources.prediction_studio.v24_2.prediction._async

Classes

AsyncPrediction

Async variant of the v24.2 Prediction.

Module Contents

class AsyncPrediction(client, *, predictionId: str, label: str, status: str, lastUpdateTime: str, objective: str | None = None, subject: str | None = None)

Bases: pdstools.infinity.resources.prediction_studio.v24_2.prediction._mixin._PredictionV24_2Mixin, pdstools.infinity.resources.prediction_studio.v24_1.prediction.AsyncPrediction

Async variant of the v24.2 Prediction.

Parameters:

  • predictionId (str)

  • label (str)

  • status (str)

  • lastUpdateTime (str)

  • objective (str | None)

  • subject (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 prediction.

Parameters:

  • category ({"All", "Responses", "Performance", "Model approval", "Output", "Predictors", "Prediction deployment", "Generic"} or None) – 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 get_champion_challengers()

Fetches list of ChampionChallenger objects linked to the prediction.

Returns:

Champion-challenger pairs from a prediction.

Return type:

list of AsyncChampionChallenger

async add_conditional_model(new_model, category: str, context: str | None = None)

Incorporates a new model into a prediction for a specified category and context.

Parameters:

  • new_model (str or AsyncModel) – Identifier of the model to be added.

  • category (str) – The category under which the model will be classified.

  • context (str, optional) – The specific context or scenario.

Returns:

An object detailing the updated configuration.

Return type:

AsyncChampionChallenger