Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.11 KB

README.md

File metadata and controls

81 lines (52 loc) · 2.11 KB

wasi-nn bindings for Rust

This package contains high-level Rust bindings for wasi-nn system calls. It is similar in purpose to the WASI bindings but this package provides optional access to a system's machine learning functionality from WebAssembly.

NOTE: These bindings are experimental (use at your own risk) and subject to upstream changes in the wasi-nn specification.

Use

  1. Depend on this crate in your Cargo.toml:

    [dependencies]
wasi-nn = "0.1.0"

  2. Use the wasi-nn APIs in your application, for example:

    use wasi_nn;

unsafe {
    wasi_nn::load(
        &[&xml.into_bytes(), &weights],
        wasi_nn::GRAPH_ENCODING_OPENVINO,
        wasi_nn::EXECUTION_TARGET_CPU,
    )
    .unwrap()
}

  3. Compile the application to WebAssembly:

    cargo build --target=wasm32-wasi

  4. Run the generated WebAssembly in a runtime supporting wasi-nn, e.g. Wasmtime.

Build

To build this crate from source, use: cargo build.

Generation

This crate contains code (src/generated.rs) generated by witx-bindgen. To regenerate this code, run witx-bindgen against the wasi-nn WITX file:

.../crates/witx-bindgen$ cargo run .../wasi-nn/phases/ephemeral/witx/wasi_ephemeral_nn.witx

Examples

The examples demonstrate how to use wasi-nn from a Rust program.

License

This project is licensed under the Apache 2.0 license. See LICENSE for more details.

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.