-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdata.qmd
More file actions
117 lines (86 loc) · 5.31 KB
/
Copy pathdata.qmd
File metadata and controls
117 lines (86 loc) · 5.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
---
title: '<i class="bi bi-compass"></i> Data standards'
pagetitle: "Data standards"
---
:::{.callout-tip}
We have a [tool suite](software.qmd) that is designed to work with data from any
hub.
:::
[{{< fa compass-drafting >}} Model Tasks Schema](https://docs.hubverse.io/en/latest/user-guide/hub-config.html#model-tasks-schema){.btn .btn-outline-dark .ms-auto}
[{{< fa bullseye >}} Target Data Formats](https://docs.hubverse.io/en/latest/user-guide/target-data.html){.btn .btn-outline-dark .ms-auto}
[{{< fa file-circle-check>}} Model Output Formats](https://docs.hubverse.io/en/latest/user-guide/model-output.html){.btn .btn-outline-dark .ms-auto}
The core of the hubverse are the **robust and flexible data standards** that
allow administrators to write **structured guidelines** for tabular model
output submissions that can be **easily validated, ensembled, and visualized**.
{alt='diagram showing hubverse-org/schemas pointing to both tasks.json and admin.json. tasks.json points to model output and target data with the label "data validation". admin.json points to a box that shows contact information, file formats, and data storage'}
## Understanding Model Tasks
Each hub starts with a file called `hub-config/tasks.json` that defines [**model tasks**](https://docs.hubverse.io/en/latest/user-guide/tasks.html) and **frequency of submission**. The structure of this file is defined by [the hubverse model tasks schema](https://docs.hubverse.io/en/latest/user-guide/hub-config.html#model-tasks-schema).
The `tasks.json` file is responsible for validation of all model submissions
and ensures that data are inter-operable.
A model task defines the expected content of a
tabular model submission against one or more modeling targets. It includes
three properties:
1. [**Task ID
variables**](https://docs.hubverse.io/en/latest/user-guide/tasks.html#usage-of-task-id-variables):
a collection of variables and their expected values used for modeling
efforts (for example: `target` (incident hospitalizations), `location`
(Massachusetts), `reference_date` (2025-04-16), and `horizon` (-1))
2. [**Output
types**](https://docs.hubverse.io/en/latest/user-guide/tasks.html#output-types):
The method modelers should use to summarize the results of their modeling
efforts (for example: the `quantile` probabilities 0.01, 0.025, 0.5, 0.975, 0.99)
3. [**Target
metadata**](https://docs.hubverse.io/en/latest/user-guide/tasks.html#target-metadata):
The characteristics of the value modelers are trying to predict (for example,
incident hospitalizations represent weekly step-ahead continuous count data)
## Model Output
Model outputs are _provided by modeling teams_. The hubverse does not limit how
models are constructed or what software they are run in. The only requirement is
that the model output must be in a tabular format (specified in the hub's
`admin.json` file).
The model output format is a tabular representation of model output defined by
the [Model Tasks](#understanding-model-tasks) for a given hub. You can find examples of model
output and more in the [model output formats
page](https://docs.hubverse.io/en/latest/user-guide/model-output.html) of the
official documentation.
## Target Data
The target data are represented in two files: [`time-series`](https://docs.hubverse.io/en/latest/user-guide/target-data.html#time-series) and
[`oracle-outputs`](https://docs.hubverse.io/en/latest/user-guide/target-data.html#oracle-output)[^1]. Each data format is
useful for different purposes (see table below). Modelers will most often
estimate model parameters by fitting to the raw data in time series format.
| Data Format | Model Estimation | Plotting | Evaluation |
|:--------------|:-----------------|:---------|:-----------|
| Time series | ✅ | ✅ | |
| Oracle output | | ✅ | ✅ |
: Common uses for target time series and oracle output data. A ✅
indicates which data formats are most commonly used for each purpose.
You can read more in the [target data page](https://docs.hubverse.io/en/latest/user-guide/target-data.html) of the official documentation.
[^1]: oracle outputs are generated from time series
## Data Storage (GitHub, AWS)
All hub data are stored within the hub itself and submissions are commonly
managed through GitHub.
The hubverse team currently provides cloud hosting for hubs. A "cloud-enabled"
hub is one that mirrors its data and configuration to an Amazon Web Services
(AWS) S3 bucket. By default, the current hub directories are synced in
near-real-time to AWS:
- auxiliary-data
- hub-config
- model-abstracts
- model-metadata
- model-output
- target-data
If you are interested in storing your data on AWS S3, please consult the [AWS
onboarding
guide](https://docs.hubverse.io/en/latest/developer/cloud-onboarding.html)
:::: {.page-nav}
::: {.prev-page}
[‹](/quickstart/develop.qmd){.prev-arrow}
[Previous](/quickstart/develop.qmd){.prev-label}
[**Develop software**](/quickstart/develop.qmd){.prev-title}
:::
::: {.next-page}
[Next](/tools/software.qmd){.next-label}
[›](/tools/software.qmd){.next-arrow}
[**Software**](/tools/software.qmd){.next-title}
:::
::::