Android Java introduce Experimental API annotation (#5303)

Summary: Pull Request resolved: #5303

Reviewed By: shoumikhin

Differential Revision: D62557706

Pulled By: kirklandsign

fbshipit-source-id: b2d54cc2c4bf480f862aa1936dcd4075ab7b29c0

Author: kirklandsign

extension/android/BUCK

@@ -10,6 +10,7 @@ fb_android_library(
         "src/main/java/org/pytorch/executorch/Module.java",
         "src/main/java/org/pytorch/executorch/NativePeer.java",
         "src/main/java/org/pytorch/executorch/Tensor.java",
+        "src/main/java/org/pytorch/executorch/annotations/Experimental.java",
     ],
     autoglob = False,
     language = "JAVA",
@@ -24,6 +25,7 @@ fb_android_library(
     srcs = [
         "src/main/java/org/pytorch/executorch/LlamaCallback.java",
         "src/main/java/org/pytorch/executorch/LlamaModule.java",
+        "src/main/java/org/pytorch/executorch/annotations/Experimental.java",
     ],
     autoglob = False,
     language = "JAVA",

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

@@ -8,11 +8,14 @@
 
 package org.pytorch.executorch;
 
+import org.pytorch.executorch.annotations.Experimental;
+
 /**
  * Codes representing tensor data types.
  *
  * <p>Warning: These APIs are experimental and subject to change without notice
  */
+@Experimental
 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

@@ -11,6 +11,7 @@
 import com.facebook.jni.annotations.DoNotStrip;
 import java.util.Locale;
 import java.util.Optional;
+import org.pytorch.executorch.annotations.Experimental;
 
 /**
  * Java representation of an ExecuTorch value, which is implemented as tagged union that can be one
@@ -30,6 +31,7 @@
  *
  * <p>Warning: These APIs are experimental and subject to change without notice
  */
+@Experimental
 @DoNotStrip
 public class EValue {
   private static final int TYPE_CODE_NONE = 0;

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

@@ -9,13 +9,15 @@
 package org.pytorch.executorch;
 
 import com.facebook.jni.annotations.DoNotStrip;
+import org.pytorch.executorch.annotations.Experimental;
 
 /**
  * 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
  */
+@Experimental
 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

@@ -12,13 +12,15 @@
 import com.facebook.jni.annotations.DoNotStrip;
 import com.facebook.soloader.nativeloader.NativeLoader;
 import com.facebook.soloader.nativeloader.SystemDelegate;
+import org.pytorch.executorch.annotations.Experimental;
 
 /**
  * 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
  */
+@Experimental
 public class LlamaModule {
 
   public static final int MODEL_TYPE_TEXT = 1;

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

@@ -11,12 +11,14 @@
 import com.facebook.soloader.nativeloader.NativeLoader;
 import com.facebook.soloader.nativeloader.SystemDelegate;
 import java.util.Map;
+import org.pytorch.executorch.annotations.Experimental;
 
 /**
  * Java wrapper for ExecuTorch Module.
  *
  * <p>Warning: These APIs are experimental and subject to change without notice
  */
+@Experimental
 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

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

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

@@ -19,6 +19,7 @@
 import java.nio.LongBuffer;
 import java.util.Arrays;
 import java.util.Locale;
+import org.pytorch.executorch.annotations.Experimental;
 
 /**
  * Representation of an ExecuTorch Tensor. Behavior is similar to PyTorch's tensor objects.
@@ -39,6 +40,7 @@
  *
  * <p>Warning: These APIs are experimental and subject to change without notice
  */
+@Experimental
 public abstract class Tensor {
   private static final String ERROR_MSG_DATA_BUFFER_NOT_NULL = "Data buffer must be not null";
   private static final String ERROR_MSG_DATA_ARRAY_NOT_NULL = "Data array must be not null";

extension/android/src/main/java/org/pytorch/executorch/annotations/Experimental.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package org.pytorch.executorch.annotations;
+
+/**
+ * This annotation indicates that an API is experimental and may change or be removed at any time.
+ * It does not provide any guarantees for API stability or backward-compatibility.
+ *
+ * <p>This status is not permanent, and APIs marked with this annotation will need to be either made
+ * more robust or removed in the future.
+ */
+public @interface Experimental {}