andrey/onnxruntime-rs
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Basile Henry 2020-08-23 15:30:53 +01:00
parent d999026b33
commit 3ca3a39c57
1 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,12 +1,46 @@
# onnxruntime
This crate contains bindings to onnxruntime.
![Cargo CI](https://github.com/basile-henry/onnxruntime-rs/workflows/Cargo%20CI/badge.svg)
![Nix CI](https://github.com/basile-henry/onnxruntime-rs/workflows/Nix%20CI/badge.svg)
In order to build/use this crate you must either have onnxruntime installed on
your system or build the onnxruntime project from source.
This crate provides bindings to
[`onnxruntime`](https://github.com/microsoft/onnxruntime). Raw bindings
to the C API (`sys` module) as well as some opinionated wrappers to make
`onnxruntime` usable safely from plain Rust.
To build from source (Linux) do the following from the root of the repo:
In order to build and use this crate with `cargo` you must either have
`onnxruntime` installed on your system or point to the release (or build) of
`onnxruntime` you want to use manually.
Tested (on Linux) with `onnxruntime` versions:
- [`1.2.0`](https://github.com/microsoft/onnxruntime/releases/tag/v1.2.0)
- [`1.3.0`](https://github.com/microsoft/onnxruntime/releases/tag/v1.3.0)
- [`1.4.0`](https://github.com/microsoft/onnxruntime/releases/tag/v1.4.0)
## Download the latest release of `onnxruntime`
Download from: https://github.com/microsoft/onnxruntime/releases
Then either install it globally (for example `/usr/local/{lib,include/`) or
export the following environment variables:
`ONNXRUNTIME_LIB_DIR`: path to the `lib` directory of the release
`ONNXRUNTIME_INCLUDE_DIR`: path to the `include` directory of the release
Also make sure the `lib` directory is also part of `LD_LIBRARY_PATH`.
## Build `onnxruntime` from source
Follow the guide at:
https://github.com/microsoft/onnxruntime/blob/master/BUILD.md
For Linux/Mac OS X:
- The lib directory will be:
`onnxruntime/build/Linux/RelWithDebInfo/`
- The include directory will be:
`onnxruntime/include/onnxruntime/core/session/`
In `onnxruntime` directory:
```bash
./build.sh --config RelWithDebInfo --build_shared_lib --parallel
export ONNXRUNTIME_LIB_DIR=$PWD/build/Linux/RelWithDebInfo/