https://github.com/bytecodealliance/wasi-nn
High-level bindings for wasi-nn system calls
https://github.com/bytecodealliance/wasi-nn
Last synced: 7 months ago
JSON representation
High-level bindings for wasi-nn system calls
- Host: GitHub
- URL: https://github.com/bytecodealliance/wasi-nn
- Owner: bytecodealliance
- License: apache-2.0
- Created: 2021-03-26T21:09:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T06:13:05.000Z (about 1 year ago)
- Last Synced: 2025-06-13T00:09:14.575Z (8 months ago)
- Language: CSS
- Homepage:
- Size: 239 MB
- Stars: 49
- Watchers: 10
- Forks: 37
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Introduction
This project provides high-level wasi-nn bindings for Rust and AssemblyScript. The basic idea: write
your machine learning application in a high-level language using these bindings, compile it to
WebAssembly, and run it in a WebAssembly runtime that supports the [wasi-nn] proposal, such as
[Wasmtime] and [WasmEdge].
[Wasmtime]: https://wasmtime.dev
[wasi-nn]: https://github.com/WebAssembly/wasi-nn
[WasmEdge]: https://github.com/WasmEdge/WasmEdge
> __NOTE__: These bindings are experimental (use at your own risk) and subject to upstream changes
> in the [wasi-nn] specification.
### Use
- In Rust, download the [crate from crates.io][crates.io] by adding `wasi-nn = "0.6.0"` as a Cargo
dependency; more information in the [Rust README].
- In AssemblyScript, download the [package from npmjs.com][npmjs.com] by adding `"as-wasi-nn":
"^0.3.0"` as an NPM dependency; more information in the [AssemblyScript README].
- When you call Wasmtime, you'll need to pass the flag `--wasi-modules=experimental-wasi-nn` to
enable the use use of wasi-nn.
- For WasmEdge, you should install the [wasi-nn plugin] first.
[crates.io]: https://crates.io/crates/wasi-nn
[Rust README]: rust/README.md
[npmjs.com]: https://www.npmjs.com/package/wasi-nn
[AssemblyScript README]: assemblyscript/README.md
[wasi-nn plugin]: https://wasmedge.org/docs/category/ai-inference
### Examples
This repository includes examples of using these bindings. See the [Rust example] and
[AssemblyScript example] to walk through an end-to-end image classification using an AlexNet model.
Currently the example uses OpenVino as the backend. If you are running Ubuntu, you can simply run
the script to install the supported version`.github/actions/install-openvino/install.sh`. Otherwise
you'll need to visit the [Installation Guides] and follow the instructions for your OS. The version
of OpenVino currently supported is openvino_2022.1.0.643.
Once you have OpenVino installed, run them with:
- `./build.sh rust` runs the [Rust example]
- `./build.sh as` runs the [AssemblyScript example]
[Rust example]: rust/examples/classification-example
[AssemblyScript example]: assemblyscript/examples/object-classification.ts
[Installation Guides]: https://docs.openvino.ai/2023.3/openvino_docs_install_guides_overview.html
To run examples in WasmEdge, consult this article: [WasmEdge wasi-nn examples].
[WasmEdge wasi-nn examples]: https://github.com/second-state/WasmEdge-WASINN-examples
### Related Links
- [WASI]
- [wasi-nn]
- [Wasmtime]
- [WasmEdge]
- [AssemblyScript]
- [OpenVino]
[WASI]: https://github.com/WebAssembly/WASI
[AssemblyScript]: https://www.assemblyscript.org/
[OpenVino]: https://docs.openvinotoolkit.org/latest/index.html
### License
This project is licensed under the Apache 2.0 license. See [LICENSE] for more details.
[LICENSE]: LICENSE
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
this project by you, as defined in the Apache-2.0 license, shall be licensed as above, without any
additional terms or conditions.
