.. _api:

API
===

This documentation provides an overview of the API for :code:`jaxer`.

Modules Overview
----------------

- :ref:`run`: contains endpoints related to trainers and agent.
- :ref:`utils`: provides utility functions (e.g. dataset, plotting, etc.).
- :ref:`config`: contains configuration settings for :code:`jaxer`.
- :ref:`models`: contains the flax transformer model and its internal blocks.

.. _run:

Run
---

.. automodule:: jaxer.run
   :members:
   :show-inheritance:

.. _utils:

Utils
-----

.. automodule:: jaxer.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. _config:

Config
------

.. automodule:: jaxer.config
   :members:
   :show-inheritance:

.. _models:

Models
------

.. automodule:: jaxer.model
   :members:
   :show-inheritance: