Skip to content

Commit 15145c0

Browse files
thowellcopybara-github
authored andcommitted
MuJoCo Warp documentation: Compilation.
PiperOrigin-RevId: 841761913 Change-Id: Ic1b1942a47299db48c424ad1f9e3709b05acc55e
1 parent e238b65 commit 15145c0

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

doc/mjwarp/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,3 +440,30 @@ Orientations are represented as unit quaternions and follow :ref:`MuJoCo's conve
440440
operations and instead implements quaternion routines that follow MuJoCo's conventions. Please see
441441
`math.py <https://github.com/google-deepmind/mujoco_warp/blob/main/mujoco_warp/_src/math.py>`__ for the
442442
implementations.
443+
444+
Compilation
445+
-----------
446+
447+
**How can compilation time be improved?**
448+
449+
Limit the number of unique colliders that require the general convex collision pipeline. These colliders are listed as
450+
``_CONVEX_COLLISION_PAIRS`` in
451+
`collision_convex.py <https://github.com/google-deepmind/mujoco_warp/blob/main/mujoco_warp/_src/collision_convex.py>`__.
452+
Improvements to the compilation time for the pipeline are tracked in this
453+
`GitHub issue <https://github.com/google-deepmind/mujoco_warp/issues/813>`__.
454+
455+
**Why are the physics not working as expected after upgrading MJWarp?**
456+
457+
The Warp cache may be incompatible with the current code and should be cleared as part of the debugging process. This
458+
can be accomplished by deleting the directory ``~/.cache/warp`` or via Python
459+
460+
.. code-block:: python
461+
462+
import warp as wp
463+
wp.clear_kernel_cache()
464+
465+
**Is it possible to compile MJWarp ahead of time instead of at runtime?**
466+
467+
Yes. Please see Warp's
468+
`Ahead-of-Time Compilation Workflows <https://nvidia.github.io/warp/codegen.html#ahead-of-time-compilation-workflows>`__
469+
documentation for details.

0 commit comments

Comments
 (0)