Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Adding a description of our supported platforms. #26

Merged
merged 12 commits into from
Dec 8, 2018

Conversation

liuziyue
Copy link
Contributor

@liuziyue liuziyue commented Dec 4, 2018

No description provided.

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.
Copy link
Contributor

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]

Copy link
Contributor

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 Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
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 |
Copy link
Contributor

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -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.
Copy link
Contributor

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

Copy link
Contributor

@fs-eire fs-eire left a 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

Copy link
Contributor

@fs-eire fs-eire left a 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'

@@ -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.
Copy link
Member

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).
Copy link
Member

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...

@liuziyue liuziyue merged commit 7652e0c into microsoft:master Dec 8, 2018
@liuziyue liuziyue deleted the supportTable branch December 8, 2018 00:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants