aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/tools/lib_package
diff options
context:
space:
mode:
authorGravatar Asim Shankar <ashankar@google.com>2017-02-17 11:21:50 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2017-02-17 11:46:54 -0800
commit17178d7494a218367dd92888779de20a6147789a (patch)
treef1292254da0a39c7834639f9f119a1c7d99c1b9f /tensorflow/tools/lib_package
parentc45ef99f81208fe1c25fdcb444d08be53be042d0 (diff)
Java: Update READMEs to link to Javadoc and release instructions.
Change: 147858835
Diffstat (limited to 'tensorflow/tools/lib_package')
-rw-r--r--tensorflow/tools/lib_package/README.md41
1 files changed, 33 insertions, 8 deletions
diff --git a/tensorflow/tools/lib_package/README.md b/tensorflow/tools/lib_package/README.md
index e5d3760986..7008148260 100644
--- a/tensorflow/tools/lib_package/README.md
+++ b/tensorflow/tools/lib_package/README.md
@@ -1,8 +1,7 @@
-Bazel rules to package the TensorFlow C-library and [header
-files](https://www.tensorflow.org/code/tensorflow/c/c_api.h)
-into an archive.
+Bazel rules to package the TensorFlow APIs in languages other than Python into
+archives.
-## TensorFlow C library
+## C library
The TensorFlow [C
API](https://www.tensorflow.org/code/tensorflow/c/c_api.h)
@@ -10,22 +9,48 @@ is typically a requirement of TensorFlow APIs in other languages such as
[Go](https://www.tensorflow.org/code/tensorflow/go)
and [Rust](https://github.com/tensorflow/rust).
-The command:
+The following commands:
```sh
+bazel test --config opt //tensorflow/tools/lib_package:libtensorflow_test
bazel build --config opt //tensorflow/tools/lib_package:libtensorflow
```
-produces `bazel-bin/tensorflow/tools/lib_package/libtensorflow.tar.gz`, which
-can be distributed and installed using something like:
+test and produce the archive at
+`bazel-bin/tensorflow/tools/lib_package/libtensorflow.tar.gz`, which can be
+distributed and installed using something like:
```sh
tar -C /usr/local -xzf libtensorflow.tar.gz
```
+## Java library
+
+The TensorFlow [Java
+API](https://www.tensorflow.org/code/tensorflow/java/README.md)
+consists of a native library (`libtensorflow_jni.so`) and a Java archive (JAR).
+The following commands:
+
+```sh
+bazel test --config opt //tensorflow/tools/lib_package:libtensorflow_test
+bazel build --config opt \
+ //tensorflow/tools/lib_package:libtensorflow_jni.tar.gz \
+ //tensorflow/tools/lib_package:libtensorflow.jar \
+ //tensorflow/tools/lib_package:libtensorflow-src.jar
+```
+
+test and produce the following:
+
+- The native library (`libtensorflow_jni.so`) packaged in an archive at:
+ `bazel-bin/tensorflow/tools/lib_package/libtensorflow_jni.tar.gz`
+- The Java archive at:
+ `bazel-bin/tensorflow/tools/lib_package/libtensorflow.jar`
+- The Java archive for Java sources at:
+ `bazel-bin/tensorflow/tools/lib_package/libtensorflow-src.jar`
+
## Release
-Scripts to generate archives using these rules for release are in
+Scripts to build these archives for TensorFlow releases are in
[tensorflow/tools/ci_build/linux](https://www.tensorflow.org/code/tensorflow/tools/ci_build/linux)
and
[tensorflow/tools/ci_build/osx](https://www.tensorflow.org/code/tensorflow/tools/ci_build/osx)