JavaScript bindings for module API #12571

Conarnar · 2025-07-17T00:37:40Z

Summary

The next step for building Executorch for the web is to write JavaScript bindings for the API.

Added bindidngs that would allow for loading modules and executing methods in JavaScript, along with a few functions to create tensors and read its data.

Test plan

Assuming you already have Emscripten and Node.js version >= 17, you also need Jest as the testing framework. That can be installed with npm install --save-dev jest

To build and run the tests, run the commands

# Build the library and unit tests
bash extension/wasm/build_wasm.sh

# Navigate to the testing output directory
cd cmake-out-wasm/extension/wasm/test/

# Run unit tests
npm test

Added CI for unit tests.

pytorch-bot · 2025-07-17T00:37:44Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/12571

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit ddbc698 with merge base ce9da63 ():
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

runtime/core/portable_type/c10/c10/macros/Macros.h

extension/wasm/wasm_bindings.cpp

extension/wasm/CMakeLists.txt

extension/wasm/wasm_bindings.cpp

extension/wasm/CMakeLists.txt

extension/wasm/wasm_bindings.cpp

Summary: Needed for pytorch/pytorch#158580 Differential Revision: D78989384

…ings-js

mergennachin

Thanks!

mergennachin · 2025-07-27T18:34:04Z

extension/wasm/CMakeLists.txt

+  executorch_wasm PUBLIC ${_common_include_directories}
+)
+target_link_libraries(executorch_wasm PUBLIC ${link_libraries})
+


should there be a default target_link_options for emscripten?

The link options used for the unit tests are specific for that target. I don't think there are link options that would be widely applicable for this.

extension/wasm/wasm_bindings.cpp

… unit tests

extension/wasm/wasm_bindings.cpp

larryliu0820 · 2025-08-28T14:17:13Z

extension/wasm/CMakeLists.txt

+
+cmake_minimum_required(VERSION 3.29)
+
+project(executorch_wasm)


I don't think this directory belongs to a new project so should delete this.

larryliu0820 · 2025-08-28T14:33:20Z

extension/wasm/CMakeLists.txt

+set(link_libraries)
+list(
+  APPEND
+  link_libraries


nit: should follow the naming convention with a prepending _

Conarnar added 9 commits July 8, 2025 15:14

README and CMake changes

e6c7666

Added build test script for wasm example

b322cb8

Added CI tests

43561d7

Emscripten automatically installs node.js

d19c6b4

Use Emscripten provided version of Node.js

4b0e1af

Applied suggestions

a21942d

Merge branch 'main' into wasm-bindings

7d15296

Module test working

5378272

Added unit tests for wasm bindings

0701996

Conarnar requested review from JacobSzwejbka, kirklandsign, larryliu0820, lucylq and swolchok as code owners July 17, 2025 00:37

meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 17, 2025

Merge branch 'main' into wasm-bindings-js

f3e3d54

JacobSzwejbka reviewed Jul 17, 2025

View reviewed changes

runtime/core/portable_type/c10/c10/macros/Macros.h Outdated Show resolved Hide resolved

JacobSzwejbka reviewed Jul 17, 2025

View reviewed changes

extension/wasm/wasm_bindings.cpp Show resolved Hide resolved

JacobSzwejbka reviewed Jul 17, 2025

View reviewed changes

extension/wasm/wasm_bindings.cpp Outdated Show resolved Hide resolved

JacobSzwejbka reviewed Jul 17, 2025

View reviewed changes

extension/wasm/wasm_bindings.cpp Show resolved Hide resolved

Applied suggestions

160f15f

Conarnar requested a review from GregoryComer as a code owner July 18, 2025 01:04

Cleaned up tensor classes

bbc46df

Conarnar force-pushed the wasm-bindings-js branch from e8749aa to bbc46df Compare July 18, 2025 20:22

Conarnar added 3 commits July 18, 2025 15:56

Added loading from Uint8Array

79d2769

Merge branch 'main' into wasm-bindings-js

be9c771

Added CI tests

a838685

Conarnar force-pushed the wasm-bindings-js branch from aa8779b to b50ce11 Compare July 19, 2025 23:46

Merge branch 'main' into wasm-bindings-js

9c2b93b

Conarnar force-pushed the wasm-bindings-js branch from b50ce11 to 9c2b93b Compare July 19, 2025 23:47

Conarnar added 2 commits July 19, 2025 16:58

Fix CI

e63961c

Build now uses --post-js to test load from buffer

bfbbfc5

mergennachin requested changes Jul 24, 2025

View reviewed changes

Conarnar added 4 commits July 24, 2025 10:34

Changed JsTensor data to return memory view

b274dae

Applied suggestions

7de34b9

Add making JsTensor from iterator

4aab20f

to_evalue check for undefined

da58ab2

mergennachin reviewed Jul 24, 2025

View reviewed changes

extension/wasm/wasm_bindings.cpp Show resolved Hide resolved

Conarnar and others added 8 commits July 24, 2025 13:36

Merge branch 'main' into wasm-bindings-js

cfa3d4c

Renamed option to build unit tests

fb5ae68

Marked wasm bindings API as experimental

f4e7144

Set enum names for convenience

aa48efb

Module load from ArrayBuffer

6f38b89

Bump PytorchTorch pin to 0725

5cfbc1d

Summary: Needed for pytorch/pytorch#158580 Differential Revision: D78989384

Merge remote-tracking branch 'origin/export-D78989384' into wasm-bind…

c72e574

…ings-js

Merge branch 'main' into wasm-bindings-js

1040b15

mergennachin approved these changes Jul 27, 2025

View reviewed changes

Conarnar and others added 3 commits July 28, 2025 13:07

Merge branch 'main' into wasm-bindings-js

7926335

Applied suggestions, turned on assertions, added dim order strides to…

3345fe9

… unit tests

Added case for error messages longer than 256 characters

f3ba749

mergennachin reviewed Jul 28, 2025

View reviewed changes

extension/wasm/wasm_bindings.cpp Show resolved Hide resolved

mergennachin approved these changes Jul 28, 2025

View reviewed changes

Conarnar and others added 2 commits July 28, 2025 18:26

Added assertion to verify object is tensor

f806259

Merge branch 'main' into wasm-bindings-js

ddbc698

Conarnar merged commit 9f86cf0 into pytorch:main Jul 29, 2025
375 of 393 checks passed

Conarnar added the release notes: api Changes to public facing apis (any interfaces, pybinded runtime methods, etc.) label Jul 29, 2025

Conarnar deleted the wasm-bindings-js branch July 29, 2025 16:02

larryliu0820 reviewed Aug 28, 2025

View reviewed changes


		cmake_minimum_required(VERSION 3.29)

		project(executorch_wasm)

Uh oh!

JavaScript bindings for module API #12571

JavaScript bindings for module API #12571

Uh oh!

Conversation

Conarnar commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

pytorch-bot bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/12571

✅ No Failures

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mergennachin left a comment

Choose a reason for hiding this comment

Uh oh!

mergennachin Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

Conarnar Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

larryliu0820 Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

larryliu0820 Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conarnar commented Jul 17, 2025 •

edited

Loading

pytorch-bot bot commented Jul 17, 2025 •

edited

Loading