mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-14 20:48:00 +00:00
96b95a24ee
This adds updated Rust bindings that have been located at [nbigaouette/onnxruntime-rs](https://github.com/nbigaouette/onnxruntime-rs). check out the build instructions included in this PR at /rust/BUILD.md. Changes to the bindings included in this PR: - The bindings are generated with the build script on each build - The onnxruntime shared library is built with ORT_RUST_STRATEGY=compile which is now the default. - A memory leak was fixed where a call to free wasn't called - Several small memory errors were fixed - Session is Send but not Sync, Environment is Send + Sync - Inputs and Outputs can be ndarray::Arrays of many different types. Some commits can be squashed, if wanted, but were left unsquashed to show differences between old bindings and new bindings. This PR does not cover packaging nor does it include the Rust bindings withing the build system. For those of you who have previous Rust code based on the bindings, these new bindings can be used as a `path` dependency or a `git` dependency (though I have not tested this out). The work addressed in this PR was discussed in #11992
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
# Building and testing the Rust bindings
|
|
|
|
These instructions require cargo and rustc.
|
|
To get these follow the instructions at [https://rustup.rs](https://rustup.rs)
|
|
The instructions compile the onnxruntime along with the bindings,
|
|
so require `cmake`, a python 3 interpreter, clang (needed to parse the C headers to generate the Rust bindings),
|
|
and the platform compiler to compile onnxruntime.
|
|
|
|
## Local setup of onnxruntime repo
|
|
|
|
```sh
|
|
git clone https://github.com/microsoft/onnxruntime
|
|
cd onnxruntime
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
## cargo build both crates
|
|
|
|
from the root of onnxruntime repo
|
|
|
|
```sh
|
|
CARGO_TARGET_DIR=build/rust cargo build --manifest-path rust/Cargo.toml
|
|
```
|
|
|
|
The CARGO_TARGET_DIR environment variable puts the build artifacts in `onnxruntime/build/rust`
|
|
instead of `onnxruntime/rust/target`.
|
|
|
|
## cargo test both crates
|
|
|
|
```sh
|
|
CARGO_TARGET_DIR=build/rust cargo test --manifest-path rust/Cargo.toml --features model-fetching
|
|
```
|
|
|
|
### cargo test both crates while specifying the absolute path to the OnnxRuntime shared library.
|
|
|
|
```sh
|
|
RUST_ONNXRUNTIME_LIBRARY_PATH=<absolute path to shared library/libonnxruntime.so> CARGO_TARGET_DIR=build/rust cargo test --manifest-path rust/Cargo.toml --features model-fetching
|
|
```
|
|
|
|
## cargo test with sanitizer support
|
|
|
|
**If you are using a nightly Rust compiler and are on one the platforms listed in [Rust sanitizer support](https://doc.rust-lang.org/beta/unstable-book/compiler-flags/sanitizer.html).**
|
|
|
|
where `$SAN` is one of `address`, `thread`, `memory` or `leak`
|
|
|
|
```sh
|
|
RUSTFLAGS="-Zsanitizer=$SAN" CARGO_TARGET_DIR=build/rust cargo test --manifest-path rust/Cargo.toml --features model-fetching --target <your target for example x86_64-unknown-linux-gnu> -Z build-std -- --test-threads=1
|
|
```
|