Back to Ray

MultiAgentEpisode API

doc/source/rllib/package_ref/env/multi_agent_episode.rst

1.13.11.8 KB
Original Source

.. include:: /_includes/rllib/we_are_hiring.rst

.. _multi-agent-episode-reference-docs:

MultiAgentEpisode API

.. include:: /_includes/rllib/new_api_stack.rst

rllib.env.multi_agent_episode.MultiAgentEpisode

.. currentmodule:: ray.rllib.env.multi_agent_episode

Constructor


.. autosummary::
    :nosignatures:
    :toctree: env/

    ~MultiAgentEpisode
    ~MultiAgentEpisode.validate

Getting basic information

.. autosummary:: :nosignatures: :toctree: env/

~MultiAgentEpisode.__len__
~MultiAgentEpisode.get_return
~MultiAgentEpisode.get_duration_s
~MultiAgentEpisode.is_done
~MultiAgentEpisode.is_numpy
~MultiAgentEpisode.env_steps
~MultiAgentEpisode.agent_steps

Multi-agent information

.. autosummary::
    :nosignatures:
    :toctree: env/

    ~MultiAgentEpisode.module_for
    ~MultiAgentEpisode.get_agents_to_act
    ~MultiAgentEpisode.get_agents_that_stepped

Getting environment data

.. autosummary:: :nosignatures: :toctree: env/

~MultiAgentEpisode.get_observations
~MultiAgentEpisode.get_infos
~MultiAgentEpisode.get_actions
~MultiAgentEpisode.get_rewards
~MultiAgentEpisode.get_extra_model_outputs
~MultiAgentEpisode.get_terminateds
~MultiAgentEpisode.get_truncateds

Adding data

.. autosummary::
    :nosignatures:
    :toctree: env/

    ~MultiAgentEpisode.add_env_reset
    ~MultiAgentEpisode.add_env_step

Creating and handling episode chunks

.. autosummary:: :nosignatures: :toctree: env/

~MultiAgentEpisode.cut
~MultiAgentEpisode.slice
~MultiAgentEpisode.concat_episode
~MultiAgentEpisode.to_numpy