API Reference
=============

This document describes the helper functions and classes provided by AccelHydra.

Models
------

.. automodule:: accel_hydra.models.common
   :members:
   :undoc-members:
   :show-inheritance:

Trainer Components
------------------

.. autoclass:: accel_hydra.trainer.Trainer
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex:

.. autoclass:: accel_hydra.trainer.MetricMonitor
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex:

.. autoclass:: accel_hydra.trainer.LoggingConfig
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex:

.. autoclass:: accel_hydra.trainer.CheckpointMixin
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex:

Training Launcher
-----------------

.. automodule:: accel_hydra.train_launcher
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

Data Utilities
~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.data
   :members:
   :undoc-members:
   :show-inheritance:

Configuration Utilities
~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.config
   :members:
   :undoc-members:
   :show-inheritance:

General Utilities
~~~~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.general
   :members:
   :undoc-members:
   :show-inheritance:

Learning Rate Scheduler Utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.lr_scheduler
   :members:
   :undoc-members:
   :show-inheritance:

PyTorch Utilities
~~~~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.torch
   :members:
   :undoc-members:
   :show-inheritance:

Accelerate Extensions
~~~~~~~~~~~~~~~~~~~~~

.. automodule:: accel_hydra.utils.accelerate
   :members:
   :undoc-members:
   :show-inheritance: