java icon indicating copy to clipboard operation
java copied to clipboard

Documentation: clarify API stability guarantees

Open winne42 opened this issue 1 year ago • 4 comments

System information

  • TensorFlow version: 1.0.0
  • Doc Links:
    • https://github.com/tensorflow/java/releases/tag/v1.0.0
    • https://github.com/tensorflow/java/blob/r1.0/docs/install.md
    • https://github.com/tensorflow/java/blob/r1.0/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/package-info.java
    • https://www.tensorflow.org/jvm/install

Describe the documentation issue

In the 1.0.0 release notes it is mentioned that

Starting from this version, the project will follow the TensorFlow API stability guarantees.

On the other hand, install.md reads

Caution: The TensorFlow Java API is not covered by the TensorFlow API stability guarantees.

And package-info.java also says

WARNING: The API is currently experimental and is not covered by TensorFlow API stability guarantees

Which one is it, could you please align the documentation? Thanks and have a nice weekend!

P.S.: Also https://www.tensorflow.org/jvm/install seems to point to a severely outdated version of install.md

winne42 avatar Jan 03 '25 16:01 winne42

Hello sir, With all respect can I try this , I guess probably I can solve the issue

dheeraj-paliwal avatar Mar 13 '25 03:03 dheeraj-paliwal

We should fix that, however it's not clear that upstream TensorFlow is itself covered by the API stability guarantees anymore given all the changes that have happened over there.

Craigacp avatar Apr 04 '25 18:04 Craigacp