Skip to content

Commit f9527c4

Browse files
committed
Update README.md
1 parent fa79651 commit f9527c4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is an **experimental** Java binding to Microsoft's [ONNX Runtime](https://g
88

99
This uses Java's Panama project. Given the incubating status of that project, this library should be considered a proof of concept and lacks the stability guarantees at this time. The minimum supported Java version is 17.
1010

11-
This project's goals are to provide a type-safe, performant binding which abstracts lot of the native and C API intricacies and is loosely coupled to the upstream project.
11+
This project's goals are to provide a type-safe, performant binding which abstracts a lot of the native and C API intricacies and is loosely coupled to the upstream project.
1212

1313
## Usage
1414

@@ -17,9 +17,9 @@ This project's goals are to provide a type-safe, performant binding which abstra
1717

1818
This project is released to [Maven Central](https://search.maven.org/artifact/com.jyuzawa/onnxruntime) and can be used in your project. There are a few artifacts published:
1919

20-
* `onnxruntime` - The binding with no native libraries. For use as a compile dependency.
21-
* `onnxruntime-cpu` - A collection of native libraries with CPU support for a several common OS/architecture combinations. For use as an optional runtime dependency.
22-
* `onnxruntime-gpu` - A collection of native libraries with GPU support for a several common OS/architecture combinations. For use as an optional runtime dependency.
20+
* [`onnxruntime`](https://search.maven.org/artifact/com.jyuzawa/onnxruntime) - The binding with no native libraries. For use as a compile dependency.
21+
* [`onnxruntime-cpu`](https://search.maven.org/artifact/com.jyuzawa/onnxruntime-cpu) - A collection of native libraries with CPU support for a several common OS/architecture combinations. For use as an optional runtime dependency.
22+
* [`onnxruntime-gpu`](https://search.maven.org/artifact/com.jyuzawa/onnxruntime-gpu) - A collection of native libraries with GPU support for a several common OS/architecture combinations. For use as an optional runtime dependency.
2323

2424
The native library (from Microsoft) will need to be provided at runtime using one of the latter two artifacts. Alternative, the Java library path (`java.library.path`) will be used if neither of those artifacts is provided.
2525

@@ -45,5 +45,5 @@ The example application can be ran:
4545

4646
#### JVM Arguments
4747

48-
Since this uses a native library, this will require the runtime to have the `--enable-native-access=ALL-UNNAMED` JVM option.
48+
Since this uses a native library, this will require the runtime to have the `--enable-native-access` JVM option, likely `--enable-native-access=ALL-UNNAMED`.
4949
If you are not using modules, you will need to also use `--add-modules jdk.incubator.foreign` as well.

0 commit comments

Comments
 (0)