.. This file is generated by scripts/render_dataset_docs.py. Do not edit by hand.

HydroBench
==========

Synthetic-backed streamflow diagnostics adapter aligned to the HydroBench ecosystem.

Overview
--------

HydroBench is the public flood adapter used for streamflow diagnostics and HydroGraphNet-aligned benchmark runs.

The current implementation is synthetic-backed, but it preserves the streamflow task and metric contract exposed by the shared flood benchmark.

At a Glance
-----------

.. list-table::
   :widths: 28 72
   :stub-columns: 1

   * - Provider
     - HydroBench ecosystem surfaced through a PyHazards adapter
   * - Hazard Family
     - Flood
   * - Source Role
     - Streamflow Benchmark
   * - Coverage
     - Benchmark-aligned streamflow forecasting samples
   * - Geometry
     - Graph-temporal basin or node sequences
   * - Spatial Resolution
     - Basin or gauge nodes represented as graph elements
   * - Temporal Resolution
     - Rolling history windows for streamflow prediction
   * - Update Cadence
     - Generated locally for smoke and benchmark-alignment runs
   * - Period of Record
     - Synthetic-backed benchmark adapter
   * - Formats
     - PyTorch graph-temporal dataset objects via the dataset registry
   * - Registry Entry
     - ``hydrobench_streamflow``

Data Characteristics
--------------------

- Graph-temporal sequences with node-level targets for next-step streamflow prediction.
- Registry-backed benchmark adapter rather than a raw HydroBench dataset ingestion path.
- Intended for HydroGraphNet smoke runs and flood benchmark diagnostics.

Typical Use Cases
~~~~~~~~~~~~~~~~~

- HydroGraphNet smoke tests.
- Shared flood benchmark runs with HydroBench-aligned metrics.
- Diagnostics for graph-based flood forecasting experiments.

Access
------

Use the links below to access the upstream source or its public documentation.

- `HydroBench repository <https://github.com/EMscience/HydroBench>`_

PyHazards Usage
---------------

Use this adapter when you want the public HydroBench-aligned streamflow surface exposed by the flood benchmark.

Registry Workflow
~~~~~~~~~~~~~~~~~

Primary dataset name: ``hydrobench_streamflow``

.. code-block:: python

   from pyhazards.datasets import load_dataset

   data = load_dataset(
       "hydrobench_streamflow",
       micro=True,
       history=4,
       nodes=6,
   ).load()

   train = data.get_split("train")
   print(len(train.inputs), train.inputs[0].x.shape)

Related Coverage
~~~~~~~~~~~~~~~~

**Benchmarks:** :doc:`Flood Benchmark </benchmarks/flood_benchmark>`, :doc:`HydroBench </benchmarks/hydrobench>`

**Representative Models:** :doc:`HydroGraphNet </modules/models_hydrographnet>`

Inspection Workflow
-------------------

This dataset is currently surfaced as a registry-backed benchmark adapter,
so there is no standalone inspection CLI documented for it.

Notes
-----

- This is a synthetic-backed benchmark adapter rather than a full HydroBench downloader.

Reference
---------

- `HydroBench <https://github.com/EMscience/HydroBench>`_.