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

TropiCycloneNet-Dataset
=======================

Synthetic-backed storm-track benchmark adapter aligned to the TropiCycloneNet-Dataset ecosystem.

Overview
--------

TropiCycloneNet-Dataset is the public storm adapter used by the TropiCycloneNet model path on the shared track-intensity evaluator.

The current implementation is synthetic-backed, but it preserves the task, metric, and reporting surface used by the shared tropical cyclone benchmark.

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

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

   * - Provider
     - TropiCycloneNet-Dataset ecosystem surfaced through a PyHazards adapter
   * - Hazard Family
     - Tropical Cyclone
   * - Source Role
     - Track Benchmark
   * - Coverage
     - Benchmark-aligned tropical cyclone track and intensity samples
   * - Geometry
     - Storm-track history sequences
   * - Spatial Resolution
     - Storm-centered best-track sequences
   * - Temporal Resolution
     - Historical track windows with forecast horizons
   * - Update Cadence
     - Generated locally for smoke and benchmark-alignment runs
   * - Period of Record
     - Synthetic-backed benchmark adapter
   * - Formats
     - PyTorch tensors via the dataset registry
   * - Registry Entry
     - ``tropicyclonenet_dataset``

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

- Storm-history sequences with future latitude, longitude, and intensity targets.
- Registry-backed benchmark adapter rather than a raw external dataset ingestion path.
- Intended for benchmark-linked storm forecasting smoke runs.

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

- TropiCycloneNet smoke tests.
- Shared tropical cyclone benchmark runs.
- Regression checks for track-intensity prediction models.

Access
------

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

- `TropiCycloneNet-Dataset repository <https://github.com/xiaochengfuhuo/TropiCycloneNet-Dataset>`_

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

Use this adapter when you want the public TropiCycloneNet-Dataset-aligned storm surface exposed by the tropical cyclone benchmark.

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

Primary dataset name: ``tropicyclonenet_dataset``

.. code-block:: python

   from pyhazards.datasets import load_dataset

   data = load_dataset(
       "tropicyclonenet_dataset",
       micro=True,
       history=6,
       horizon=5,
   ).load()

   train = data.get_split("train")
   print(train.inputs.shape, train.targets.shape)

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

**Benchmarks:** :doc:`Tropical Cyclone Benchmark </benchmarks/tropical_cyclone_benchmark>`, :doc:`TropiCycloneNet-Dataset </benchmarks/tropicyclonenet_dataset>`

**Representative Models:** :doc:`TropiCycloneNet </modules/models_tropicyclonenet>`

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 TropiCycloneNet-Dataset downloader.

Reference
---------

- `TropiCycloneNet-Dataset <https://github.com/xiaochengfuhuo/TropiCycloneNet-Dataset>`_.