isaaclab.benchmark
==================

.. automodule:: isaaclab.benchmark

   .. rubric:: Request and result classes

   .. autosummary::

      BenchmarkLauncherConfig
      BenchmarkOutputConfig
      BenchmarkPlayRequest
      BenchmarkResult
      BenchmarkRuntimeRequest
      BenchmarkStartupRequest
      BenchmarkTrainingRequest

   .. rubric:: Workflow functions

   .. autosummary::

      run_benchmark
      run_play_benchmark
      run_runtime_benchmark
      run_startup_benchmark
      run_training_benchmark

   .. rubric:: Benchmark framework

   .. autosummary::

      BaseIsaacLabBenchmark
      BenchmarkMonitor
      MethodBenchmarkDefinition
      MethodBenchmarkRunner
      MethodBenchmarkRunnerConfig
      PlayBundle
      RuntimeBundle
      StartupBundle
      TrainingBundle


.. currentmodule:: isaaclab.benchmark

Request and Result Classes
--------------------------

.. autoclass:: BenchmarkLauncherConfig
   :members:

.. autoclass:: BenchmarkOutputConfig
   :members:

.. autoclass:: BenchmarkPlayRequest
   :members:

.. autoclass:: BenchmarkResult
   :members:

.. autoclass:: BenchmarkRuntimeRequest
   :members:

.. autoclass:: BenchmarkStartupRequest
   :members:

.. autoclass:: BenchmarkTrainingRequest
   :members:

Workflow Functions
------------------

.. autofunction:: run_benchmark

.. autofunction:: run_play_benchmark

.. autofunction:: run_runtime_benchmark

.. autofunction:: run_startup_benchmark

.. autofunction:: run_training_benchmark

Benchmark Framework
-------------------

.. autoclass:: BaseIsaacLabBenchmark
   :members:

.. autoclass:: BenchmarkMonitor
   :members:

.. autoclass:: MethodBenchmarkDefinition
   :members:

.. autoclass:: MethodBenchmarkRunner
   :members:

.. autoclass:: MethodBenchmarkRunnerConfig
   :members:

.. autoclass:: PlayBundle
   :members:

.. autoclass:: RuntimeBundle
   :members:

.. autoclass:: StartupBundle
   :members:

.. autoclass:: TrainingBundle
   :members: