gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-19 05:25:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d756522eeb6d26beb6051423e78d1a9ff60fcfbd
Gymnasium/docs/api/vector.md
Mark Towers 27f8e85051 Merge v1.0.0 (#682) 
Co-authored-by: Kallinteris Andreas <30759571+Kallinteris-Andreas@users.noreply.github.com>
Co-authored-by: Jet <38184875+jjshoots@users.noreply.github.com>
Co-authored-by: Omar Younis <42100908+younik@users.noreply.github.com>
2023-11-07 13:27:25 +00:00

1.6 KiB
Raw Blame History

title
title
Vector

Vector environments

:hidden:
vector/wrappers
vector/async_vector_env
vector/sync_vector_env
vector/utils

Gymnasium.vector.VectorEnv

.. autoclass:: gymnasium.vector.VectorEnv

Methods

.. automethod:: gymnasium.vector.VectorEnv.reset
.. automethod:: gymnasium.vector.VectorEnv.step
.. automethod:: gymnasium.vector.VectorEnv.close

Attributes

.. autoattribute:: gymnasium.vector.VectorEnv.num_envs

    The number of sub-environments in the vector environment.

.. autoattribute:: gymnasium.vector.VectorEnv.action_space

    The (batched) action space. The input actions of `step` must be valid elements of `action_space`.

.. autoattribute:: gymnasium.vector.VectorEnv.observation_space

    The (batched) observation space. The observations returned by `reset` and `step` are valid elements of `observation_space`.

.. autoattribute:: gymnasium.vector.VectorEnv.single_action_space

    The action space of a sub-environment.

.. autoattribute:: gymnasium.vector.VectorEnv.single_observation_space

    The observation space of an environment copy.

.. autoattribute:: gymnasium.vector.VectorEnv.spec

    The ``EnvSpec`` of the environment normally set during :py:meth:`gymnasium.make_vec`

Additional Methods

.. autoproperty:: gymnasium.vector.VectorEnv.unwrapped
.. autoproperty:: gymnasium.vector.VectorEnv.np_random

Making Vector Environments

To create vector environments, gymnasium provides :func:`gymnasium.make_vec` as an equivalent function to :func:`gymnasium.make`.