Merge branch 'main' into llm-android-ubuntu-runner

kirklandsign · web-flow · commit fd24eb63954b · 2026-01-14T17:14:19.000-08:00
diff --git a/.github/workflows/ANDROID_BUILD.md b/.github/workflows/ANDROID_BUILD.md
@@ -0,0 +1,60 @@
+# Workflows
+
+## Android Build (`android-build.yml`)
+
+This workflow builds Android demo applications and creates nightly releases.
+
+### Trigger Events
+
+1. **Scheduled (Nightly)**: Runs automatically every day at midnight UTC via cron schedule
+2. **Manual Dispatch**: Can be triggered manually via GitHub Actions UI with optional parameters
+
+### Jobs
+
+#### Build Job
+
+Builds APKs for the following apps:
+- **LlamaDemo**: Located at `llm/android/LlamaDemo`
+- **DeepLabV3Demo**: Located at `dl3/android/DeepLabV3Demo`
+
+The build job:
+- Sets up JDK 17
+- Uses Gradle to build the APKs
+- Supports using a custom local AAR file (via `local_aar` input parameter)
+- Uploads APKs as workflow artifacts
+
+#### Create Release Job
+
+Runs only for scheduled (nightly) builds. This job:
+- Downloads all APK artifacts from the build job
+- Generates a date-based release tag (format: `nightly-YYYYMMDD`)
+- Creates a GitHub release with:
+  - Tag: `nightly-YYYYMMDD`
+  - Name: `Nightly Build YYYY-MM-DD`
+  - All built APK files attached
+  - Marked as pre-release
+  - Build metadata (date and commit SHA)
+- Automatically cleans up old nightly releases, keeping only the last 7 nightly builds to prevent the releases page from becoming cluttered
+
+### How to Access Nightly Releases
+
+Nightly builds are automatically published as GitHub Releases:
+
+1. Go to the [Releases page](https://github.com/meta-pytorch/executorch-examples/releases)
+2. Look for releases tagged with `nightly-YYYYMMDD`
+3. Download the APK files from the release assets
+
+**Note:** Only the last 7 nightly releases are kept. Older releases are automatically deleted to keep the releases page manageable.
+
+### Manual Workflow Dispatch
+
+To manually trigger a build:
+
+1. Go to Actions → Android Build
+2. Click "Run workflow"
+3. Optionally provide a `local_aar` URL to use a custom ExecuTorch AAR file
+4. Note: Manual runs do NOT create releases, only scheduled runs do
+
+### Permissions
+
+The workflow requires `contents: write` permission to create releases and push tags to the repository.
diff --git a/.github/workflows/android-build.yml b/.github/workflows/android-build.yml
@@ -7,8 +7,6 @@
 name: Android Build
 
 on:
-  pull_request:
-    branches: [main]
   schedule:
     # Run nightly at midnight UTC
     - cron: '0 0 * * *'
@@ -20,7 +18,7 @@ on:
         type: string
 
 permissions:
-  contents: read
+  contents: write
 
 jobs:
   build:
@@ -70,70 +68,85 @@ jobs:
           path: ${{ matrix.path }}/app/build/outputs/apk/
           if-no-files-found: warn
 
-  instrumentation-test:
+  create-release:
+    name: Create Nightly Release
+    needs: build
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - name: LlamaDemo
-            path: llm/android/LlamaDemo
-    env:
-      API_LEVEL: 34
-      ARCH: x86_64
-      EMULATOR_OPTIONS: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
-
-    name: Instrumentation Test ${{ matrix.name }}
+    if: github.event_name == 'schedule'
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Enable KVM group perms
-        run: |
-          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
-          sudo udevadm control --reload-rules
-          sudo udevadm trigger --name-match=kvm
-
-      - name: Set up JDK 17
-        uses: actions/setup-java@v4
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4.1.3
         with:
-          java-version: '17'
-          distribution: 'temurin'
+          path: artifacts
 
-      - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@v4
+      - name: Generate release tag
+        id: tag
+        run: |
+          echo "tag_name=nightly-$(date +'%Y%m%d')" >> $GITHUB_OUTPUT
+          echo "release_name=Nightly Build $(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+          echo "build_date=$(date +'%Y-%m-%d %H:%M:%S UTC')" >> $GITHUB_OUTPUT
 
-      - name: AVD cache
-        uses: actions/cache@v4
-        id: avd-cache
-        with:
-          path: |
-            ~/.android/avd/*
-            ~/.android/adb*
-          key: avd-${{ env.API_LEVEL }}-${{ env.ARCH }}
-
-      - name: Create AVD and generate snapshot for caching
-        if: steps.avd-cache.outputs.cache-hit != 'true'
-        uses: reactivecircus/android-emulator-runner@v2
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
         with:
-          api-level: ${{ env.API_LEVEL }}
-          arch: ${{ env.ARCH }}
-          force-avd-creation: false
-          ram-size: 16384M
-          emulator-options: ${{ env.EMULATOR_OPTIONS }}
-          disable-animations: false
-          working-directory: ${{ matrix.path }}
-          script: echo "Generated AVD snapshot for caching."
-
-      - name: Run instrumentation tests
-        uses: reactivecircus/android-emulator-runner@v2
+          tag_name: ${{ steps.tag.outputs.tag_name }}
+          name: ${{ steps.tag.outputs.release_name }}
+          body: |
+            Automated nightly build of Android demo applications.
+
+            ## Apps included:
+            - LlamaDemo APK
+            - DeepLabV3Demo APK
+
+            **Build Date:** ${{ steps.tag.outputs.build_date }}
+            **Commit:** ${{ github.sha }}
+          files: |
+            artifacts/*-apk/**/*.apk
+          prerelease: true
+          draft: false
+
+      - name: Clean up old nightly releases
+        uses: actions/github-script@v7
         with:
-          api-level: ${{ env.API_LEVEL }}
-          arch: ${{ env.ARCH }}
-          force-avd-creation: false
-          ram-size: 6144M
-          emulator-options: -no-snapshot-save ${{ env.EMULATOR_OPTIONS }}
-          disable-animations: true
-          working-directory: ${{ matrix.path }}
           script: |
-            ./gradlew connectedCheck
+            const keep = 7; // Keep last 7 nightly releases
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+
+            // Get all releases
+            const releases = await github.rest.repos.listReleases({
+              owner,
+              repo,
+              per_page: 100
+            });
+
+            // Filter nightly releases and sort by date (newest first)
+            const nightlyReleases = releases.data
+              .filter(release => release.tag_name.startsWith('nightly-'))
+              .sort((a, b) => new Date(b.created_at) - new Date(a.created_at));
+
+            // Delete releases older than the keep threshold
+            for (let i = keep; i < nightlyReleases.length; i++) {
+              const release = nightlyReleases[i];
+              console.log(`Deleting old nightly release: ${release.tag_name}`);
+
+              try {
+                // Delete the release
+                await github.rest.repos.deleteRelease({
+                  owner,
+                  repo,
+                  release_id: release.id
+                });
+
+                // Delete the tag
+                await github.rest.git.deleteRef({
+                  owner,
+                  repo,
+                  ref: `tags/${release.tag_name}`
+                });
+
+                console.log(`Deleted release and tag: ${release.tag_name}`);
+              } catch (error) {
+                console.log(`Error deleting ${release.tag_name}: ${error.message}`);
+              }
+            }
diff --git a/llm/android/LlamaDemo/app/build.gradle.kts b/llm/android/LlamaDemo/app/build.gradle.kts
@@ -14,10 +14,11 @@ plugins {
 // Model files configuration for instrumentation tests
 val modelFilesBaseUrl = "https://ossci-android.s3.amazonaws.com/executorch/stories/snapshot-20260114"
 val deviceModelDir = "/data/local/tmp/llama"
-val modelFiles = listOf(
-  "stories110M.pte",
-  "tokenizer.model"
+val modelFiles = mapOf(
+  "stories110M.pte" to "model.pte",
+  "tokenizer.model" to "tokenizer.model"
 )
+val skipModelDownload: Boolean = (project.findProperty("skipModelDownload") as? String)?.toBoolean() ?: false
 
 fun execCmd(vararg args: String): String {
   val process = ProcessBuilder(*args)
@@ -42,6 +43,11 @@ tasks.register("pushModelFiles") {
   group = "verification"
 
   doLast {
+    if (skipModelDownload) {
+      logger.lifecycle("Skipping model download (skipModelDownload=true)")
+      return@doLast
+    }
+
     // Check if adb is available
     val adbPath = android.adbExecutable.absolutePath
     val (adbCheckCode, _) = execCmdWithExitCode(adbPath, "devices")
@@ -50,8 +56,8 @@ tasks.register("pushModelFiles") {
     }
 
     // Check which files need to be pushed
-    val filesToPush = modelFiles.filter { fileName ->
-      val devicePath = "$deviceModelDir/$fileName"
+    val filesToPush = modelFiles.filter { (_, targetName) ->
+      val devicePath = "$deviceModelDir/$targetName"
       val (exitCode, _) = execCmdWithExitCode(adbPath, "shell", "test -f $devicePath && echo exists")
       exitCode != 0
     }
@@ -61,7 +67,7 @@ tasks.register("pushModelFiles") {
       return@doLast
     }
 
-    logger.lifecycle("Need to push ${filesToPush.size} model file(s): ${filesToPush.joinToString(", ")}")
+    logger.lifecycle("Need to push ${filesToPush.size} model file(s): ${filesToPush.values.joinToString(", ")}")
 
     // Create temp directory using mktemp
     val tempDir = execCmd("mktemp", "-d")
@@ -71,45 +77,52 @@ tasks.register("pushModelFiles") {
       // Create device directory
       execCmd(adbPath, "shell", "mkdir -p $deviceModelDir")
 
-      for (fileName in filesToPush) {
-        val localPath = "$tempDir/$fileName"
-        val checksumPath = "$tempDir/$fileName.sha256sums"
-        val devicePath = "$deviceModelDir/$fileName"
+      for ((sourceName, targetName) in filesToPush) {
+        val localPath = "$tempDir/$targetName"
+        val checksumPath = "$tempDir/$sourceName.sha256sums"
+        val devicePath = "$deviceModelDir/$targetName"
 
-        // Download file
-        logger.lifecycle("Downloading $fileName...")
+        // Download file (with original name for checksum verification, then rename)
+        val downloadPath = "$tempDir/$sourceName"
+        logger.lifecycle("Downloading $sourceName...")
         val (dlCode, dlOutput) = execCmdWithExitCode(
-          "curl", "-fL", "-o", localPath, "$modelFilesBaseUrl/$fileName"
+          "curl", "-fL", "-o", downloadPath, "$modelFilesBaseUrl/$sourceName"
         )
         if (dlCode != 0) {
-          throw GradleException("Failed to download $fileName: $dlOutput")
+          throw GradleException("Failed to download $sourceName: $dlOutput")
         }
 
         // Download and verify checksum
-        logger.lifecycle("Verifying checksum for $fileName...")
+        logger.lifecycle("Verifying checksum for $sourceName...")
         val (csDownloadCode, csDownloadOutput) = execCmdWithExitCode(
-          "curl", "-fL", "-o", checksumPath, "$modelFilesBaseUrl/$fileName.sha256sums"
+          "curl", "-fL", "-o", checksumPath, "$modelFilesBaseUrl/$sourceName.sha256sums"
         )
         if (csDownloadCode != 0) {
-          throw GradleException("Failed to download checksum for $fileName: $csDownloadOutput")
+          throw GradleException("Failed to download checksum for $sourceName: $csDownloadOutput")
         }
 
         // Verify checksum (run sha256sum in the temp directory)
         val (verifyCode, verifyOutput) = execCmdWithExitCode(
-          "bash", "-c", "cd $tempDir && sha256sum -c $fileName.sha256sums"
+          "bash", "-c", "cd $tempDir && sha256sum -c $sourceName.sha256sums"
         )
         if (verifyCode != 0) {
-          throw GradleException("Checksum verification failed for $fileName: $verifyOutput")
+          throw GradleException("Checksum verification failed for $sourceName: $verifyOutput")
+        }
+        logger.lifecycle("Checksum verified for $sourceName")
+
+        // Rename file if needed
+        if (sourceName != targetName) {
+          execCmd("mv", downloadPath, localPath)
+          logger.lifecycle("Renamed $sourceName to $targetName")
         }
-        logger.lifecycle("Checksum verified for $fileName")
 
         // Push to device
-        logger.lifecycle("Pushing $fileName to device...")
+        logger.lifecycle("Pushing $targetName to device...")
         val (pushCode, pushOutput) = execCmdWithExitCode(adbPath, "push", localPath, devicePath)
         if (pushCode != 0) {
-          throw GradleException("Failed to push $fileName to device: $pushOutput")
+          throw GradleException("Failed to push $targetName to device: $pushOutput")
         }
-        logger.lifecycle("Successfully pushed $fileName")
+        logger.lifecycle("Successfully pushed $targetName")
       }
     } finally {
       // Clean up temp directory
diff --git a/llm/android/LlamaDemo/app/src/androidTest/java/com/example/executorchllamademo/SanityCheck.java b/llm/android/LlamaDemo/app/src/androidTest/java/com/example/executorchllamademo/SanityCheck.java
@@ -25,7 +25,7 @@ public class SanityCheck implements LlmCallback {
 
   private static final String RESOURCE_PATH = "/data/local/tmp/llama/";
   private static final String TOKENIZER_PATH = "tokenizer.model";
-  private static final String MODEL_PATH = "stories110M.pte";
+  private static final String MODEL_PATH = "model.pte";
 
   private final List<String> results = new ArrayList<>();
 
diff --git a/llm/android/LlamaDemo/app/src/androidTest/java/com/example/executorchllamademo/UIWorkflowTest.java b/llm/android/LlamaDemo/app/src/androidTest/java/com/example/executorchllamademo/UIWorkflowTest.java
@@ -70,7 +70,7 @@ public void clearSharedPreferences() {
      * 1. Dismiss the "Please Select a Model" dialog
      * 2. Click settings button
      * 3. Verify model path and tokenizer path show default "no selection" text
-     * 4. Click model selection, select stories110M.pte
+     * 4. Click model selection, select model.pte
      * 5. Click tokenizer selection, select tokenizer.model
      * 6. Click load model button
      */
@@ -92,10 +92,10 @@ public void testModelLoadingWorkflow() throws Exception {
             onView(withId(R.id.modelTextView)).check(matches(withText("no model selected")));
             onView(withId(R.id.tokenizerTextView)).check(matches(withText("no tokenizer selected")));
 
-            // Step 3: Click model selection button and select stories110M.pte
+            // Step 3: Click model selection button and select model.pte
             onView(withId(R.id.modelImageButton)).perform(click());
-            // Select the model file containing "stories110M.pte"
-            onData(hasToString(containsString("stories110M.pte"))).inRoot(isDialog()).perform(click());
+            // Select the model file containing "model.pte"
+            onData(hasToString(containsString("model.pte"))).inRoot(isDialog()).perform(click());
 
             // Step 4: Click tokenizer selection button and select tokenizer.model
             onView(withId(R.id.tokenizerImageButton)).perform(click());
@@ -139,10 +139,10 @@ public void testSendMessageAndReceiveResponse() throws Exception {
             // Verify load button is initially disabled (no model/tokenizer selected)
             onView(withId(R.id.loadModelButton)).check(matches(not(isEnabled())));
 
-            // Select model - choose stories110M.pte
+            // Select model - choose model.pte
             onView(withId(R.id.modelImageButton)).perform(click());
             Thread.sleep(300); // Wait for dialog to appear
-            onData(hasToString(containsString("stories110M.pte"))).inRoot(isDialog()).perform(click());
+            onData(hasToString(containsString("model.pte"))).inRoot(isDialog()).perform(click());
             Thread.sleep(300); // Wait for dialog to dismiss and UI to update
 
             // Select tokenizer - choose tokenizer.model
