Add more docs and give API warning in ET Java

Differential Revision: D62216121

Pull Request resolved: #5097

Author: kirklandsign

extension/android/src/main/java/org/pytorch/executorch/DType.java

@@ -8,7 +8,11 @@
 
 package org.pytorch.executorch;
 
-/** Codes representing tensor data types. */
+/**
+ * Codes representing tensor data types.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
+ */
 public enum DType {
   // NOTE: "jniCode" must be kept in sync with scalar_type.h.
   // NOTE: Never serialize "jniCode", because it can change between releases.

extension/android/src/main/java/org/pytorch/executorch/EValue.java

@@ -27,6 +27,8 @@
  *
  * <p>{@code EValue} objects may retain references to objects passed into their constructors, and
  * may return references to their internal state from {@code toX()}.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
  */
 @DoNotStrip
 public class EValue {

extension/android/src/main/java/org/pytorch/executorch/LlamaCallback.java

@@ -10,6 +10,12 @@
 
 import com.facebook.jni.annotations.DoNotStrip;
 
+/**
+ * Callback interface for Llama model. Users can implement this interface to receive the generated
+ * tokens and statistics.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
+ */
 public interface LlamaCallback {
   /**
    * Called when a new result is available from JNI. Users will keep getting onResult() invocations

extension/android/src/main/java/org/pytorch/executorch/LlamaModule.java

@@ -13,6 +13,12 @@
 import com.facebook.soloader.nativeloader.NativeLoader;
 import com.facebook.soloader.nativeloader.SystemDelegate;
 
+/**
+ * LlamaModule is a wrapper around the Executorch Llama model. It provides a simple interface to
+ * generate text from the model.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
+ */
 public class LlamaModule {
 
   public static final int MODEL_TYPE_TEXT = 1;

extension/android/src/main/java/org/pytorch/executorch/Module.java

@@ -12,7 +12,11 @@
 import com.facebook.soloader.nativeloader.SystemDelegate;
 import java.util.Map;
 
-/** Java wrapper for ExecuTorch Module. */
+/**
+ * Java wrapper for ExecuTorch Module.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
+ */
 public class Module {
 
   /** Load mode for the module. Load the whole file as a buffer. */

extension/android/src/main/java/org/pytorch/executorch/NativePeer.java

@@ -13,7 +13,11 @@
 import com.facebook.soloader.nativeloader.NativeLoader;
 import java.util.Map;
 
-/** Interface for the native peer object for entry points to the Module */
+/**
+ * Interface for the native peer object for entry points to the Module
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
+ */
 class NativePeer {
   static {
     // Loads libexecutorch.so from jniLibs

extension/android/src/main/java/org/pytorch/executorch/Tensor.java

@@ -36,6 +36,8 @@
  * between {@link Module} calls to avoid reallocation. Data retrieved from {@code Tensor} objects
  * may be copied or may be a reference to the {@code Tensor}'s internal data buffer. {@code shape}
  * is always copied.
+ *
+ * <p>Warning: These APIs are experimental and subject to change without notice
  */
 public abstract class Tensor {
   private static final String ERROR_MSG_DATA_BUFFER_NOT_NULL = "Data buffer must be not null";