Welcome to the Hy2DL Documentation

This is the documentation for the Hy²DL Python package. The source code is available on GitHub.

In this documentation, you will find:

• A usage guide to help you get started with the library.

• A guide to the different models implemented in the library.

• A configuration reference with all available experiment arguments.

• The complete API reference for modules, classes, and functions.

Contents:

• Getting started
  • Installation
  • Data
  • Running experiments
• Configuration Arguments
  • Experiment configuration
  • Data settings
  • Training settings
  • Evaluation settings
  • Model configuration
  • Embedding networks
  • Nan-handling strategies
  • Multi-frequency LSTM (MF-LSTM)
  • Forecast model
  • Probabilistic model
  • Hybrid model
  • CAMELS US specific
• Modelzoo
  • CudaLSTM
  • LSTM-MDN
  • Hybrid models
• Hy2DL API
  • hy2dl.datasetzoo
  • hy2dl.evaluation
  • hy2dl.modelzoo
  • hy2dl.training
  • hy2dl.utils