Skip to content

Commit 8fd5a37

Browse files
O957sbidari
andauthored
Support Model Designation By Target (#1501)
* add model targets designation * add readme update * update schema * Update hub-config/model-metadata-schema.json * Apply suggestions from code review --------- Co-authored-by: Subekshya Bidari <37636707+sbidari@users.noreply.github.com>
1 parent 6ce9ef3 commit 8fd5a37

2 files changed

Lines changed: 29 additions & 1 deletion

File tree

hub-config/model-metadata-schema.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,20 @@
8080
]
8181
},
8282
"designated_model": {
83-
"description": "Team-specified indicator for whether the model should be eligible for inclusion in a Hub ensemble and public visualization. A team may designate up to two models.",
83+
"description": "Team-specified indicator for whether the model should be eligible for inclusion in a Hub ensemble and public visualization. A team may designate up to two models. Designation applies to every target the model submits unless narrowed by 'designated_targets'.",
8484
"type": "boolean"
8585
},
86+
"designated_targets": {
87+
"description": "Optional list of target names for which this model is designated. When present, 'designated_model=true' applies only to listed targets. When absent or empty, a designated model is eligible for every target it submits. Has no effect when 'designated_model' is false.",
88+
"type": "array",
89+
"items": {
90+
"type": "string",
91+
"enum": [
92+
"wk inc covid hosp",
93+
"wk inc covid prop ed visits"
94+
]
95+
}
96+
},
8697
"citation": {
8798
"description": "One or more citations for this model",
8899
"type": "string",

model-metadata/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ One of the following [accepted licenses](https://github.com/CDCgov/covid19-forec
6868

6969
A team-specified boolean indicator (`true` or `false`) for whether the model should be considered eligible for inclusion in Hub ensembles and public visualizations. A team may specify up to two models as `designated_model`s for inclusion. Models which have a designated_model value of `false` will still be included in internal forecasting Hub evaluations, but not in published ensembles and visualizations.
7070

71+
Designation applies to every target the model submits unless narrowed by the optional `designated_targets` field (see [Optional fields](#optional-fields)).
72+
7173
### `data_inputs`
7274

7375
List or description of the data sources used to inform the model, in particular any dataset used that are not the [target datasets](../README.md#target-data-source) of epiweekly incident COVID-19 hospital admissions reported to NHSN or epiweekly incident emergency department visits due to COVID-19 reported to NSSP.
@@ -95,8 +97,23 @@ A boolean value (`true` or `false`) that indicates whether a model is an ensembl
9597
The url of a website with additional information about your model, such as detailed methods, visualizations, or interactive dashboards.
9698

9799
## Optional fields
100+
98101
The following metadata fields are optional, but encouraged.
99102

103+
### `designated_targets`
104+
105+
A list of target names for which the model is designated. When present, narrows the effect of `designated_model: true` to only the listed targets. When absent or empty, a designated model is eligible for every target it submits. Has no effect when `designated_model` is `false`. Example:
106+
107+
```
108+
designated_targets: ["wk inc covid hosp"]
109+
```
110+
111+
or for multiple targets:
112+
113+
```
114+
designated_targets: ["wk inc covid hosp", "wk inc covid prop ed visits"]
115+
```
116+
100117
### `model_version`
101118
An identifier of the version of the model. We recommend [semantic versioning](https://semver.org/) style: `X.Y` or `X.Y.Z`, so `1.2` for version 1.2.
102119

0 commit comments

Comments
 (0)