Skip to content

Competition

polaris.competition.CompetitionSpecification

Bases: BenchmarkSpecification

Much of the underlying data model and logic is shared across Benchmarks and Competitions, and anything within this class serves as a point of differentiation between the two.

Attributes:

Name Type Description
owner HubOwner

A slug-compatible name for the owner of the competition. This is redefined such that it is required.

start_time datetime | None

The time at which the competition becomes active and interactable.

end_time datetime | None

The time at which the competition ends and is no longer interactable.

evaluate

evaluate(predictions: CompetitionPredictions, settings: Optional[PolarisHubSettings] = None, cache_auth_token: bool = True, **kwargs: dict)

Light convenience wrapper around PolarisHubClient.evaluate_competition.