Skip to content

Competition.evaluation

polaris.evaluate.CompetitionPredictions

Bases: BenchmarkPredictions, ResultsMetadataV1

Predictions for competition benchmarks.

This object is to be used as input to PolarisHubClient.submit_competition_predictions. 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 metadata that describes a predictions object.

Attributes:

Name Type Description
name SlugCompatibleStringType

A slug-compatible name for the artifact. It is redeclared here to be required.
owner HubOwner

A slug-compatible name for the owner of the artifact. It is redeclared here to be required.
report_url HubOwner

A URL to a report/paper/write-up which describes the methods used to generate the predictions.