.. _api:

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

This section contains the API reference for the shared utilities in ``src.common``.

.. currentmodule:: src.common


Common Utilities Package
------------------------

.. automodule:: src.common
   :no-members:
   :no-inherited-members:
   :no-special-members:
   :no-undoc-members:

Base Trainer
------------

.. autosummary::
  :toctree: generated/
  :template: class.rst

   BaseTrainer

Configuration Management
-------------------------

.. autosummary::
  :toctree: generated/

   read_config
   make_config
   save_config
   DataConfig
   OutputConfig

Data Loading
------------

.. autosummary::
  :toctree: generated/
  :template: class.rst

   WSDataLoader

Evaluation
----------

.. autosummary::
  :toctree: generated/
  :template: class.rst

   Evaluator

Hyperparameter Tuning
----------------------

.. autosummary::
  :toctree: generated/

   tune_hyperparameters

Utilities
---------

.. autosummary::
  :toctree: generated/

   set_seed
   get_device
   ensure_dir
   save_json
   load_json
   Timer