NotificationsYou must be signed in to change notification settings
Fork964
Star14.1k

refactor: deprecate onnx.env.webgpu.powerPreference#1199

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

Hengry wants to merge1 commit intohuggingface:main

base:main

Choose a base branch

fromHengry:feat/onnx-env-webgpu-power-preference-deprecation

Open

refactor: deprecate onnx.env.webgpu.powerPreference#1199

Hengry wants to merge1 commit intohuggingface:mainfromHengry:feat/onnx-env-webgpu-power-preference-deprecation

Conversation

Copy link

Hengry commentedFeb 19, 2025

Onnxruntime-web deprecatedpowerPreference in WebGPUFlag.

Instead, they suggested

Create your own GPUAdapter, use it to create a GPUDevice instance and setdevice property if you want to use a specific power preference.

Reference:
https://onnxruntime.ai/docs/api/js/interfaces/Env.WebGpuFlags.html#powerPreference:~:text=Create%20your%20own%20GPUAdapter%2C%20use%20it%20to%20create%20a%20GPUDevice%20instance%20and%20set%20device%20property%20if%20you%20want%20to%20use%20a%20specific%20power%20preference.

refactor: deprecate onnx.env.webgpu.powerPreference

15c25ed

Copy link

Contributor

fs-eire commentedFeb 19, 2025

Creating a custom device is supported in onnxruntime-web, but there are also several things to be careful with:

onnxruntime-web callsadapter.requestDevice(params) with specificrequiredFeatures andrequiredLimits inparams. Creating the device using different params will not be guaranteed to work.
there are slightly different behavior between different versions for the implementation of dealing withenv.webgpu.device andenv.webgpu.adapter. the stable implementation is planned for onnxruntime-web 1.22.0 release.

And regarding the "powerPreference" option, it actually makes little difference:

This option is currently not working in Chrome on Windows:https://issues.chromium.org/issues/369219127
FromMDN:
Note: On Chrome running on dual-GPU macOS devices, if requestAdapter() is called without a powerPreference option, the high-performance discrete GPU is returned when the user's device is on AC power. Otherwise, the low-power integrated GPU is returned.
So, the difference between default andhigh-performance only happens on Macbook with Intel CPU when it's on battery. (seems that is the only macOS device that both has multiple GPU and can run on battery - please correct me if I was wrong)

I am also trying to figure out if settingpowerPreference to "low-power" is possibly a real requirement for onnxruntime-web. If not, probably the easiest way is to always set it to "high-performance" in onnxruntime-web.