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

HydroBench
==========

Overview
--------

The current HydroBench alignment uses a metadata-backed streamflow adapter over the shared synthetic flood streamflow dataset.

It is currently exercised through the HydroGraphNet smoke benchmark path.

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

.. grid:: 1 2 4 4
   :gutter: 2
   :class-container: catalog-grid

   .. grid-item-card:: Kind
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Ecosystem

      .. container:: catalog-stat-note

         Family benchmark or external ecosystem view.

   .. grid-item-card:: Hazard Family
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Flood

      .. container:: catalog-stat-note

         Public hazard grouping used on the benchmark index page.

   .. grid-item-card:: Support Status
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         :bdg-info:`Synthetic-backed`

      .. container:: catalog-stat-note

         Current maturity of the adapter or evaluator path.

   .. grid-item-card:: Linked Models
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         1

      .. container:: catalog-stat-note

         1 model


Benchmark Mapping
-----------------

**Shared benchmark key:** ``flood``

**Registered class:** ``FloodBenchmark``

Mapped benchmark family
~~~~~~~~~~~~~~~~~~~~~~~

:doc:`Flood Benchmark </benchmarks/flood_benchmark>`

Primary Source
~~~~~~~~~~~~~~

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

.. dropdown:: Supported Tasks
   :class-container: catalog-dropdown

   - Streamflow

.. dropdown:: Key Metrics
   :class-container: catalog-dropdown

   - ``mae``
   - ``rmse``
   - ``nse``
   - ``kge``

.. dropdown:: Smoke Configs
   :class-container: catalog-dropdown

   - ``hydrographnet_smoke.yaml``

.. dropdown:: Linked Models
   :class-container: catalog-dropdown

   :doc:`HydroGraphNet </modules/models_hydrographnet>`.