Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 6.11 KB

NEWS.md

File metadata and controls

62 lines (43 loc) · 6.11 KB

v5.0.0

This release contains the following changes:

  • Added explicit checks of round_id format through a regex pattern check to the round.round_id property when round.round_id_from_variable is false. This provides upfront validation of the expected format of manual round IDs (i.e. those not source from a task ID) (#112).
  • BREAKING CHANGE: Restricted the target_keys object to contain only a single key value pair (if not null). This means that target keys can now only consist of a single value from a single task ID (#117).
  • BREAKING CHANGE: Removed target_variable and target_outcome from standard task ID properties.

v4.0.0

  • BREAKING CHANGE: Introduction of is_required boolean property at the output_type level to configure whether the output type is required for submissions to be considered valid (#99).
  • BREAKING CHANGE: Disallowed optional property in output_type_id objects. As such, when a given output type is submitted, values for all output type IDs much be submitted (#100,#101, #102).
  • BREAKING CHANGE: To improve cross-platform interoperability, expectation of missing values in point estimate output_type_id required properties now encoded with null instead of ["NA"] (#109).
  • Introduction of optional derived_task_ids properties to enable hub administrators to define derived task IDs (i.e. task IDs whose values depend on the values of other task IDs). The higher level derived_task_ids property sets the property globally at the hub level but can be overriden by the round level derived_task_ids property. The property allows for primarily validation functionality to ignore such task IDs when appropriate which can significantly improve validation efficency (#96). For more information see hubValidations documentation on ignoring derived task IDs.
  • Added more specific schema for target_keys to ensure only string properties are allowed (#97)
  • Removed the requirement for a minimum value of zero in cdf numeric output_type_ids (#113).
  • Ensured that additional properties are not allowed in lower level properties (e.g. individual task IDs, output_type objects etc). Custom additional properties are only allowed at the round level, while additional task ID objects that match the expected task ID schema are allowed in the task_ids object (#114).

v3.0.1

  • Introduction of optional output_type_id_datatype property to enable hub administrators to configure and communicate the output_type_id column data type at a hub level. This will allow hubs to override default behaviour of automatically determinining the simplest data type that can accomodate output type IDs across all output types when creating hub schema. The setting is also useful for administrators to future proof the output_type_id column from potential issues arising by changes in data type, introduced by new output types after submissions have begun, by setting output_type_id_datatype to the simplest data type from the start, i.e. character (#87).
  • Removed restrictive epidemic week formatting requirements for CDF output_type_id values. Character output type IDs no longer need to conform to the regex pattern ^EW[0-9]{6} (e.g. "EW202240") (#80).

v3.0.0

  • Breaking change: introduction of new sample output type id schema specification in tasks.json. The main breaking change is the removal of the output_type_id property in sample. Instead, the collection of samples is defined through a new output_type_id_params object (#70).
  • Breaking change: The repository_url and repository_host properties in admin.json have been deprecated in favour of a sigle repository object with separate host, owner and name properties (#67).
  • Breaking change: The optional hub_models property in admin.json has been removed as it's schema could create conflicts with the model_abbr and team_abbr schema specification in the hub administered `model-metadata-schema.json (#77).
  • Additional properties are now allowed at the round item property level (#74).
  • Host organisation name changed in schema id properties to hubverse-org throughout all schema versions.

v2.0.1

  • Non-breaking change: introduced an optional cloud group to admin-schema.json to support cloud-enabled Hubs:
    • cloud group includes a boolean enabled property to indicate whether or not the hub will store data in the cloud.
    • cloud.host is an object with properties that describe the cloud storage provider and location. It is required when cloud.enabled is true.

v2.0.0

  • Major breaking change: Output type property type_id renamed to output_type_id for consistency in with changes in model output data.
  • Added uniqueItem checks to all optional and required arrays.
  • Added a schema to task_ids additionalProperty property instead of just setting it to true. This schema ensures that any custom task IDs added by hub administrators at least checked for being objects and having optional and required properties that are either arrays or null.
  • Added standard task IDs forecast_date (equivalent to origin_date), target_end_date (equivalent to target_date) and target_variable & target_outcome which can be used to split targets across two task IDs.

v1.0.0

  • Major breaking change: categorical output type renamed to pmf for consistency in terminology.
  • Target type "categorical" also renamed to "nominal".
  • Minor bug fixes and consistency improvements.
  • Added NEWS.md for recording changes to schema.

v0.0.1

  • First stable version of schema for use with Hubs
  • Important properties introduced:
    • schema_version (required) to link a given congif file to a specific config file schema.
    • target_metadata (required) objects to append metadata about targets to model tasks.
    • file_format (required in admin-schema.json and optional within tasks-schema.json rounds) to specify accepted file formats of model output file submissions.
  • Removed model-schema.json. Examples of these will live in hubTemplate repositories and defined by hub administrators.