pdstools.infinity.resources.prediction_studio.async_base

Classes

Metrics

dict() -> new empty dictionary

Stage

dict() -> new empty dictionary

Prediction

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

Repository

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

PredictionStudioBase

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

Module Contents

class Metrics

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

lift: float
performance: float
performanceMeasure: Literal['AUC']
class Stage

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

objective: str
responseTimeoutType: str
responseTimeoutValue: int
targetLabels: List[Dict[Literal['label'], str]]
alternateLabels: List[Dict[Literal['label'], str]]
class Prediction(client, *, predictionId: str, label: str, objective: str, status: str, lastUpdateTime: str, subject: str | None = None)

Bases: pdstools.infinity.internal._resource.AsyncAPIResource, abc.ABC

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

Parameters:
  • predictionId (str)

  • label (str)

  • objective (str)

  • status (str)

  • lastUpdateTime (str)

  • subject (Optional[str])

prediction_id
label
objective
subject = None
status
last_update_time
abstract get_metric(*, metric: Literal['Performance', 'Total_responses', 'Lift', 'Success_rate'], timeframe: Literal['7d', '4w', '3m', '6m'])
Async:

Parameters:
  • metric (Literal['Performance', 'Total_responses', 'Lift', 'Success_rate'])

  • timeframe (Literal['7d', '4w', '3m', '6m'])

class Repository(client: pdstools.infinity.client.AsyncAPIClient)

Bases: pdstools.infinity.internal._resource.AsyncAPIResource, abc.ABC

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

Parameters:

client (pdstools.infinity.client.AsyncAPIClient)

name: str
property s3_url: str
Return type:

str

class PredictionStudioBase(client: pdstools.infinity.client.AsyncAPIClient)

Bases: pdstools.infinity.internal._resource.AsyncAPIResource, abc.ABC

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

Parameters:

client (pdstools.infinity.client.AsyncAPIClient)

version: str
abstract list_predictions() pdstools.infinity.internal._pagination.PaginatedList[Prediction]
Return type:

pdstools.infinity.internal._pagination.PaginatedList[Prediction]

abstract repository() Repository
Return type:

Repository