Hubverse Annotator

[!IMPORTANT] This project is currently IN PROGRESS. As such, there may be parts of this repository that are desired but non-existent or that may not work as smoothly as we want!

Background

The hubverse-annotator (hereafter, annotator) is a Python streamlit application designed to aid CFA's Short Term Forecasts (STF) team with forecast reviews.

The annotator is designed for:

• Visualization of model forecasts and data across location, target, reference date, and model.
• Selection and exportation of data points for exclusion or comment.
• Selection and exportation of model forecasts for submission to forecast hubs.

Usage

The annotator can be run by:

• git clone https://github.com/CDCgov/hubverse-annotator
• cd hubverse-annotator
• uv run streamlit run ./hubverse_annotator/app.py

The annotator is designed to work with hubverse data. Examples of this data are available in the COVID-19 Forecast Hub.

• Observed Data File: see https://github.com/CDCgov/covid19-forecast-hub/blob/main/target-data/time-series.parquet
• COVID-19 Hubverse Forecasts File: see https://github.com/CDCgov/covid19-forecast-hub/tree/main/model-output

The following is a demonstration of the annotator as a tool for visualization :

When using the annotator, there are shortcuts to help step through selections faster:

| Selection | Previous | Next | | --------- | -------- | ---- | | Location | j | k | | Reference Date | , | . | | Target | n | m |

[!NOTE] We recommend using Blink-based (Chrome) or WebKit-based (Safari) browsers with the annotator, as some features (e.g. shortcut-key bindings) are not supported in Gecko-based (Firefox) browsers.

CDCgov GitHub Organization Protocols

General disclaimer This repository was created for use by CDC programs to collaborate on public health related projects in support of the CDC mission. GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

Related documents

• Open Practices
• Rules of Behavior
• Thanks and Acknowledgements
• Disclaimer
• Contribution Notice
• Code of Conduct

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Additional Standard Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.