:py:mod:`rofunc.learning.RofuncRL.utils.stb3_utils`
===================================================

.. py:module:: rofunc.learning.RofuncRL.utils.stb3_utils

.. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`StableBaseline3Wrapper <rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper>`
     - .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper
          :summary:

API
~~~

.. py:class:: StableBaseline3Wrapper(env: typing.Any, auto_reset_after_done: bool = True)
   :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper

   Bases: :py:obj:`stable_baselines3.common.vec_env.VecEnv`

   .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.__init__

   .. py:method:: step(actions: torch.Tensor) -> typing.Tuple[torch.Tensor, torch.Tensor, torch.Tensor, typing.Any]
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step

   .. py:method:: reset(env_idxs=False) -> torch.Tensor
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.reset

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.reset

   .. py:method:: render(*args, **kwargs) -> None
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.render

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.render

   .. py:method:: close() -> None
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.close

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.close

   .. py:method:: step_async(actions)
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step_async

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step_async

   .. py:method:: step_wait()
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step_wait

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.step_wait

   .. py:method:: get_attr(attr_name, indices=None)
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.get_attr

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.get_attr

   .. py:method:: set_attr(attr_name, value, indices=None)
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.set_attr

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.set_attr

   .. py:method:: env_method(method_name, *method_args, indices=None, **method_kwargs)
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.env_method

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.env_method

   .. py:method:: seed(seed)
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.seed

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.seed

   .. py:method:: env_is_wrapped()
      :canonical: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.env_is_wrapped

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.utils.stb3_utils.StableBaseline3Wrapper.env_is_wrapped