Skip to content

Submission format

Paolo Milano edited this page Jun 18, 2024 · 33 revisions

Projections should be stored as a parquet file in your model-output/team-model folder.

The parquet file must use a standardised file name, and contain specific variable names and values which identify the projections you are submitting. The automatic check validates both the filename and file contents to ensure the file is correct.

File name

Each projection file within the subdirectory should have the following name format:

<round_id>-<team>-<model>.parquet

The <round_id> is defined uniquely for each submission round and disease. It is composed by the season_cycle, identifying the season and the submission cycle, and the disease indicator. The team and model in this file name must match the name of the model-output directory this file is in (and correspond to the team_abbr and model_abbr parameters in the metadata file).

File format

Required variables

The parquet file must be contain only the following columns (in any order). No additional columns are allowed.

column column type description
round_id string The id of the submission round, e.g. '2020-2025_1_FLU', composed by the season cycle ('2024_2025_1') plus the disease ('FLU'). Will be defined for each round.
scenario_id string Id of the scenario as described in the round specifications (e.g. 'A', 'B', ...)
target string One of the targets defined/allowed for the round
location ISO2 string The ISO2 code for the European country
pop_group string The age bin, or another population breakdown identifier, as defined in the round specs
horizon integer Weeks ahead from the origin date(*) corresponding to the predicted value
target_end_date date string Target date corresponding to the projected value. Values must be a date in the format YYYY-MM-DD.
output_type_id String ('1' to '100' for samples, one of the allowed quantiles for quantile output type) A string identifying i) the stochastic run for sample data, ii) the quantile for quantile data
value float The value of the prediction for the given target