microsoft / microsoft/onnxruntime

[Documentation] `onnxruntime-node` appears to contain `darwin/arm64` pre-built binaries, yet there's no mention of mac ARM64 support anywhere

Open
#15,226 1 comment 0 reactions 0 assignees View on GitHub
documentation platform:web
Dominant language
C++
Stars
21.9k
Forks
4.2k
Avg merge
4d 11h
Merged PRs (30d)
184

Description

I noticed that on `node_modules/onnxruntime-node/bin/napi-v3/darwin/arm64` there are pre-built binary files that are apparently targeting ARM64 mac. I don't have access to a mac device, so I can't verify if they any effect on Apple ARM64 devices (like those based on Apple Silicon).

Based on information on the `npm` website, these files have been bundled for more than year now, as far back as version `1.10`, which was published on December 2021:

![Screenshot_1](https://user-images.githubusercontent.com/8589488/227755707-35dd49fd-3088-43eb-8e09-5c945ccf8f70.png)

Yet, there is no mention whatsoever of macOS ARM64 support of `onnxruntime-node`. Not on [https://onnxruntime.ai/](https://onnxruntime.ai/):

![Screenshot_2](https://user-images.githubusercontent.com/8589488/227755759-f8638039-7a89-4017-b5d4-87e522f1cedb.png)

and not on [https://github.com/microsoft/onnxruntime/tree/main/js/node](https://github.com/microsoft/onnxruntime/tree/main/js/node):

![Screenshot_3](https://user-images.githubusercontent.com/8589488/227755805-34c99639-5b68-45e6-b3b4-31b07f22e062.png)

There are also no related discussions or issues that I could find, including any requests or questions about supporting ARM64 macs, or anything related, which is odd.

I'm publishing a tool that is heavily based on `onnxruntime-node`, so I want to ensure that newer macOS devices (M1, M2) are supported directly. I can't test it so I don't know what exactly do these files are destined for.

Contributor guide

Open the contributing guide

Research direction

Start with the reported node_modules/onnxruntime-node/bin/napi-v3/darwin/arm64 path and the documentation under js/node. Verify what platform the bundled binaries support, ideally on an Apple Silicon macOS system, then update the relevant onnxruntime-node documentation so the supported status and limitations are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos, node.js
Domain
documentation, machine-learning, operating-systems
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.