Expand description
Ergonomic rust bindings for MNN
The main data structures used are Tensor and Interpreter.
Interpreter should be thread safe and can be used to run multiple sessions concurrently.
Send / Sync is not implemented for Interpreter yet since we don’t know how it will be used.
§Example
use mnn::*;
let mut interpreter = Interpreter::from_bytes([0;100]).unwrap();
let mut sc = ScheduleConfig::new();
let session = interpreter.create_session(sc).unwrap();
let mut input = interpreter.input::<f32>(&session, "input").unwrap();
let mut tensor = input.create_host_tensor_from_device(false);
tensor.host_mut().fill(1.0f32);
input.copy_from_host_tensor(&tensor).unwrap();
interpreter.run_session(&session).unwrap();
let output = interpreter.output::<u8>(&session, "output").unwrap();
let mut output_tensor = output.create_host_tensor_from_device(true);
std::fs::write("output.bin", output_tensor.host().to_vec()).unwrap();NOTE: The library is still in development and the API is subject to change.
§Features
metal: Enable mnn Metal backendcoreml: Enable mnn CoreML backendvulkan: Enable mnn Vulkan backend (unimplemented from rust wrapper)opencl: Enable mnn OpenCL backendopengl: Enable mnn OpenGL backend (unimplemented from rust wrapper)openmp: Enable mnn Openmp ( disable the mnn-threadpool feature to enable this)mnn-threadpool: Enable mnn threadpool ( enabled by default can’t be used with openmp)sync: Enable sync apiprofile: Enable profiling ( emits some profiling tracing events )tracing: Enable tracing ( emits some tracing events )crt_static: Link statically to the C runtime on windows (noop on other platforms)
§License
This links to the MNN library which is licensed under the Apache License 2.0.
The rust bindings are licensed under the same Apache License 2.0.
§Building
The flake.nix provides a nix-shell with all the dependencies required to build the library.
If not using nix you’ll need to clone the git submodule to get the MNN source code in mnn-sys/vendor first
Or you can export the MNN_SRC environment variable to point to the MNN source code.
§Compatibility Chart for current crate
| MNN Backend | Compiles | Works |
|---|---|---|
| CPU | ✅ | ✅ |
| OpenCL | ✅ | ✅ |
| Metal | ✅ | ✅ |
| CoreML | ✅ | 🚸 |
| OpenGL | ❌ | ❌ |
| Vulkan | ❌ | ❌ |
- ✅ - Works
- 🚸 - Some models work
- ❌ - Doesn’t work
Re-exports§
pub use backend::*;pub use error::*;pub use interpreter::*;pub use schedule::*;pub use session::*;pub use tensor::*;