MCPcopy Create free account

hub / github.com/mujocolab/mjlab / types & classes

Types & classes316 in github.com/mujocolab/mjlab

↓ 139 callersClassSceneEntityCfg
Configuration for a scene entity that is used by the manager's term. This configuration allows flexible specification of entity components either b
src/mjlab/managers/scene_entity_config.py:55
↓ 113 callersClassObservationTermCfg
Configuration for an observation term. Processing pipeline: compute → noise → clip → scale → delay → history. Delay models sensor latency. Histor
src/mjlab/managers/observation_manager.py:18
↓ 96 callersClassEntityCfg
src/mjlab/entity/entity.py:70
↓ 78 callersClassObservationGroupCfg
Configuration for an observation group. An observation group bundles multiple observation terms together. Groups are typically used to separate o
src/mjlab/managers/observation_manager.py:69
↓ 78 callersClassSimulationCfg
src/mjlab/sim/sim.py:145
↓ 65 callersClassObjRef
Reference to a MuJoCo object (body, joint, site, etc.). Used to specify which object a sensor is attached to and its frame of reference. The enti
src/mjlab/sensor/builtin_sensor.py:172
↓ 61 callersClassSimulation
GPU-accelerated MuJoCo simulation powered by MJWarp. CUDA Graph Capture ------------------ On CUDA devices with memory pools enabled, the simul
src/mjlab/sim/sim.py:172
↓ 58 callersClassEntity
An entity represents a physical object in the simulation. Entity Type Matrix ================== MuJoCo entities can be categorized along two di
src/mjlab/entity/entity.py:116
↓ 58 callersClassObservationManager
Manages observation computation for the environment. The observation manager computes observations from multiple terms organized into groups. Eac
src/mjlab/managers/observation_manager.py:115
↓ 55 callersClassSceneCfg
Configuration for a simulation scene.
src/mjlab/scene/scene.py:25
↓ 53 callersClassScene
src/mjlab/scene/scene.py:52
↓ 46 callersClassRewardTermCfg
Configuration for a reward term.
src/mjlab/managers/reward_manager.py:20
↓ 45 callersClassContactMatch
Specifies what to match on one side of a contact. Args: mode: MuJoCo element type to match against ("geom", "body", or "subtree"). pattern:
src/mjlab/sensor/contact_sensor.py:69
↓ 42 callersClassBuiltinPositionActuatorCfg
Configuration for MuJoCo built-in position actuator. Under the hood, this creates a <position> actuator for each target and sets the stiffness, d
src/mjlab/actuator/builtin_actuator.py:36
↓ 42 callersClassEntityArticulationInfoCfg
src/mjlab/entity/entity.py:111
↓ 42 callersClassTerrainGeometry
src/mjlab/terrains/terrain_generator.py:40
↓ 41 callersClassVariantEntityCfg
Entity config for per-world mesh variants. Provide a dict of named variants (each value is a callable returning an ``MjSpec``) and optionally an
src/mjlab/entity/variants.py:96
↓ 37 callersClassEventTermCfg
Configuration for an event term. Event terms trigger operations at specific simulation events. They're commonly used for domain randomization, st
src/mjlab/managers/event_manager.py:100
↓ 36 callersClassContactSensorCfg
Configuration for a :class:`ContactSensor`. A contact sensor watches contacts between a ``primary`` set of elements and an optional ``secondary``
src/mjlab/sensor/contact_sensor.py:91
↓ 35 callersClassRayCastSensorCfg
Raycast sensor configuration. Supports multiple ray patterns (grid, pinhole camera, ring) and alignment modes.
src/mjlab/sensor/raycast_sensor.py:349
↓ 33 callersClassManagerBasedRlEnv
Manager-based RL environment.
src/mjlab/envs/manager_based_rl_env.py:166
↓ 28 callersClassGridPatternCfg
Grid pattern - parallel rays in a 2D grid.
src/mjlab/sensor/raycast_sensor.py:53
↓ 23 callersClassRecorderTermCfg
Configuration for a recorder term. ``func`` must be a :class:`RecorderTerm` subclass. Function-based terms are not supported because recorder ter
src/mjlab/managers/recorder_manager.py:19
↓ 22 callersClassTerrainEntityCfg
Configuration for terrain as an entity.
src/mjlab/terrains/terrain_entity.py:66
↓ 21 callersClassDelayBuffer
Serve stochastically delayed observations from a rolling history. Wraps a CircularBuffer to simulate observation delays by returning frames from T-
src/mjlab/utils/buffers/delay_buffer.py:12
↓ 20 callersClassMetricsTermCfg
Configuration for a metrics term. Attributes: per_substep: If True, evaluate this term once per physics substep inside the decimation loop
src/mjlab/managers/metrics_manager.py:19
↓ 19 callersClassMujocoCfg
Configuration for MuJoCo simulation parameters.
src/mjlab/sim/sim.py:87
↓ 18 callersClassBuiltinMotorActuatorCfg
Configuration for MuJoCo built-in motor actuator. Under the hood, this creates a <motor> actuator for each target and sets its effort limit and g
src/mjlab/actuator/builtin_actuator.py:194
↓ 18 callersClassBuiltinSensorCfg
src/mjlab/sensor/builtin_sensor.py:196
↓ 18 callersClassManagerBasedRlEnvCfg
Configuration for a manager-based RL environment. This config defines all aspects of an RL environment: the physical scene, observations, actions
src/mjlab/envs/manager_based_rl_env.py:52
↓ 17 callersClassCameraSensorCfg
Configuration for a camera sensor. A camera sensor can either wrap an existing MuJoCo camera (``camera_name``) or create a new one at the specifi
src/mjlab/sensor/camera_sensor.py:25
↓ 17 callersClassFakeViewer
Minimal concrete viewer for testing.
tests/test_viewer_tick.py:11
↓ 17 callersClassRecorderManager
Orchestrates recorder terms during environment rollouts. Holds a collection of :class:`RecorderTerm` instances and calls their lifecycle methods
src/mjlab/managers/recorder_manager.py:139
↓ 16 callersClassCircularBuffer
Fixed-length circular buffer for batched tensor history. Stores history with shape (max_len, batch_size, ...) internally. The `buffer` property r
src/mjlab/utils/buffers/circular_buffer.py:82
↓ 16 callersClassMetricsManager
Accumulates per-step metric values, reports episode averages. Unlike rewards, metrics have no weight, no dt scaling, and no normalization by epis
src/mjlab/managers/metrics_manager.py:39
↓ 16 callersClassTerminationTermCfg
Configuration for a termination term.
src/mjlab/managers/termination_manager.py:19
↓ 16 callersClassTerrainOutput
src/mjlab/terrains/terrain_generator.py:50
↓ 15 callersClassRslRlModelCfg
Config for a single neural network model (Actor or Critic).
src/mjlab/rl/config.py:8
↓ 14 callersClassCollisionCfg
Configuration to modify collision properties of geoms in the MuJoCo spec. Supports regex pattern matching for geom names and dict-based field resol
src/mjlab/utils/spec_config.py:158
↓ 13 callersClassBuiltinDcMotorActuatorCfg
Native MuJoCo ``<dcmotor>`` wrapper. Models a DC motor: torque is derived from voltage via the motor constant K and back-EMF, tau = K * (V - K *
src/mjlab/actuator/builtin_actuator.py:296
↓ 12 callersClassRslRlOnPolicyRunnerCfg
src/mjlab/rl/config.py:129
↓ 12 callersClassXmlActuatorCfg
Wrap existing XML-defined actuators. Detects the actuator type (position, velocity, motor, muscle) from the MuJoCo spec element during ``edit_spe
src/mjlab/actuator/xml_actuator.py:28
↓ 11 callersClassConstantNoiseCfg
src/mjlab/utils/noise/noise_cfg.py:44
↓ 11 callersClassRewardManager
Manages reward computation by aggregating weighted reward terms. Reward Scaling Behavior: By default, rewards are scaled by the environment ste
src/mjlab/managers/reward_manager.py:30
↓ 11 callersClassTerrainGeneratorCfg
src/mjlab/terrains/terrain_generator.py:88
↓ 11 callersClassWarpBridge
Wraps mjwarp objects to expose Warp arrays as PyTorch tensors. Automatically converts Warp array attributes to TorchArray objects on access, enab
src/mjlab/sim/sim_data.py:183
↓ 10 callersClassCurriculumTermCfg
Configuration for a curriculum term. Curriculum terms modify environment parameters during training to implement curriculum learning strategies (
src/mjlab/managers/curriculum_manager.py:19
↓ 10 callersClassDifferentialIKActionCfg
Configuration for differential IK action space. Converts task-space commands (position and/or orientation) into joint-space targets via damped le
src/mjlab/envs/mdp/actions/differential_ik.py:26
↓ 10 callersClassRslRlVecEnvWrapper
src/mjlab/rl/vecenv_wrapper.py:9
↓ 10 callersClass_FieldConfig
Configuration for a resolvable entity field.
src/mjlab/managers/scene_entity_config.py:10
↓ 10 callersClass_Handle
tests/test_variants.py:1285
↓ 9 callersClassLearnedMlpActuatorCfg
Configuration for MLP-based learned actuator model. This actuator learns the mapping from joint commands and state history to actual torque outpu
src/mjlab/actuator/learned_actuator.py:21
↓ 9 callersClassNanGuardCfg
Configuration for NaN guard.
src/mjlab/utils/nan_guard.py:17
↓ 8 callersClassDcMotorActuatorCfg
Configuration for DC motor actuator with velocity-based saturation. This actuator implements a DC motor torque-speed curve for more realistic act
src/mjlab/actuator/dc_actuator.py:26
↓ 8 callersClassElectricActuator
Electric actuator parameters.
src/mjlab/utils/actuator.py:9
↓ 8 callersClassIdealPdActuatorCfg
Configuration for ideal PD actuator.
src/mjlab/actuator/pd_actuator.py:22
↓ 7 callersClassFlatPatchSamplingCfg
Configuration for sampling flat patches on a heightfield surface.
src/mjlab/terrains/terrain_generator.py:17
↓ 7 callersClassRslRlPpoAlgorithmCfg
Config for the PPO algorithm.
src/mjlab/rl/config.py:42
↓ 6 callersClassEnv
tests/test_domain_randomization.py:63
↓ 6 callersClassTerrainEntity
Terrain entity. The terrain is a grid of sub-terrain patches (num_rows x num_cols), each with a spawn origin. When num_envs exceeds the number of
src/mjlab/terrains/terrain_entity.py:109
↓ 6 callersClass_BatchedPrimitive
Manages a single batched mesh handle with lazy mesh creation.
src/mjlab/viewer/viser/scene.py:88
↓ 5 callersClassBox
Continuous space with optional bounds.
src/mjlab/utils/spaces.py:25
↓ 5 callersClassNativeMujocoViewer
src/mjlab/viewer/native/viewer.py:121
↓ 5 callersClassViewerConfig
src/mjlab/viewer/viewer_config.py:6
↓ 4 callersClassDistribution
A domain randomization sampling distribution. Built-in distributions (``uniform``, ``log_uniform``, ``gaussian``) are provided as module-level in
src/mjlab/envs/mdp/dr/_types.py:59
↓ 4 callersClassEventManager
Manages event-based operations for the environment. The event manager triggers operations at different simulation events: startup (once at initia
src/mjlab/managers/event_manager.py:143
↓ 4 callersClassJointPositionActionCfg
Configuration for joint position control.
src/mjlab/envs/mdp/actions/actions.py:176
↓ 4 callersClassMjlabOnPolicyRunner
Base runner that persists environment state across checkpoints.
src/mjlab/rl/runner.py:11
↓ 4 callersClassOperation
A domain randomization operation. Built-in operations (``abs``, ``scale``, ``add``) are provided as module-level instances. Users can create cust
src/mjlab/envs/mdp/dr/_types.py:18
↓ 4 callersClassRelativeJointPositionActionCfg
Configuration for joint position control relative to current positions. target = current_joint_pos + action * scale The ``offset`` field inherit
src/mjlab/envs/mdp/actions/actions.py:228
↓ 4 callersClassSlotKey
Structural identity of a mesh slot in the merged template.
src/mjlab/entity/variants.py:150
↓ 4 callersClassTerrainGenerator
Generates procedural terrain grids with configurable difficulty. Creates a grid of terrain patches where each patch can be a different terrain ty
src/mjlab/terrains/terrain_generator.py:128
↓ 4 callersClassTorchArray
Warp array that behaves like a torch.Tensor with shared memory.
src/mjlab/sim/sim_data.py:15
↓ 4 callersClassVideoRecorder
Wraps an environment to record video during interaction. A minimal wrapper that records frames as the environment steps. Delegates all attribute
src/mjlab/utils/wrappers/video_recorder.py:16
↓ 4 callersClassViserPlayViewer
Interactive Viser-based viewer with playback controls.
src/mjlab/viewer/viser/viewer.py:64
↓ 4 callersClass_FakeEnv
Minimal env-like object for testing observation functions.
tests/test_raycast_sensor.py:776
↓ 4 callersClass_OnnxMotionModel
ONNX-exportable model that wraps the policy and bundles motion reference data.
src/mjlab/tasks/tracking/rl/runner.py:18
↓ 3 callersClassActionManager
Manages action processing for the environment. The action manager aggregates multiple action terms, each controlling a different entity or aspect
src/mjlab/managers/action_manager.py:71
↓ 3 callersClassActuatorCmd
High-level actuator command with targets and current state. Passed to actuator's `compute()` method to generate low-level control signals. All te
src/mjlab/actuator/actuator.py:132
↓ 3 callersClassBoxFlatTerrainCfg
src/mjlab/terrains/primitive_terrains.py:41
↓ 3 callersClassBuiltinPdActuatorCfg
Implicit-integration version of IdealPdActuator. Both consume a position target and a velocity target with kp/kd gains. The difference is in how
src/mjlab/actuator/builtin_actuator.py:98
↓ 3 callersClassHSV
HSV color representation.
src/mjlab/utils/color.py:45
↓ 3 callersClassHfPerlinNoiseTerrainCfg
src/mjlab/terrains/heightfield_terrains.py:857
↓ 3 callersClassMjlabViserScene
ViserMujocoScene with debug visualization and warp tensor conversion. Adds debug primitives (arrows, ghosts, spheres, cylinders, ellipsoids, coor
src/mjlab/viewer/viser/scene.py:218
↓ 3 callersClassNullRecorderManager
No-op fallback used when no recorder terms are configured. All methods are no-ops. This class is not a :class:`ManagerBase` subclass so it carrie
src/mjlab/managers/recorder_manager.py:227
↓ 3 callersClassRayCastData
Raycast sensor output data. Note: Fields are views into GPU buffers and are valid until the next ``sense()`` call.
src/mjlab/sensor/raycast_sensor.py:315
↓ 3 callersClassTerminationManager
Manages termination conditions for the environment. The termination manager aggregates multiple termination terms to compute episode done signals
src/mjlab/managers/termination_manager.py:26
↓ 3 callersClass_MockMotion
Minimal mock of a motion object with tensor attributes.
tests/test_runner.py:451
↓ 3 callersClassreward_curriculum
Update a reward term's weight and/or params based on training steps. Each stage specifies a ``step`` threshold and optionally a ``weight`` and/or
src/mjlab/envs/mdp/curriculums.py:110
↓ 2 callersClassCameraSensorData
Camera sensor output data. Shapes: - rgb: [num_envs, height, width, 3] (uint8) - depth: [num_envs, height, width, 1] (float32) - segmen
src/mjlab/sensor/camera_sensor.py:109
↓ 2 callersClassCheckpointManager
Holds checkpoint discovery and loading callbacks for the viewer.
src/mjlab/viewer/viser/viewer.py:39
↓ 2 callersClassCurriculumManager
Manages curriculum learning for the environment. The curriculum manager updates environment parameters during training based on agent performance
src/mjlab/managers/curriculum_manager.py:29
↓ 2 callersClassHfRandomUniformTerrainCfg
src/mjlab/terrains/heightfield_terrains.py:386
↓ 2 callersClassMaterialCfg
Configuration to add a material to the MuJoCo spec. Optionally assigns the material to geoms matching ``geom_names_expr``.
src/mjlab/utils/spec_config.py:109
↓ 2 callersClassMujocoNativeDebugVisualizer
Debug visualizer for MuJoCo's native viewer. This implementation directly adds geometry to the MuJoCo scene using mjv_addGeoms and other MuJoCo v
src/mjlab/viewer/native/visualizer.py:12
↓ 2 callersClassNullMetricsManager
Placeholder for absent metrics manager that safely no-ops all operations.
src/mjlab/managers/metrics_manager.py:200
↓ 2 callersClassOffscreenRenderer
src/mjlab/viewer/offscreen_renderer.py:18
↓ 2 callersClassPlayConfig
src/mjlab/scripts/play.py:34
↓ 2 callersClassTendonLengthActionCfg
Configuration for tendon length control.
src/mjlab/envs/mdp/actions/actions.py:293
↓ 2 callersClassTerrainHeightSensorCfg
RayCastSensor that reports per-frame vertical clearance above terrain. Inherits all raycasting configuration from :class:`RayCastSensorCfg`. The se
src/mjlab/sensor/terrain_height_sensor.py:26
next →1–100 of 316, ranked by callers