Back to Ray

SingleAgentEpisode API

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

1.13.11.5 KB
Original Source

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

.. _single-agent-episode-reference-docs:

SingleAgentEpisode API

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

rllib.env.single_agent_episode.SingleAgentEpisode

.. currentmodule:: ray.rllib.env.single_agent_episode

Constructor


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

    ~SingleAgentEpisode
    ~SingleAgentEpisode.validate

Getting basic information

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

~SingleAgentEpisode.__len__
~SingleAgentEpisode.get_return
~SingleAgentEpisode.get_duration_s
~SingleAgentEpisode.is_done
~SingleAgentEpisode.is_numpy
~SingleAgentEpisode.env_steps

Getting environment data

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

    ~SingleAgentEpisode.get_observations
    ~SingleAgentEpisode.get_infos
    ~SingleAgentEpisode.get_actions
    ~SingleAgentEpisode.get_rewards
    ~SingleAgentEpisode.get_extra_model_outputs

Adding data
~~~~~~~~~~~
.. autosummary::
    :nosignatures:
    :toctree: env/

    ~SingleAgentEpisode.add_env_reset
    ~SingleAgentEpisode.add_env_step

Creating and handling episode chunks

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

~SingleAgentEpisode.cut
~SingleAgentEpisode.slice
~SingleAgentEpisode.concat_episode
~SingleAgentEpisode.to_numpy