:py:mod:`rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole`
=================================================================

.. py:module:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole

.. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`CartpoleOmniTask <rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask>`
     - .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask
          :summary:

API
~~~

.. py:class:: CartpoleOmniTask(name, sim_config, env, offset=None)
   :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask

   Bases: :py:obj:`rofunc.learning.RofuncRL.tasks.omniisaacgym.base.rl_task.RLTask`

   .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.__init__

   .. py:method:: update_config(sim_config)
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.update_config

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.update_config

   .. py:method:: set_up_scene(scene) -> None
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.set_up_scene

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.set_up_scene

   .. py:method:: initialize_views(scene)
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.initialize_views

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.initialize_views

   .. py:method:: get_cartpole()
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.get_cartpole

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.get_cartpole

   .. py:method:: get_observations() -> dict
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.get_observations

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.get_observations

   .. py:method:: pre_physics_step(actions) -> None
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.pre_physics_step

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.pre_physics_step

   .. py:method:: reset_idx(env_ids)
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.reset_idx

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.reset_idx

   .. py:method:: post_reset()
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.post_reset

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.post_reset

   .. py:method:: calculate_metrics() -> None
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.calculate_metrics

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.calculate_metrics

   .. py:method:: is_done() -> None
      :canonical: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.is_done

      .. autodoc2-docstring:: rofunc.learning.RofuncRL.tasks.omniisaacgymenv.cartpole.CartpoleOmniTask.is_done