poprox_storage.concepts.experiment#

Classes

`Assignment`(*[, assignment_id, opted_out])
`Experiment`(*[, experiment_id, dataset_id, owner])
`Group`(*[, group_id])
`Phase`(*[, phase_id])
`Recommender`(*[, recommender_id])
`Team`(*[, team_id])
`Treatment`(*[, treatment_id, template])

class poprox_storage.concepts.experiment.Team(*, team_id=None, team_name, members)#

Bases: BaseModel

Parameters:

team_id (UUID)
team_name (str)
members (list[UUID])

class poprox_storage.concepts.experiment.Experiment(**data)#

Bases: BaseModel

Parameters:

data (Any)
experiment_id (UUID)
dataset_id (UUID | None)
owner (Team | None)
description (str)
start_date (date)
end_date (date)
phases (list[Phase])

property recommenders#

Deduplicates the experiment recommenders

Since dictionaries maintain insertion order, adding the recommenders to a dictionary and then grabbing the values de-duplicates them without changing the order

Returns:: Unique experiment recommenders
Return type:: List[Recommender]

property groups#

Deduplicates the experiment groups

Since dictionaries maintain insertion order, adding the groups to a dictionary and then grabbing the values de-duplicates them without changing the order

Returns:: Unique experiment groups
Return type:: List[Group]

class poprox_storage.concepts.experiment.Treatment(**data)#

Bases: BaseModel

Parameters:

data (Any)
treatment_id (UUID)
group (Group)
recommender (Recommender)
template (str | None)

class poprox_storage.concepts.experiment.Group(*, group_id=None, name, minimum_size)#

Bases: BaseModel

Parameters:

group_id (UUID)
name (str)
minimum_size (Annotated[int, Gt(gt=0)])

class poprox_storage.concepts.experiment.Recommender(*, recommender_id=None, name, url)#

Bases: BaseModel

Parameters:

recommender_id (UUID)
name (str)
url (str)

class poprox_storage.concepts.experiment.Phase(*, phase_id=None, name, start_date, end_date, treatments)#

Bases: BaseModel

Parameters:

phase_id (UUID)
name (str)
start_date (date)
end_date (date)
treatments (list[Treatment])

class poprox_storage.concepts.experiment.Assignment(*, assignment_id=None, account_id, group_id, opted_out=False)#

Bases: BaseModel

Parameters:

assignment_id (UUID)
account_id (UUID)
group_id (UUID)
opted_out (bool)