.. _utils_run-index:

=========
Utils Run
=========

Callbacks
=========
.. automodule:: commonroad_rl.utils_run.callbacks

``HyperparamsTrialEvalCallback`` class
--------------------------------------
.. autoclass:: HyperparamsTrialEvalCallback
   :members:
   :member-order: bysource
   :inherited-members:

``ObservationConfigsTrialEvalCallback`` class
---------------------------------------------
.. autoclass:: ObservationConfigsTrialEvalCallback
   :members:
   :member-order: bysource
   :inherited-members:
   

``RewardConfigsTrialEvalCallback`` class
----------------------------------------
.. autoclass:: RewardConfigsTrialEvalCallback
   :members:
   :member-order: bysource
   :inherited-members:

``MultiEnvsEvalCallback`` class
-------------------------------
.. autoclass:: MultiEnvsEvalCallback
   :members:
   :member-order: bysource
   :inherited-members:

``SaveVecNormalizeCallback`` class
----------------------------------
.. autoclass:: SaveVecNormalizeCallback
   :members:
   :member-order: bysource
   :inherited-members:

Hyperparams Opt
===============
.. automodule:: commonroad_rl.utils_run.hyperparams_opt
   :members:
   :member-order: bysource

Noise
=====
.. automodule:: commonroad_rl.utils_run.noise

``LinearNormalActionNoise`` class
---------------------------------
.. autoclass:: LinearNormalActionNoise
   :members:
   :member-order: bysource

Observation Configs Opt
=======================
.. automodule:: commonroad_rl.utils_run.observation_configs_opt
   :members:
   :member-order: bysource

Plot
====
.. automodule:: commonroad_rl.utils_run.plot
   :members:
   :undoc-members:
   :member-order: bysource


Record Video
============
.. automodule:: commonroad_rl.utils_run.record_video
   :members:
   :undoc-members:
   :member-order: bysource

Reward Configs Opt
==================
.. automodule:: commonroad_rl.utils_run.reward_configs_opt
   :members:
   :undoc-members:
   :member-order: bysource

Split Dataset
=============
.. automodule:: commonroad_rl.utils_run.split_dataset
   :members:
   :undoc_members:
   :member-order: bysource

Utils
=====
.. automodule:: commonroad_rl.utils_run.utils
   :members:
   :member-order: bysource

Vectorized Env
==============
.. automodule:: commonroad_rl.utils_run.vec_env

``CommonRoadVecEnv`` class
--------------------------
.. autoclass:: CommonRoadVecEnv
   :members:
   :member-order: bysource

Wrappers
========
.. automodule:: commonroad_rl.utils_run.wrappers

``DoneOnSuccessWrapper`` class
------------------------------
.. autoclass:: DoneOnSuccessWrapper
   :members:
   :member-order: bysource

``TimeFeatureWrapper`` class
----------------------------
.. autoclass:: TimeFeatureWrapper
   :members:
   :member-order: bysource