Skip to content

Commit

Permalink
Add instructions on how to include GPU support with TFJava 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
karllessard authored Nov 1, 2024
1 parent d625dbb commit fb3f393
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ For dependencies, we can use anything compliant with [this list](https://opensou

## Building

To build all the artifacts locally, simply invoke the command `mvn install` at the root of this repository (or the Maven command of your choice). It is also
possible to build artifacts with support for CUDA® by adding the `-Djavacpp.platform.extension=-gpu` argument to the Maven command.
To build all the artifacts locally, simply invoke the command `mvn install` at the root of this repository (or the Maven command of your choice).

### JDK 16+

Expand All @@ -35,7 +34,7 @@ This can be done in `.mvn/jvm.config` or `MAVEN_OPTS`.
### Native Builds

By default, the build will attempt to download the existing TensorFlow binaries from the web for the platform it is running on (so you need to have an active internet connection).
If such binaries are not available for your platform, you will need to build the TensorFlow runtime library from sources, by appending the `-Dnative.build` argument to your Maven
If such binaries are not available for your platform, you will need to build the TensorFlow runtime library from sources, by appending the `-Pnative-build` argument to your Maven
command. This requires a valid environment for building TensorFlow, including the [bazel](https://bazel.build/) build tool and a few Python dependencies
(please read [TensorFlow documentation](https://www.tensorflow.org/install/source) for more details). Note that building from sources can take multiple hours on a regular laptop.

Expand Down
18 changes: 18 additions & 0 deletions MIGRATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,24 @@ The Java Module (jigsaw) names has been updated to drop the leading `org.`, as f
- `tensorflow-core-native` : `tensorflow.nativelib`
- `tensorflow-framework` : `tensorflow.framework` (was `org.tensorflow.framework` before)

### GPU Support

Previous versions of TF Java were building a `tensorflow-core-platform-gpu` artifact upon which application could depend
on to include any TensorFlow native library that GPU support enabled. Since TensorFlow has removed its support of GPU
on all platforms other that Linux, we removed our platform JAR in favour of simply adding a dependency on the
`linux-x86_64-gpu` native artifact.
```xml
<dependency>
<group>org.tensorflow</group>
<artifact>tensorflow-core-native</artifact>
<version>1.0.0</version>
<classifier>linux-x86_64-gpu</classifier>
</dependency>
```
Please note that including this dependency won't work if your application also depends on `tensorflow-core-platform`. If
you need to support more platforms that Linux, you should include the other `tensorflow-core-native` dependencies
separately (see the [README](README.md) file).

### Session Run Result

In versions before 0.4.0 `Session.Runner.run` and `TensorFunction.call` returned a `List<Tensor>`. In newer versions
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Only one dependency can be added per platform, meaning that you cannot add nativ
In some cases, it might be preferable to add a single dependency that includes transitively all the artifacts
required to run TensorFlow Java on any [supported platforms](README.md#individual-dependencies)

- `tensorflow-core-platform`: Includes `tensorflow-core-api`, plus native artifacts for `linux-x86_64`, `macosx-arm64`, `macosx-x86_64` and `windows-x86_64`
- `tensorflow-core-platform`: Includes `tensorflow-core-api`, plus native artifacts for `linux-x86_64`, `linux-x86_64-arm64`, `macosx-arm64`, `macosx-x86_64` and `windows-x86_64`

For example, to run TensorFlow Java on any CPU platform for which a binary is being distributed by this project, you can
simply add this dependency to your application:
Expand Down

0 comments on commit fb3f393

Please sign in to comment.