Skip to content

Commit e28dcc4

Browse files
authored
docs: align API stability guarantees with 1.0.0 release (#597) (#629)
* docs: align api stability documentation with 1.0.0 release * style: fix formatting via GitHub Codespaces
1 parent cf36b38 commit e28dcc4

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

docs/docs/install.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ Kotlin, are frequently used in large and small enterprises all over the world,
88
which makes TensorFlow Java a strategic choice for adopting machine learning at
99
a large scale.
1010

11-
Caution: The TensorFlow Java API is *not* covered by the TensorFlow
12-
[API stability guarantees](https://www.tensorflow.org/guide/versions).
11+
Note: Starting from version 1.0.0, the TensorFlow Java project follows the
12+
[TensorFlow API stability guarantees](https://www.tensorflow.org/guide/versions#api_stability).
13+
However, as these bindings are downstream of the TensorFlow C API, users should
14+
be aware that stability is subject to the evolution of the upstream TensorFlow core.
1315

1416
## Requirements
1517

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/package-info.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@
1616
/**
1717
* Defines classes to build, save, load and execute TensorFlow models.
1818
*
19-
* <p><b>WARNING</b>: The API is currently experimental and is not covered by TensorFlow <a
20-
* href="https://www.tensorflow.org/guide/version_compat">API stability guarantees</a>. See <a
21-
* href="https://github.com/tensorflow/tensorflow/blob/master/tensorflow/java/README.md">README.md</a>
22-
* for installation instructions.
19+
* <p><b>API Stability</b>: Since version 1.0.0, the TensorFlow Java API is covered by TensorFlow <a
20+
* href="https://www.tensorflow.org/guide/versions#api_stability">API stability guarantees</a>.
21+
* Please note that as this library is a wrapper for the TensorFlow C API, its stability is subject
22+
* to the stability of the underlying upstream TensorFlow project. See the <a
23+
* href="https://github.com/tensorflow/java/blob/master/README.md">README.md</a> for installation
24+
* instructions.
2325
*
2426
* <p>The <a
2527
* href="https://www.tensorflow.org/code/tensorflow/java/src/main/java/org/tensorflow/examples/LabelImage.java">LabelImage</a>

0 commit comments

Comments
 (0)