Import upstream snapshot c19f713c415a699a79d71cd96aa13c3104a05047
nightly / Test against latest dependencies (py3.10) (push) Has been cancelled
nightly / Test against latest dependencies (py3.13) (push) Has been cancelled
tests / tests (3.13, locked) (push) Has been cancelled
tests / tests (3.13, unlocked) (push) Has been cancelled
tests / pyright (3.10) (push) Has been cancelled
tests / lint-format (push) Has been cancelled
tests / tests (3.10, locked) (push) Has been cancelled
tests / tests (3.11, locked) (push) Has been cancelled
tests / tests (3.12, locked) (push) Has been cancelled
tests / pyright (3.11) (push) Has been cancelled
tests / pyright (3.12) (push) Has been cancelled
tests / pyright (3.13) (push) Has been cancelled
tests / ty-check (3.10) (push) Has been cancelled
tests / ty-check (3.11) (push) Has been cancelled
tests / ty-check (3.12) (push) Has been cancelled
tests / ty-check (3.13) (push) Has been cancelled
tests / stubs (push) Has been cancelled
tests / smoke-test (push) Has been cancelled
Docker / check_paths (push) Has been cancelled
Docker / build (push) Has been cancelled
docs / build (push) Has been cancelled
nightly / Test against latest dependencies (py3.10) (push) Has been cancelled
nightly / Test against latest dependencies (py3.13) (push) Has been cancelled
tests / tests (3.13, locked) (push) Has been cancelled
tests / tests (3.13, unlocked) (push) Has been cancelled
tests / pyright (3.10) (push) Has been cancelled
tests / lint-format (push) Has been cancelled
tests / tests (3.10, locked) (push) Has been cancelled
tests / tests (3.11, locked) (push) Has been cancelled
tests / tests (3.12, locked) (push) Has been cancelled
tests / pyright (3.11) (push) Has been cancelled
tests / pyright (3.12) (push) Has been cancelled
tests / pyright (3.13) (push) Has been cancelled
tests / ty-check (3.10) (push) Has been cancelled
tests / ty-check (3.11) (push) Has been cancelled
tests / ty-check (3.12) (push) Has been cancelled
tests / ty-check (3.13) (push) Has been cancelled
tests / stubs (push) Has been cancelled
tests / smoke-test (push) Has been cancelled
Docker / check_paths (push) Has been cancelled
Docker / build (push) Has been cancelled
docs / build (push) Has been cancelled
Upstream: https://github.com/michaelgillett/mjlab Upstream-Commit: c19f713c415a699a79d71cd96aa13c3104a05047 Upstream-Branch: main
This commit is contained in:
Upstream Snapshot
@@ -0,0 +1,182 @@
|
||||
mjlab.actuator
|
||||
==============
|
||||
|
||||
.. automodule:: mjlab.actuator
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`Actuator`
|
||||
- :class:`ActuatorCfg`
|
||||
- :class:`ActuatorCmd`
|
||||
- :class:`BuiltinActuatorGroup`
|
||||
- :class:`BuiltinMotorActuator`
|
||||
- :class:`BuiltinMotorActuatorCfg`
|
||||
- :class:`BuiltinPositionActuator`
|
||||
- :class:`BuiltinPositionActuatorCfg`
|
||||
- :class:`BuiltinVelocityActuator`
|
||||
- :class:`BuiltinVelocityActuatorCfg`
|
||||
- :class:`BuiltinPdActuator`
|
||||
- :class:`BuiltinPdActuatorCfg`
|
||||
- :class:`BuiltinDcMotorActuator`
|
||||
- :class:`BuiltinDcMotorActuatorCfg`
|
||||
- :class:`DcMotorInputMode`
|
||||
- :class:`DcMotorDatasheetParams`
|
||||
- :class:`DcMotorPhysicalParams`
|
||||
- :class:`BuiltinMuscleActuator`
|
||||
- :class:`BuiltinMuscleActuatorCfg`
|
||||
- :class:`XmlActuator`
|
||||
- :class:`XmlActuatorCfg`
|
||||
- :class:`IdealPdActuator`
|
||||
- :class:`IdealPdActuatorCfg`
|
||||
- :class:`DcMotorActuator`
|
||||
- :class:`DcMotorActuatorCfg`
|
||||
- :class:`LearnedMlpActuator`
|
||||
- :class:`LearnedMlpActuatorCfg`
|
||||
|
||||
Base
|
||||
----
|
||||
|
||||
.. autoclass:: Actuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: ActuatorCmd
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Builtin Actuators
|
||||
-----------------
|
||||
|
||||
.. autoclass:: BuiltinActuatorGroup
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinMotorActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinMotorActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: BuiltinPositionActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinPositionActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: BuiltinVelocityActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinVelocityActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: BuiltinPdActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinPdActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: BuiltinDcMotorActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinDcMotorActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: DcMotorInputMode
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: DcMotorDatasheetParams
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: DcMotorPhysicalParams
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: BuiltinMuscleActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinMuscleActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
XML Actuators
|
||||
-------------
|
||||
|
||||
.. autoclass:: XmlActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: XmlActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Ideal PD Actuator
|
||||
-----------------
|
||||
|
||||
.. autoclass:: IdealPdActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: IdealPdActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
DC Motor Actuator
|
||||
-----------------
|
||||
|
||||
.. autoclass:: DcMotorActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: DcMotorActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Learned MLP Actuator
|
||||
--------------------
|
||||
|
||||
.. autoclass:: LearnedMlpActuator
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: LearnedMlpActuatorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
@@ -0,0 +1,45 @@
|
||||
mjlab.entity
|
||||
============
|
||||
|
||||
.. automodule:: mjlab.entity
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`Entity`
|
||||
- :class:`EntityCfg`
|
||||
- :class:`EntityArticulationInfoCfg`
|
||||
- :class:`EntityIndexing`
|
||||
- :class:`EntityData`
|
||||
|
||||
Entity
|
||||
------
|
||||
|
||||
.. autoclass:: Entity
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: EntityCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: EntityArticulationInfoCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
EntityIndexing
|
||||
--------------
|
||||
|
||||
.. autoclass:: EntityIndexing
|
||||
:members:
|
||||
|
||||
EntityData
|
||||
----------
|
||||
|
||||
.. autoclass:: EntityData
|
||||
:members:
|
||||
@@ -0,0 +1,36 @@
|
||||
mjlab.envs
|
||||
==========
|
||||
|
||||
.. automodule:: mjlab.envs
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`ManagerBasedRlEnv`
|
||||
- :class:`ManagerBasedRlEnvCfg`
|
||||
- :data:`VecEnvObs`
|
||||
- :data:`VecEnvStepReturn`
|
||||
|
||||
ManagerBasedRlEnv
|
||||
-----------------
|
||||
|
||||
.. autoclass:: ManagerBasedRlEnv
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ManagerBasedRlEnvCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
VecEnvObs
|
||||
---------
|
||||
|
||||
.. autodata:: VecEnvObs
|
||||
|
||||
VecEnvStepReturn
|
||||
----------------
|
||||
|
||||
.. autodata:: VecEnvStepReturn
|
||||
@@ -0,0 +1,19 @@
|
||||
API Reference
|
||||
=============
|
||||
|
||||
This section provides detailed API documentation for all public modules in mjlab.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
envs
|
||||
scene
|
||||
sim
|
||||
entity
|
||||
actuator
|
||||
sensor
|
||||
managers
|
||||
terrains
|
||||
rl
|
||||
viewer
|
||||
tasks
|
||||
@@ -0,0 +1,208 @@
|
||||
mjlab.managers
|
||||
==============
|
||||
|
||||
.. automodule:: mjlab.managers
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`ManagerBase`
|
||||
- :class:`ManagerTermBase`
|
||||
- :class:`ManagerTermBaseCfg`
|
||||
- :class:`SceneEntityCfg`
|
||||
- :class:`ActionManager`
|
||||
- :class:`ActionTerm`
|
||||
- :class:`ActionTermCfg`
|
||||
- :class:`ObservationManager`
|
||||
- :class:`ObservationGroupCfg`
|
||||
- :class:`ObservationTermCfg`
|
||||
- :class:`RewardManager`
|
||||
- :class:`RewardTermCfg`
|
||||
- :class:`TerminationManager`
|
||||
- :class:`TerminationTermCfg`
|
||||
- :class:`CommandManager`
|
||||
- :class:`NullCommandManager`
|
||||
- :class:`CommandTerm`
|
||||
- :class:`CommandTermCfg`
|
||||
- :class:`CurriculumManager`
|
||||
- :class:`NullCurriculumManager`
|
||||
- :class:`CurriculumTermCfg`
|
||||
- :class:`EventManager`
|
||||
- :class:`EventMode`
|
||||
- :class:`EventTermCfg`
|
||||
- :class:`MetricsManager`
|
||||
- :class:`NullMetricsManager`
|
||||
- :class:`MetricsTermCfg`
|
||||
- :class:`RecorderManager`
|
||||
- :class:`NullRecorderManager`
|
||||
- :class:`RecorderTerm`
|
||||
- :class:`RecorderTermCfg`
|
||||
|
||||
Base
|
||||
----
|
||||
|
||||
.. autoclass:: ManagerBase
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ManagerTermBase
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ManagerTermBaseCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: SceneEntityCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Action Manager
|
||||
--------------
|
||||
|
||||
.. autoclass:: ActionManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ActionTerm
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ActionTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Observation Manager
|
||||
-------------------
|
||||
|
||||
.. autoclass:: ObservationManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ObservationGroupCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: ObservationTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Reward Manager
|
||||
--------------
|
||||
|
||||
.. autoclass:: RewardManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: RewardTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Termination Manager
|
||||
-------------------
|
||||
|
||||
.. autoclass:: TerminationManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: TerminationTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Command Manager
|
||||
---------------
|
||||
|
||||
.. autoclass:: CommandManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: NullCommandManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: CommandTerm
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: CommandTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Curriculum Manager
|
||||
------------------
|
||||
|
||||
.. autoclass:: CurriculumManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: NullCurriculumManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: CurriculumTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Event Manager
|
||||
-------------
|
||||
|
||||
.. autoclass:: EventManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: EventMode
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: EventTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Metrics Manager
|
||||
---------------
|
||||
|
||||
.. autoclass:: MetricsManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: NullMetricsManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: MetricsTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
|
||||
Recorder Manager
|
||||
----------------
|
||||
|
||||
.. autoclass:: RecorderManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: NullRecorderManager
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: RecorderTerm
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: RecorderTermCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,52 @@
|
||||
mjlab.rl
|
||||
========
|
||||
|
||||
.. automodule:: mjlab.rl
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`MjlabOnPolicyRunner`
|
||||
- :class:`RslRlVecEnvWrapper`
|
||||
- :class:`RslRlOnPolicyRunnerCfg`
|
||||
- :class:`RslRlPpoAlgorithmCfg`
|
||||
- :class:`RslRlModelCfg`
|
||||
- :class:`RslRlBaseRunnerCfg`
|
||||
|
||||
Runner
|
||||
------
|
||||
|
||||
.. autoclass:: MjlabOnPolicyRunner
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: RslRlVecEnvWrapper
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
.. autoclass:: RslRlOnPolicyRunnerCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: RslRlPpoAlgorithmCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: RslRlModelCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: RslRlBaseRunnerCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
@@ -0,0 +1,23 @@
|
||||
mjlab.scene
|
||||
===========
|
||||
|
||||
.. automodule:: mjlab.scene
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`Scene`
|
||||
- :class:`SceneCfg`
|
||||
|
||||
Scene
|
||||
-----
|
||||
|
||||
.. autoclass:: Scene
|
||||
:members:
|
||||
|
||||
.. autoclass:: SceneCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,126 @@
|
||||
mjlab.sensor
|
||||
============
|
||||
|
||||
.. automodule:: mjlab.sensor
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`Sensor`
|
||||
- :class:`SensorCfg`
|
||||
- :class:`SensorContext`
|
||||
- :class:`BuiltinSensor`
|
||||
- :class:`BuiltinSensorCfg`
|
||||
- :class:`ObjRef`
|
||||
- :class:`ContactSensor`
|
||||
- :class:`ContactSensorCfg`
|
||||
- :class:`ContactData`
|
||||
- :class:`ContactMatch`
|
||||
- :class:`RayCastSensor`
|
||||
- :class:`RayCastSensorCfg`
|
||||
- :class:`RayCastData`
|
||||
- :class:`GridPatternCfg`
|
||||
- :class:`PinholeCameraPatternCfg`
|
||||
- :class:`CameraSensor`
|
||||
- :class:`CameraSensorCfg`
|
||||
- :class:`CameraSensorData`
|
||||
|
||||
Base
|
||||
----
|
||||
|
||||
.. autoclass:: Sensor
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: SensorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: SensorContext
|
||||
:members:
|
||||
|
||||
Builtin Sensor
|
||||
--------------
|
||||
|
||||
.. autoclass:: BuiltinSensor
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BuiltinSensorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: ObjRef
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Contact Sensor
|
||||
--------------
|
||||
|
||||
.. autoclass:: ContactSensor
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: ContactSensorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: ContactData
|
||||
:members:
|
||||
|
||||
.. autoclass:: ContactMatch
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Ray Cast Sensor
|
||||
---------------
|
||||
|
||||
.. autoclass:: RayCastSensor
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: RayCastSensorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: RayCastData
|
||||
:members:
|
||||
|
||||
.. autoclass:: GridPatternCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: PinholeCameraPatternCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Camera Sensor
|
||||
-------------
|
||||
|
||||
.. autoclass:: CameraSensor
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: CameraSensorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: CameraSensorData
|
||||
:members:
|
||||
@@ -0,0 +1,44 @@
|
||||
mjlab.sim
|
||||
=========
|
||||
|
||||
.. automodule:: mjlab.sim
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`Simulation`
|
||||
- :class:`SimulationCfg`
|
||||
- :class:`MujocoCfg`
|
||||
- :class:`TorchArray`
|
||||
- :class:`WarpBridge`
|
||||
|
||||
Simulation
|
||||
----------
|
||||
|
||||
.. autoclass:: Simulation
|
||||
:members:
|
||||
|
||||
.. autoclass:: SimulationCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: MujocoCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
TorchArray
|
||||
----------
|
||||
|
||||
.. autoclass:: TorchArray
|
||||
:members:
|
||||
|
||||
WarpBridge
|
||||
----------
|
||||
|
||||
.. autoclass:: WarpBridge
|
||||
:members:
|
||||
@@ -0,0 +1,25 @@
|
||||
mjlab.tasks
|
||||
===========
|
||||
|
||||
.. automodule:: mjlab.tasks.registry
|
||||
|
||||
.. rubric:: Functions
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :func:`register_mjlab_task`
|
||||
- :func:`list_tasks`
|
||||
- :func:`load_env_cfg`
|
||||
- :func:`load_rl_cfg`
|
||||
- :func:`load_runner_cls`
|
||||
|
||||
.. autofunction:: register_mjlab_task
|
||||
|
||||
.. autofunction:: list_tasks
|
||||
|
||||
.. autofunction:: load_env_cfg
|
||||
|
||||
.. autofunction:: load_rl_cfg
|
||||
|
||||
.. autofunction:: load_runner_cls
|
||||
@@ -0,0 +1,167 @@
|
||||
mjlab.terrains
|
||||
==============
|
||||
|
||||
.. automodule:: mjlab.terrains
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`TerrainEntity`
|
||||
- :class:`TerrainEntityCfg`
|
||||
- :class:`TerrainGenerator`
|
||||
- :class:`TerrainGeneratorCfg`
|
||||
- :class:`SubTerrainCfg`
|
||||
- :class:`FlatPatchSamplingCfg`
|
||||
- :class:`HfDiscreteObstaclesTerrainCfg`
|
||||
- :class:`HfPerlinNoiseTerrainCfg`
|
||||
- :class:`HfPyramidSlopedTerrainCfg`
|
||||
- :class:`HfRandomUniformTerrainCfg`
|
||||
- :class:`HfWaveTerrainCfg`
|
||||
- :class:`BoxFlatTerrainCfg`
|
||||
- :class:`BoxInvertedPyramidStairsTerrainCfg`
|
||||
- :class:`BoxNarrowBeamsTerrainCfg`
|
||||
- :class:`BoxNestedRingsTerrainCfg`
|
||||
- :class:`BoxOpenStairsTerrainCfg`
|
||||
- :class:`BoxPyramidStairsTerrainCfg`
|
||||
- :class:`BoxRandomGridTerrainCfg`
|
||||
- :class:`BoxRandomSpreadTerrainCfg`
|
||||
- :class:`BoxRandomStairsTerrainCfg`
|
||||
- :class:`BoxSteppingStonesTerrainCfg`
|
||||
- :class:`BoxTiltedGridTerrainCfg`
|
||||
|
||||
Core
|
||||
----
|
||||
|
||||
.. autoclass:: TerrainEntity
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: TerrainEntityCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: TerrainGenerator
|
||||
:members:
|
||||
|
||||
.. autoclass:: TerrainGeneratorCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: SubTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
|
||||
.. autoclass:: FlatPatchSamplingCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
Heightfield Terrains
|
||||
--------------------
|
||||
|
||||
.. autoclass:: HfDiscreteObstaclesTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: HfPerlinNoiseTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: HfRandomUniformTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: HfPyramidSlopedTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: HfWaveTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Primitive (Box) Terrains
|
||||
------------------------
|
||||
|
||||
.. autoclass:: BoxFlatTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxInvertedPyramidStairsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxNarrowBeamsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxNestedRingsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxOpenStairsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxPyramidStairsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxRandomGridTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxRandomSpreadTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxRandomStairsTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxSteppingStonesTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: BoxTiltedGridTerrainCfg
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,72 @@
|
||||
mjlab.viewer
|
||||
============
|
||||
|
||||
.. automodule:: mjlab.viewer
|
||||
|
||||
.. rubric:: Classes
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`ViewerConfig`
|
||||
- :class:`BaseViewer`
|
||||
- :class:`NativeMujocoViewer`
|
||||
- :class:`ViserPlayViewer`
|
||||
- :class:`OffscreenRenderer`
|
||||
|
||||
.. rubric:: Protocols
|
||||
|
||||
.. hlist::
|
||||
:columns: 3
|
||||
|
||||
- :class:`EnvProtocol`
|
||||
- :class:`PolicyProtocol`
|
||||
- :class:`VerbosityLevel`
|
||||
|
||||
ViewerConfig
|
||||
------------
|
||||
|
||||
.. autoclass:: ViewerConfig
|
||||
:members:
|
||||
:exclude-members: __init__
|
||||
:undoc-members:
|
||||
|
||||
BaseViewer
|
||||
----------
|
||||
|
||||
.. autoclass:: BaseViewer
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
NativeMujocoViewer
|
||||
------------------
|
||||
|
||||
.. autoclass:: NativeMujocoViewer
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
ViserPlayViewer
|
||||
---------------
|
||||
|
||||
.. autoclass:: ViserPlayViewer
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
OffscreenRenderer
|
||||
-----------------
|
||||
|
||||
.. autoclass:: OffscreenRenderer
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Protocols
|
||||
---------
|
||||
|
||||
.. autoclass:: EnvProtocol
|
||||
:members:
|
||||
|
||||
.. autoclass:: PolicyProtocol
|
||||
:members:
|
||||
|
||||
.. autoclass:: VerbosityLevel
|
||||
:members:
|
||||
Reference in New Issue
Block a user