1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
# TensorFlow for Java
Java bindings for TensorFlow. ([Javadoc](https://www.tensorflow.org/api_docs/java/reference/org/tensorflow/package-summary))
[](https://maven-badges.herokuapp.com/maven-central/org.tensorflow/tensorflow)
> *WARNING*: The TensorFlow Java API is not currently covered by the TensorFlow
> [API stability guarantees](https://www.tensorflow.org/programmers_guide/version_semantics).
>
> For using TensorFlow on Android refer to
> [contrib/android](https://www.tensorflow.org/code/tensorflow/contrib/android),
> [makefile](https://www.tensorflow.org/code/tensorflow/contrib/makefile#android)
> and/or the [Android
> demo](https://www.tensorflow.org/code/tensorflow/examples/android).
## Quickstart: Using [Apache Maven](https://maven.apache.org)
TensorFlow for Java releases are included in
[Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.tensorflow%22%20AND%20a%3A%22tensorflow%22)
and support Linux, OS X and Windows. To use it, add the following dependency to
your project's `pom.xml`:
```xml
<dependency>
<groupId>org.tensorflow</groupId>
<artifactId>tensorflow</artifactId>
<version>1.1.0-rc1</version>
</dependency>
```
That's all. As an example, to create a Maven project for the
[label image example](https://www.tensorflow.org/code/tensorflow/java/src/main/java/org/tensorflow/examples/LabelImage.java):
1. Create a `pom.xml`:
```xml
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.myorg</groupId>
<artifactId>label-image</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<exec.mainClass>org.tensorflow.examples.LabelImage</exec.mainClass>
<!-- The LabelImage example code requires at least JDK 1.7. -->
<!-- The maven compiler plugin defaults to a lower version -->
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.tensorflow</groupId>
<artifactId>tensorflow</artifactId>
<version>1.1.0-rc1</version>
</dependency>
</dependencies>
</project>
```
2. Download the [example source](https://raw.githubusercontent.com/tensorflow/tensorflow/master/tensorflow/java/src/main/java/org/tensorflow/examples/LabelImage.java)
into `src/main/java/org/tensorflow/examples`. On Linux and OS X, the following script should work:
```sh
mkdir -p src/main/java/org/tensorflow/examples
curl -L "https://raw.githubusercontent.com/tensorflow/tensorflow/master/tensorflow/java/src/main/java/org/tensorflow/examples/LabelImage.java" -o src/main/java/org/tensorflow/examples/LabelImage.java
```
3. Compile and execute:
```sh
mvn compile exec:java
```
## Quickstart: Using `java` and `javac`
This section describes how to use TensorFlow armed with just a JDK installation.
1. Download the Java archive (JAR):
[libtensorflow.jar](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow-1.1.0-rc1.jar)
(optionally, the Java sources:
[libtensorflow-src.jar](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow-src-1.1.0-rc1.jar)).
2. Download the native library. GPU-enabled versions required CUDA 8 and cuDNN
5.1. For other versions, the native library will need to be built from
source (see below).
- Linux:
[CPU-only](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-cpu-linux-x86_64-1.1.0-rc1.tar.gz),
[GPU-enabled](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-gpu-linux-x86_64-1.1.0-rc1.tar.gz)
- OS X:
[CPU-only](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-cpu-darwin-x86_64-1.1.0-rc1.tar.gz),
[GPU-enabled](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-gpu-darwin-x86_64-1.1.0-rc1.tar.gz)
- Windows:
[CPU-only](https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-cpu-windows-x86_64-1.1.0-rc1.zip)
The following shell snippet downloads and extracts the native library on
Linux and OS X. For Windows, download and extract manually.
```sh
TF_TYPE="cpu" # Set to "gpu" to enable GPU support
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
mkdir -p ./jni
curl -L \
"https://storage.googleapis.com/tensorflow/libtensorflow/libtensorflow_jni-${TF_TYPE}-${OS}-x86_64-1.1.0-rc1.tar.gz" |
tar -xz -C ./jni
```
3. Include the downloaded `.jar` in the classpath during compilation. For
example, if your program looks like the following:
```java
import org.tensorflow.TensorFlow;
public class MyClass {
public static void main(String[] args) {
System.out.println("I'm using TensorFlow version: " + TensorFlow.version());
}
}
```
then it should be compiled with:
```sh
javac -cp libtensorflow-1.1.0-rc1.jar MyClass.java
```
For a more sophisticated example, see
[LabelImage.java](https://www.tensorflow.org/code/tensorflow/java/src/main/java/org/tensorflow/examples/LabelImage.java),
which can be compiled with:
```sh
javac \
-cp libtensorflow-1.1.0-rc1.jar \
./src/main/java/org/tensorflow/examples/LabelImage.java
```
4. Include the downloaded `.jar` in the classpath and the native library in the
library path during execution. For example:
```sh
java -cp libtensorflow-1.1.0-rc1.jar:. -Djava.library.path=./jni MyClass
```
or for the `LabelImage` example:
```sh
java \
-Djava.library.path=./jni \
-cp libtensorflow-1.1.0-rc1.jar:./src/main/java \
org.tensorflow.examples.LabelImage
```
## Building from source
If the quickstart instructions above do not work out, the TensorFlow Java and
native libraries will need to be built from source.
1. Install [bazel](https://www.bazel.build/versions/master/docs/install.html)
2. Setup the environment to buile TensorFlow from source code
([Linux](https://www.tensorflow.org/versions/master/get_started/os_setup.html#prepare-environment-for-linux)
or [Mac OS
X](https://www.tensorflow.org/versions/master/get_started/os_setup.html#prepare-environment-for-mac-os-x)).
If you'd like to skip reading those details and do not care about GPU
support, try the following:
```sh
# On Linux
sudo apt-get install python swig python-numpy
# On Mac OS X with homebrew
brew install swig
```
3. [Configure](https://www.tensorflow.org/install/install_sources#configure_the_installation)
(e.g., enable GPU support) and build:
```sh
./configure
bazel build --config opt \
//tensorflow/java:tensorflow \
//tensorflow/java:libtensorflow_jni
```
The JAR (`libtensorflow.jar`) and native library (`libtensorflow_jni.so` on
Linux, `libtensorflow_jni.dylib` on OS X, `tensorflow_jni.dll` on Windows) will
be in `bazel-bin/tensorflow/java`. Using these artifacts follow both steps 3
and 4 in the previous section in order to get your application
up and running.
Installation on Windows requires the more experimental [bazel on Windows](https://bazel.build/versions/master/docs/windows.html).
Details are elided here, but find inspiration in the script used for
building the release archive:
[`tensorflow/tools/ci_build/windows/libtensorflow_cpu.sh`](https://www.tensorflow.org/code/tensorflow/tools/ci_build/windows/libtensorflow_cpu.sh).
### Maven
Details of the release process for Maven Central are in [`maven/README.md`](https://www.tensorflow.org/code/tensorflow/java/maven/README.md).
However, for development, you can push the library built from source to a local
Maven repository with:
```sh
bazel build -c opt //tensorflow/java:pom
mvn install:install-file \
-Dfile=../../bazel-bin/tensorflow/java/libtensorflow.jar \
-DpomFile=../../bazel-bin/tensorflow/java/pom.xml
```
And then rever to this library in a project's `pom.xml` with:
(replacing 1.0.head with the appropriate version):
```xml
<dependency>
<groupId>org.tensorflow</groupId>
<artifactId>libtensorflow</artifactId>
<version>1.0.head</version>
</dependency>
```
### Bazel
If your project uses bazel for builds, add a dependency on
`//tensorflow/java:tensorflow` to the `java_binary` or `java_library` rule. For
example:
```sh
bazel run -c opt //tensorflow/java/src/main/java/org/tensorflow/examples:label_image
```
|
