Skip to content

Commit

Permalink
Java: Update READMEs to link to Javadoc and release instructions.
Browse files Browse the repository at this point in the history
Change: 147858835
  • Loading branch information
asimshankar authored and tensorflower-gardener committed Feb 17, 2017
1 parent c45ef99 commit 17178d7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 9 deletions.
2 changes: 1 addition & 1 deletion tensorflow/java/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
41 changes: 33 additions & 8 deletions tensorflow/tools/lib_package/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,56 @@
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)
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)

0 comments on commit 17178d7

Please sign in to comment.