Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[js/web] WebGPU backend via JSEP #14579

Merged
merged 90 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
90 commits
Select commit Hold shift + click to select a range
3f76000
enable JSEP (draft)
fs-eire Oct 10, 2022
7a5405d
Squashed commit of the following:
fs-eire Oct 10, 2022
93e6d0a
working
fs-eire Oct 13, 2022
af6bad6
1
fs-eire Oct 17, 2022
41050d5
2
fs-eire Oct 18, 2022
083d430
3
fs-eire Oct 18, 2022
65cc09b
4
fs-eire Oct 19, 2022
f6cd92c
5
fs-eire Oct 24, 2022
e520023
6
fs-eire Oct 25, 2022
2ec6178
7
fs-eire Oct 27, 2022
c087b47
8
fs-eire Oct 28, 2022
4697af7
9
fs-eire Nov 1, 2022
e5dc7f7
10
fs-eire Nov 1, 2022
9e81a04
11
fs-eire Nov 7, 2022
c9b36ea
12
fs-eire Nov 14, 2022
f75ffeb
13
fs-eire Nov 19, 2022
7e3a412
w
fs-eire Nov 19, 2022
764715b
w2
fs-eire Nov 22, 2022
81c0c04
w3
fs-eire Dec 8, 2022
7cdbb71
fix build
fs-eire Dec 9, 2022
19f3a45
use larger asyncify stack
fs-eire Dec 13, 2022
1c45f34
support temp buffer
fs-eire Dec 17, 2022
193bf99
fix build
fs-eire Dec 17, 2022
8ee4c5d
fix copy tensor
fs-eire Dec 17, 2022
1a70d40
fix temp allocation cleanup
fs-eire Dec 20, 2022
cfecdce
less output to console
fs-eire Dec 20, 2022
39a37b6
remove unused internal tensor def
fs-eire Dec 20, 2022
2fd03b1
add reshape impl
fs-eire Dec 20, 2022
bdb55f6
remove 'HANDLE' memory type
fs-eire Dec 20, 2022
1c28286
transpose
fs-eire Jan 7, 2023
f7df9ba
[js] support 2 flags from session options
fs-eire Jan 13, 2023
a032718
conv_by_matmul
fs-eire Jan 23, 2023
ce206b6
fix buildbreak (api upgrade)
fs-eire Jan 24, 2023
429f426
fix conv padding
fs-eire Jan 25, 2023
5791040
support pooling channel last
fs-eire Jan 25, 2023
30c69af
time measuring
fs-eire Jan 26, 2023
c30dd1b
operator: Sigmoid
fs-eire Jan 26, 2023
5ed5ab7
profiling
fs-eire Feb 2, 2023
ba14c5d
clean code
fs-eire Feb 4, 2023
39fabc3
Revert "[js] support 2 flags from session options"
fs-eire Feb 10, 2023
d4a0750
allow reuse allocator
fs-eire Feb 10, 2023
acabe32
remove js_kernel_lookup
fs-eire Feb 10, 2023
a953848
remove some std output
fs-eire Feb 10, 2023
b931ef1
disable arena for js custom allocator
fs-eire Feb 10, 2023
aaad55b
Merge remote-tracking branch 'ms/main' into fs-eire/js-ep-pr
fs-eire Feb 28, 2023
8f87dd9
fix parameter of GetAllocator()
fs-eire Feb 28, 2023
df225fb
remove bb.bat and br.bat
fs-eire Mar 1, 2023
ab091e4
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Mar 1, 2023
09b7439
remove unused comments
fs-eire Mar 2, 2023
0d0b0a1
use target_link_options
fs-eire Mar 9, 2023
17b5b1f
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Mar 15, 2023
5c8c14a
resolve comments #2
fs-eire Mar 16, 2023
372aa7f
match correct ipaddress family
fs-eire Mar 21, 2023
4c0a2b9
const value in declare namepsace does not work - revert
fs-eire Mar 23, 2023
41f8886
erf
fs-eire Mar 23, 2023
39eb959
Merge remote-tracking branch 'ms/main' into fs-eire/js-ep-pr
fs-eire Mar 23, 2023
6c2bb34
resolve comments #
fs-eire Mar 24, 2023
f7d6a6a
Update onnxruntime/core/providers/js/js_kernel.h
fs-eire Mar 24, 2023
83727cd
conv1d
fs-eire Mar 29, 2023
88e5e3f
use shader helper
fs-eire Mar 30, 2023
8b7a570
matmul
fs-eire Mar 30, 2023
058de80
remove unused stats assignment
fs-eire Apr 3, 2023
998f165
replace logging
fs-eire Apr 4, 2023
177d0d7
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Apr 4, 2023
442d222
use ort log
fs-eire Apr 4, 2023
613f37c
add comments for asyncify
fs-eire Apr 5, 2023
1b63fe2
fix typo
fs-eire Apr 5, 2023
40a1ab8
clean up code
fs-eire Apr 5, 2023
2e528f6
code clean
fs-eire Apr 5, 2023
ddacc47
code clean
fs-eire Apr 5, 2023
28fc10a
use verbose log in test runner
fs-eire Apr 5, 2023
b5e6a73
use OrtMemTypeCPU only for cpu
fs-eire Apr 5, 2023
75231d9
use debug logging
fs-eire Apr 5, 2023
6f0e42d
fix per kernel custom data
fs-eire Apr 6, 2023
21676c2
fix eslint
fs-eire Apr 6, 2023
63d5a6a
remove from default backends in test
fs-eire Apr 7, 2023
6d03488
use macro 'USE_JS' to wrap OrtRun
fs-eire Apr 7, 2023
2e8a039
disable tests Reduce* ops for webgl
fs-eire Apr 8, 2023
3109945
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Apr 12, 2023
46e62a4
fix build break in api.cc
fs-eire Apr 12, 2023
57b520e
add jsep in wasm build CI
fs-eire Apr 14, 2023
62e6f3d
resolve comments
fs-eire Apr 14, 2023
129efe8
update TPN
fs-eire Apr 14, 2023
0d8ecd4
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Apr 14, 2023
f0ac354
revert extracting build flags from parameters
fs-eire Apr 17, 2023
8ae2e01
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Apr 17, 2023
25f3897
revert post-merge-jobs
fs-eire Apr 17, 2023
f3e9dee
add a few comments
fs-eire Apr 18, 2023
eaa818d
Merge remote-tracking branch 'origin/main' into fs-eire/js-ep-pr
fs-eire Apr 18, 2023
ae5e444
format code
fs-eire Apr 19, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 215 additions & 6 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5422,8 +5422,8 @@ _____

