Upload javadoc

.ci/docker/common/install_java.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# 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.
+
+set -ex
+
+apt-get update
+
+apt-get install -y --no-install-recommends openjdk-17-jdk

.ci/docker/ubuntu/Dockerfile

@@ -30,6 +30,10 @@ ARG BUCK2_VERSION
 COPY ./common/install_buck.sh install_buck.sh
 RUN bash ./install_buck.sh && rm install_buck.sh
 
+# Install java
+COPY ./common/install_java.sh install_java.sh
+RUN bash ./install_java.sh && rm install_java.sh
+
 # Setup user
 COPY ./common/install_user.sh install_user.sh
 RUN bash ./install_user.sh && rm install_user.sh

.github/workflows/doc-build.yml

@@ -68,6 +68,12 @@ jobs:
         make html
         cd ..
 
+        # Build javadoc:
+        cd extension/android
+        ./gradlew javadoc
+        cp -rf build/docs/javadoc "${RUNNER_DOCS_DIR}"
+        cd ../..
+
         # If it's main branch, add noindex tag to all .html files to exclude from Google Search indexing.
         echo "GitHub Ref: ${GITHUB_REF}"
         if [[ "${{ github.ref }}" == 'refs/heads/main' ]]; then

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

@@ -177,10 +177,10 @@ private String getTypeName(int typeCode) {
   }
 
   /**
-   * Serializes an {@code EValue} into a byte array.
+   * Serializes an {@code EValue} into a byte array. Note: This method is experimental and subject
+   * to change without notice.
    *
    * @return The serialized byte array.
-   * @apiNote This method is experimental and subject to change without notice.
    */
   public byte[] toByteArray() {
     if (isNone()) {
@@ -212,11 +212,11 @@ public byte[] toByteArray() {
   }
 
   /**
-   * Deserializes an {@code EValue} from a byte[].
+   * Deserializes an {@code EValue} from a byte[]. Note: This method is experimental and subject to
+   * change without notice.
    *
    * @param bytes The byte array to deserialize from.
    * @return The deserialized {@code EValue}.
-   * @apiNote This method is experimental and subject to change without notice.
    */
   public static EValue fromByteArray(byte[] bytes) {
     ByteBuffer buffer = ByteBuffer.wrap(bytes);

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

@@ -682,11 +682,10 @@ private static Tensor nativeNewTensor(
   }
 
   /**
-   * Serializes a {@code Tensor} into a byte array.
+   * Serializes a {@code Tensor} into a byte array. Note: This method is experimental and subject to
+   * change without notice. This does NOT supoprt list type.
    *
    * @return The serialized byte array.
-   * @apiNote This method is experimental and subject to change without notice. This does NOT
-   *     supoprt list type.
    */
   public byte[] toByteArray() {
     int dtypeSize = 0;
@@ -738,12 +737,11 @@ public byte[] toByteArray() {
   }
 
   /**
-   * Deserializes a {@code Tensor} from a byte[].
+   * Deserializes a {@code Tensor} from a byte[]. Note: This method is experimental and subject to
+   * change without notice. This does NOT supoprt list type.
    *
-   * @param buffer The byte array to deserialize from.
+   * @param bytes The byte array to deserialize from.
    * @return The deserialized {@code Tensor}.
-   * @apiNote This method is experimental and subject to change without notice. This does NOT
-   *     supoprt list type.
    */
   public static Tensor fromByteArray(byte[] bytes) {
     if (bytes == null) {