chenlin/Mujoco_WASM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Disable WASM bindings benchmarks on Github CI

Browse Source 
Updated the wasm/README.md to describe how to manually run the benchmark tests.

PiperOrigin-RevId: 827881670
Change-Id: I1d524851d9f3f8182ecbfcc649bb9a5a61d716ae
This commit is contained in:
Matija Kecman
2025-11-04 02:59:31 -08:00
committed by Copybara-Service
parent 3d59b20b65
commit 2018b8c494
4 changed files with 64 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wasm/README.md
+21 -13
View File
@@ -135,15 +135,32 @@ bounds checking and nice error reporting.
1. **JavaScript API tests.**
These verify that a wide variety of MuJoCo functions and classes work
correctly when called from JavaScript. There are also preliminary benchmarks
for JavaScript/C++ shared memory buffers. The enums test is special because
it is generated by a Python script. Run the tests as follows:
correctly when called from JavaScript. Run the tests as follows:
```sh
npm run test --prefix ./wasm
```
2. **Bindings generator tests.**
> [!NOTE]
> The above command runs the [`enums_tests.ts`](tests/enums_tests.ts) file
> which checks that all the enums in the API are bound. This test is
> auto-generated so if you add/edit an enum to MuJoCo then you will need to
> run the following command to re-create the test:
>
> ```sh
> PYTHONPATH=python/mujoco python3 -m wasm.codegen.enums_test_generator
> ```
2. **JavaScript API benchmark tests.**
The current benchmark tests check JavaScript/C++ shared memory buffers
performance. We will increase the coverage of the benchmarks overtime. Run
the benchmarks using this command:
```sh
npm run benchmark --prefix ./wasm
```
3. **Bindings generator tests.**
These are relevant when developing or extending the bindings. The following
command finds and runs all `test_*.py` or `*_test.py` files in the `wasm`
folder:
@@ -152,15 +169,6 @@ bounds checking and nice error reporting.
PYTHONPATH=python/mujoco python3 -m pytest ./wasm
```
> [!NOTE]
> If you add/edit an enum in MuJoCo you will need to run the following command
> to re-creates the [`enums_tests.ts`](tests/enums_tests.ts) file which checks
> that all the enums in the API are bound:
>
> ```sh
> PYTHONPATH=python/mujoco python3 -m wasm.codegen.enums_test_generator
> ```
### Debugging
We provide a “sandbox” app where you can quickly write code to run in your