Tencent/rapidjson, https://github.com/Tencent/rapidjson

Tencent is pleased to support the open source community by making RapidJSON available.
Tencent is pleased to support the open source community by making RapidJSON available.

Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.

If you have downloaded a copy of the RapidJSON binary from Tencent, please note that the RapidJSON binary is licensed under the MIT License.
Expand All @@ -5435,13 +5435,13 @@ Other dependencies and licenses:
Open Source Software Licensed Under the BSD License:
--------------------------------------------------------------------

The msinttypes r29
Copyright (c) 2006-2013 Alexander Chemeris
The msinttypes r29
Copyright (c) 2006-2013 Alexander Chemeris
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Expand All @@ -5450,7 +5450,7 @@ THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPR
Open Source Software Licensed Under the JSON License:
--------------------------------------------------------------------

json.org
json.org
Copyright (c) 2002 JSON.org
All Rights Reserved.

Expand Down Expand Up @@ -5784,3 +5784,212 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

_____

TensorFlow.js

https://github.com/tensorflow/tfjs


Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
6 changes: 6 additions & 0 deletions cmake/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ option(onnxruntime_USE_QNN "Build with QNN support" OFF)
option(onnxruntime_USE_SNPE "Build with SNPE support" OFF)
option(onnxruntime_USE_RKNPU "Build with RKNPU support" OFF)
option(onnxruntime_USE_DNNL "Build with DNNL support" OFF)
option(onnxruntime_USE_JS "Build with JavaScript implemented kernels support" OFF)
option(onnxruntime_BUILD_UNIT_TESTS "Build ONNXRuntime unit tests" ON)
option(onnxruntime_BUILD_CSHARP "Build C# library" OFF)
option(onnxruntime_BUILD_OBJC "Build Objective-C library" OFF)
Expand Down Expand Up @@ -652,6 +653,11 @@ if (onnxruntime_USE_NNAPI_BUILTIN)
list(APPEND ORT_PROVIDER_CMAKE_FLAGS -Donnxruntime_USE_NNAPI_BUILTIN=1)
list(APPEND ONNXRUNTIME_PROVIDER_NAMES nnapi)
endif()
if (onnxruntime_USE_JS)
list(APPEND ORT_PROVIDER_FLAGS -DUSE_JS=1)
list(APPEND ORT_PROVIDER_CMAKE_FLAGS -Donnxruntime_USE_JS=1)
list(APPEND ONNXRUNTIME_PROVIDER_NAMES js)
endif()
if (onnxruntime_USE_QNN)
list(APPEND ORT_PROVIDER_FLAGS -DUSE_QNN=1)
list(APPEND ORT_PROVIDER_CMAKE_FLAGS -Donnxruntime_USE_QNN=1)
Expand Down
21 changes: 21 additions & 0 deletions cmake/onnxruntime_providers.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ endif()
if(onnxruntime_USE_NNAPI_BUILTIN)
set(PROVIDERS_NNAPI onnxruntime_providers_nnapi)
endif()
if(onnxruntime_USE_JS)
set(PROVIDERS_JS onnxruntime_providers_js)
endif()
if(onnxruntime_USE_QNN)
set(PROVIDERS_QNN onnxruntime_providers_qnn)
endif()
Expand Down Expand Up @@ -1064,6 +1067,24 @@ if (onnxruntime_USE_NNAPI_BUILTIN)
endif()
endif()

