ElectionFamily

ElectionFamily#

class ElectionFamily(culture_id: str | None = None, family_id: str = 'none', params: dict | None = None, size: int = 1, label: str | None = None, color: str = 'black', alpha: float = 1.0, ms: int = 20, show: bool = True, marker: str = 'o', starting_from: int = 0, path: dict | None = None, single: bool = False, instance_type=None, num_candidates: int | None = None, num_voters: int | None = None, election_ids=None, frequency_matrix=None, is_temporary: bool = False, **kwargs)[source]#

Family of elections: a set of elections from the same election pseudo_culture_id

prepare_family(experiment_id=None, is_exported=True, export_points=False, is_aggregated=True, instance_type=None) → list | None[source]#

Prepares the family of elections.

Parameters:

  • experiment_id (str) – Experiment ID.

  • is_exported (bool) – Whether to export the family.

  • export_points (bool) – Whether to store the points.

  • is_aggregated (bool) – Whether the family is aggregated.

  • instance_type (str) – Type of the instance.

Returns:

List of elections.

Return type:

list | None

Contents