diff options
-rw-r--r-- | tensorflow/java/README.md | 2 | ||||
-rw-r--r-- | tensorflow/tools/lib_package/README.md | 41 |
2 files changed, 34 insertions, 9 deletions
diff --git a/tensorflow/java/README.md b/tensorflow/java/README.md index 22394c9d52..f3cf435686 100644 --- a/tensorflow/java/README.md +++ b/tensorflow/java/README.md @@ -1,6 +1,6 @@ # TensorFlow for Java -Java bindings for TensorFlow. +Java bindings for TensorFlow. ([Javadoc](https://www.tensorflow.org/api_docs/java/reference/org/tensorflow/package-summary)) > *WARNING*: The TensorFlow Java API is not currently covered by the TensorFlow > [API stability guarantees](https://www.tensorflow.org/programmers_guide/version_semantics). 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) |