-
Notifications
You must be signed in to change notification settings - Fork 130
Adding a description of our supported platforms. #26
Conversation
README.md
Outdated
@@ -11,6 +11,8 @@ With ONNX.js, web developers can score pre-trained ONNX models directly on brows | |||
|
|||
ONNX.js can run on both CPU and GPU. For running on CPU, [WebAssembly](https://developer.mozilla.org/en-US/docs/WebAssembly) is adopted to execute model at near-native speed. Furthermore, ONNX.js utilizes [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) to provide a "multi-threaded" environment to parallelize data processing. Empirical evaluation shows very promising performance gains on CPU by taking full advantage of WebAssembly and Web Workers. For running on GPUs, a popular standard for accessing GPU capabilities - WebGL is adopted. ONNX.js has further adopted several novel optimization techniques for reducing data transfer between CPU and GPU, as well as some techniques to reduce GPU processing cycles to further push the performance to the maximum. | |||
|
|||
See [here](#Platforms-supported) for a list of platforms ONNX.js supports. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's make this line a 'quick link' line
See [compatibility], [operators supported]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link of [Operators Supported] is broken
README.md
Outdated
| OS/Browser | Chrome | Edge | FireFox | Safari | Opera | Electron | Node.js | | ||
|:----------:|:------:|:----:|:-------:|:------:|:-----:|:-----:|:-----:| | ||
| Windows 10 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | ||
| macOS | :heavy_check_mark: | - | :heavy_check_mark: | Coming soon | :heavy_check_mark: | Coming soon | Coming soon | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should take a look at Node.js on macOS.
I think this should already supported
README.md
Outdated
| Android | :heavy_check_mark: | :heavy_check_mark: | Coming soon | - | :heavy_check_mark: | | ||
|
||
### Operators | ||
ONNX.js currently supports most operators in **`ai.onnx`** operator set v7 (opset v7). See [operators.md](./docs/operators.md) for a complete, detailed list of which ONNX operators are supported by the 3 available builtin backends (cpu, wasm, and webgl). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add links to operator sets ai.onnx
and ai.onnx.ml
https://github.com/onnx/onnx/blob/master/docs/Operators.md
https://github.com/onnx/onnx/blob/master/docs/Operators-ml.md
docs/operators.md
Outdated
@@ -1,63 +1,63 @@ | |||
The following table lists the ONNX operators supported by each of the available backends. | |||
The following table lists the **ai.onnx** operators supported by each of the available backends. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add links to operator set ai.onnx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are new changes to /docs/operators.md in master
make sure update to latest before merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please merge with commit msg 'doc: update compatibility and operators supported'
docs/operators.md
Outdated
@@ -1,64 +1,64 @@ | |||
The following table lists the ONNX operators supported by each of the available backends. | |||
The following table lists the [ai.onnx](https://github.com/onnx/onnx/blob/master/docs/Operators.md) operators supported by each of the available backends. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a slight inconsistency in the URL mentioned here and that used to link to the specific operators below- 'master' branch vs 'rel1.2.3' (which should be OpSet v7). @fs-eire - which one should we keep ?
README.md
Outdated
| Android | :heavy_check_mark: | :heavy_check_mark: | Coming soon | - | :heavy_check_mark: | | ||
|
||
### Operators | ||
ONNX.js currently supports most operators in [ai.onnx](https://github.com/onnx/onnx/blob/master/docs/Operators.md) operator set v7 (opset v7). See [operators.md](./docs/operators.md) for a complete, detailed list of which ONNX operators are supported by the 3 available builtin backends (cpu, wasm, and webgl). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as the comment in ./docs/operators.md - 'master' vs 'rel-1.2.3' in the URL...
No description provided.