if (onnxruntime_USE_JS)
add_compile_definitions(USE_JS=1)

file(GLOB_RECURSE onnxruntime_providers_js_cc_srcs
"${ONNXRUNTIME_ROOT}/core/providers/js/*.h"
"${ONNXRUNTIME_ROOT}/core/providers/js/*.cc"
)

source_group(TREE ${ONNXRUNTIME_ROOT}/core FILES ${onnxruntime_providers_js_cc_srcs})
onnxruntime_add_static_library(onnxruntime_providers_js ${onnxruntime_providers_js_cc_srcs})
onnxruntime_add_include_to_target(onnxruntime_providers_js
onnxruntime_common onnxruntime_framework onnx onnx_proto ${PROTOBUF_LIB} flatbuffers Boost::mp11
)

add_dependencies(onnxruntime_providers_js ${onnxruntime_EXTERNAL_DEPENDENCIES})

endif()

if (onnxruntime_USE_QNN)
add_compile_definitions(USE_QNN=1)

Expand Down
15 changes: 15 additions & 0 deletions cmake/onnxruntime_unittests.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,10 @@ if(onnxruntime_USE_NNAPI_BUILTIN)
list(APPEND onnxruntime_test_providers_dependencies onnxruntime_providers_nnapi)
endif()

if(onnxruntime_USE_JS)
list(APPEND onnxruntime_test_providers_dependencies onnxruntime_providers_js)
endif()

if(onnxruntime_USE_RKNPU)
list(APPEND onnxruntime_test_providers_dependencies onnxruntime_providers_rknpu)
endif()
Expand Down Expand Up @@ -547,6 +551,7 @@ set(ONNXRUNTIME_TEST_LIBS
${onnxruntime_libs}
# CUDA, ROCM, TENSORRT, MIGRAPHX, DNNL, and OpenVINO are dynamically loaded at runtime
${PROVIDERS_NNAPI}
${PROVIDERS_JS}
${PROVIDERS_QNN}
${PROVIDERS_SNPE}
${PROVIDERS_RKNPU}
Expand Down Expand Up @@ -599,6 +604,13 @@ if(onnxruntime_USE_NNAPI_BUILTIN)
list(APPEND onnxruntime_test_providers_libs onnxruntime_providers_nnapi)
endif()

if(onnxruntime_USE_JS)
list(APPEND onnxruntime_test_framework_src_patterns ${TEST_SRC_DIR}/providers/js/*)
list(APPEND onnxruntime_test_framework_libs onnxruntime_providers_js)
list(APPEND onnxruntime_test_providers_dependencies onnxruntime_providers_js)
list(APPEND onnxruntime_test_providers_libs onnxruntime_providers_js)
endif()

if(onnxruntime_USE_QNN)
list(APPEND onnxruntime_test_framework_src_patterns ${TEST_SRC_DIR}/providers/qnn/*)
list(APPEND onnxruntime_test_framework_libs onnxruntime_providers_qnn)
Expand Down Expand Up @@ -842,6 +854,9 @@ if (onnxruntime_BUILD_WEBASSEMBLY)
if (onnxruntime_ENABLE_WEBASSEMBLY_THREADS)
set_property(TARGET onnxruntime_test_all APPEND_STRING PROPERTY LINK_FLAGS " -s USE_PTHREADS=1 -s PROXY_TO_PTHREAD=1")
endif()
if (onnxruntime_USE_JS)
set_property(TARGET onnxruntime_test_all APPEND_STRING PROPERTY LINK_FLAGS " --pre-js \"${ONNXRUNTIME_ROOT}/wasm/js_internal_api.js\"")
endif()
endif()

if (onnxruntime_ENABLE_ATEN)
Expand Down
Loading