Skip to content

Competition.evaluation

polaris.evaluate.CompetitionPredictions

Bases: ResultsMetadata, BenchmarkPredictions

Predictions for competition benchmarks.

This object is to be used as input to CompetitionSpecification.evaluate. It is used to ensure that the structure of the predictions are compatible with evaluation methods on the Polaris Hub. In addition to the predictions, it contains additional meta-data to create a results object.

Attributes:

Name Type Description
access AccessType

The access the returned results should have

polaris.evaluate.CompetitionResults

Bases: EvaluationResult

Class specific to results for competition benchmarks.

This object is returned by CompetitionSpecification.evaluate. In addition to the metrics on the test set, it contains additional meta-data and logic to integrate the results with the Polaris Hub.

Attributes:

Name Type Description
competition_name SlugCompatibleStringType

The name of the competition for which these results were generated. Together with the competition owner, this uniquely identifies the competition on the Hub.
competition_owner HubOwner | None

The owner of the competition for which these results were generated. Together with the competition name, this uniquely identifies the competition on the Hub.