Online API Documentation
======================================================================

.. toctree::
   :caption: Contents:

   Rollout <rollout>
   Replay Buffer <replay_buffer>
   Trainer <trainer>
   Utils <utils>

Rollout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Env Worker 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.env_worker
   :members:

Episode Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.episode_statistics
   :members:

Rollout Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.rollout_manager
   :members:

Rollout Worker
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.rollout_worker
   :members:

Start Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.start_manager
   :members:

Replay Buffer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Actor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.replay_buffer.actor
   :members:

Fragment Store
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.replay_buffer.fragment_store
   :members:

Replay Buffer Interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.rollout.replay_buffer.interface
   :members:

Trainer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Base Trainer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: minestudio.online.trainer.basetrainer
   :members:

PPO Trainer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.trainer.ppotrainer
   :members:

Start Trainer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: minestudio.online.trainer.start_trainer
   :members:

Utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Rollout Utils
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: minestudio.online.utils.rollout.datatypes
   :members:

.. automodule:: minestudio.online.utils.rollout.monitor
   :members:

Trainer Utils
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: minestudio.online.utils.train.data
   :members:

.. automodule:: minestudio.online.utils.train.gae
   :members:

.. automodule:: minestudio.online.utils.train.training_session
   :members:

.. automodule:: minestudio.online.utils.train.wandb_logger
   :members: