-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: describe how OpenVINO paths are found (#62)
`openvino-finder` encodes some rather complex logic to find OpenVINO files over several versions. This change describes that logic (and the rationale for it) in more detail and moves this text to the Rust documentation, closer to the code.
- Loading branch information
Showing
4 changed files
with
96 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,7 @@ | ||
openvino-finder | ||
=============== | ||
|
||
A utility for locating OpenVINO™ libraries on a host system. It will attempt to find the OpenVINO | ||
shared libraries in: | ||
- the `OPENVINO_BUILD_DIR` environment variable (pointed at a locally-built OpenVINO repository) | ||
- the `OPENVINO_INSTALL_DIR` environment variable (pointed at the top-level OpenVINO installation, | ||
e.g., `/opt/intel/openvino`) | ||
- the `INTEL_OPENVINO_DIR` environment variable (same as above; this is set by OpenVINO setup | ||
scripts) | ||
- the environment's library path (e.g., `LD_LIBRARY_PATH` in Linux; this is also set by the OpenVINO | ||
setup scripts) | ||
- OpenVINO's default installation paths for the OS (a best effort attempt) | ||
A utility for locating OpenVINO™ files on a host system. Consult the [docs] for an in-depth | ||
description of how to use this crate (and troubleshoot issues). | ||
|
||
### Use | ||
|
||
```Rust | ||
let path = openvino_finder::find("inference_engine_c_api").unwrap(); | ||
``` | ||
[docs]: https://docs.rs/openvino-finder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters