Merge branch 'main' into docs/jhelsby/onboarding

Author: jhelsby

.ci/scripts/test_ios_ci.sh

@@ -7,7 +7,7 @@
 
 set -e
 
-APP_PATH="examples/demo-apps/apple_ios/ExecuTorchDemo/ExecuTorchDemo"
+APP_PATH="executorch-examples/apple/ExecuTorchDemo/ExecuTorchDemo"
 MODEL_NAME="mv3"
 SIMULATOR_NAME="executorch"
 
@@ -34,6 +34,10 @@ say() {
   echo -e "\033[1m\n\t** $1 **\n\033[0m"
 }
 
+say "Cloning the Demo App"
+
+git clone --depth 1 https://github.com/pytorch-labs/executorch-examples.git
+
 say "Installing CoreML Backend Requirements"
 
 ./backends/apple/coreml/scripts/install_requirements.sh

.github/workflows/android-release-artifacts.yml

@@ -7,6 +7,10 @@ on:
         description: Version name to be uploaded for AAR release
         required: false
         type: string
+      upload_to_maven:
+        description: Upload the AAR to maven staging repository
+        required: false
+        type: boolean
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -31,11 +35,14 @@ jobs:
   build-aar:
     name: build-aar
     needs: check-if-aar-exists
-    uses: pytorch/test-infra/.github/workflows/linux_job_v2.yml@main
+    if: ${{ !github.event.pull_request.head.repo.fork }}
+    uses: pytorch/test-infra/.github/workflows/linux_job_v2.yml@release/2.7
+    secrets: inherit
     permissions:
       id-token: write
       contents: read
     with:
+      secrets-env: EXECUTORCH_MAVEN_SIGNING_KEYID EXECUTORCH_MAVEN_SIGNING_PASSWORD EXECUTORCH_MAVEN_CENTRAL_PASSWORD EXECUTORCH_MAVEN_CENTRAL_USERNAME EXECUTORCH_MAVEN_SIGNING_GPG_KEY_CONTENTS
       runner: linux.2xlarge
       docker-image: executorch-ubuntu-22.04-clang12-android
       submodules: 'true'
@@ -52,6 +59,16 @@ jobs:
         PYTHON_EXECUTABLE=python bash .ci/scripts/setup-linux.sh --build-tool buck2
         export ARTIFACTS_DIR_NAME=artifacts-to-be-uploaded
 
+        mkdir -p ~/.gradle
+        touch ~/.gradle/gradle.properties
+        echo "signing.keyId=${SECRET_EXECUTORCH_MAVEN_SIGNING_KEYID}" >> ~/.gradle/gradle.properties
+        echo "signing.password=${SECRET_EXECUTORCH_MAVEN_SIGNING_PASSWORD}" >> ~/.gradle/gradle.properties
+        echo "mavenCentralUsername=${SECRET_EXECUTORCH_MAVEN_CENTRAL_USERNAME}" >> ~/.gradle/gradle.properties
+        echo "mavenCentralPassword=${SECRET_EXECUTORCH_MAVEN_CENTRAL_PASSWORD}" >> ~/.gradle/gradle.properties
+        echo "signing.secretKeyRingFile=/tmp/secring.gpg" >> ~/.gradle/gradle.properties
+
+        echo -n "$SECRET_EXECUTORCH_MAVEN_SIGNING_GPG_KEY_CONTENTS" | base64 -d > /tmp/secring.gpg
+
         # Build AAR Package
         mkdir aar-out
         export BUILD_AAR_DIR=aar-out
@@ -61,6 +78,12 @@ jobs:
 
         shasum -a 256 "${ARTIFACTS_DIR_NAME}/executorch.aar"
 
+        # Publish to maven staging
+        UPLOAD_TO_MAVEN="${{ inputs.upload_to_maven }}"
+        if [[ "$UPLOAD_TO_MAVEN" == "true" ]]; then
+          (cd aar-out; ANDROID_HOME="${ANDROID_SDK:-/opt/android/sdk}" ./gradlew :executorch_android:publishToMavenCentral)
+        fi
+
   upload-release-aar:
     name: upload-release-aar
     needs: build-aar

docs/source/demo-apps-ios.md

@@ -1 +1,141 @@
-```{include} ../../examples/demo-apps/apple_ios/ExecuTorchDemo/README.md
+# Building an ExecuTorch iOS Demo App
+
+Welcome to the tutorial on setting up the ExecuTorch iOS Demo App!
+
+This app uses the
+[MobileNet v3](https://pytorch.org/vision/main/models/mobilenetv3.html) model to
+process live camera images leveraging three different backends:
+[XNNPACK](https://github.com/google/XNNPACK),
+[Core ML](https://developer.apple.com/documentation/coreml) and
+[Metal Performance Shaders (MPS)](https://developer.apple.com/documentation/metalperformanceshaders)
+(Xcode 15+ and iOS 17+ only).
+
+![](_static/img/demo_ios_app.jpg)
+
+## Prerequisites
+
+Before we start, make sure you have the following tools installed:
+
+### 1. Xcode 15 and Command Line Tools
+
+Install Xcode 15 from the
+[Mac App Store](https://apps.apple.com/app/xcode/id497799835) and then install
+the Command Line Tools using the terminal:
+
+```bash
+xcode-select --install
+```
+
+### 2. Python 3.10+
+
+Python 3.10 or above, along with `pip`, should be pre-installed on MacOS 13.5+.
+If needed, [download Python](https://www.python.org/downloads/macos/) and
+install it. Verify the Python and pip versions using these commands:
+
+```bash
+which python3 pip
+python3 --version
+pip --version
+```
+
+### 3. Getting Started Tutorial
+
+Follow the [Setting Up ExecuTorch](https://pytorch.org/executorch/stable/getting-started-setup)
+tutorial to configure the basic environment:
+
+```bash
+git clone -b viable/strict https://github.com/pytorch/executorch.git && cd executorch
+
+python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip
+
+./install_executorch.sh
+```
+
+### 4. Clone the Demo App
+
+```bash
+git clone --depth 1 https://github.com/pytorch-labs/executorch-examples.git
+```
+
+### 5. Backend Dependencies
+
+Also, follow the corresponding sections from [Core ML](https://pytorch.org/executorch/stable/build-run-coreml) and
+[MPS](https://pytorch.org/executorch/stable/build-run-mps) tutorials to install additional dependencies for those
+backends:
+
+```bash
+./backends/apple/coreml/scripts/install_requirements.sh
+
+./backends/apple/mps/install_requirements.sh
+```
+
+## Models and Labels
+
+Now, let's move on to exporting and bundling the MobileNet v3 model.
+
+### 1. Export Model
+
+Export the MobileNet v3 model with Core ML, MPS and XNNPACK backends, and move
+the exported model to a specific location where the Demo App will pick them up:
+
+```bash
+MODEL_NAME="mv3"
+
+python3 -m examples.portable.scripts.export --model_name="$MODEL_NAME"
+python3 -m examples.apple.coreml.scripts.export --model_name="$MODEL_NAME"
+python3 -m examples.apple.mps.scripts.mps_example --model_name="$MODEL_NAME"
+python3 -m examples.xnnpack.aot_compiler --model_name="$MODEL_NAME" --delegate
+
+APP_PATH="executorch-examples/apple/ExecuTorchDemo/ExecuTorchDemo"
+
+mkdir -p "$APP_PATH/Resources/Models/MobileNet/"
+mv $MODEL_NAME*.pte "$APP_PATH/Resources/Models/MobileNet/"
+```
+
+### 2. Download Labels
+
+Download the MobileNet model labels required for image classification:
+
+```bash
+curl https://raw.githubusercontent.com/pytorch/hub/master/imagenet_classes.txt \
+  -o "$APP_PATH/Resources/Models/MobileNet/imagenet_classes.txt"
+```
+
+## Final Steps
+
+We're almost done! Now, we just need to open the project in Xcode, run the
+tests, and finally run the app.
+
+### 1. Open Project in Xcode
+
+Double-click on the project file under `executorch-examples/apple/ExecuTorchDemo` or run the command:
+
+```bash
+open $APP_PATH.xcodeproj
+```
+
+### 2. Run Tests
+
+You can run tests on Simulaltor directly in Xcode with `Cmd + U` or use the
+command line:
+
+```bash
+xcrun simctl create executorch "iPhone 15"
+xcodebuild clean test \
+     -project $APP_PATH.xcodeproj \
+     -scheme App \
+     -destination name=executorch
+xcrun simctl delete executorch
+```
+
+### 3. Run App
+
+Finally, connect the device, set up Code Signing in Xcode, and then run the app
+using `Cmd + R`. Try installing a Release build for better performance.
+
+Congratulations! You've successfully set up the ExecuTorch iOS Demo App. Now,
+you can explore and enjoy the power of ExecuTorch on your iOS device!
+
+Learn more about integrating and running [ExecuTorch on Apple](https://pytorch.org/executorch/stable/apple-runtime) platforms.
+
+![](_static/img/demo_ios_xcode.jpg)

extension/android/executorch_android/build.gradle

@@ -48,7 +48,7 @@ mavenPublishing {
   publishToMavenCentral(SonatypeHost.DEFAULT)
   signAllPublications()
 
-  coordinates("org.pytorch", "executorch-android", "0.5.0-SNAPSHOT")
+  coordinates("org.pytorch", "executorch-android", "0.7.0")
 
   pom {
     name = "ExecuTorch Android"

scripts/test_ios.sh

@@ -15,7 +15,7 @@ set -e
 
 OUTPUT="${1:-executorch}"
 EXIT_STATUS=0
-APP_PATH="examples/demo-apps/apple_ios/ExecuTorchDemo/ExecuTorchDemo"
+APP_PATH="executorch-examples/apple/ExecuTorchDemo/ExecuTorchDemo"
 MODEL_NAME="mv3"
 SIMULATOR_NAME="executorch"
 
@@ -44,26 +44,17 @@ say() {
   echo -e "\033[1m\n\t** $1 **\n\033[0m"
 }
 
-say "Cloning the Code"
-
-pushd . > /dev/null
-git clone -b viable/strict https://github.com/pytorch/executorch.git "$OUTPUT"
-cd "$OUTPUT"
-
-say "Updating the Submodules"
-
-git submodule update --init
-
 say "Activating a Virtual Environment"
 
-python3 -m venv .venv
-source .venv/bin/activate
+python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip
 
 say "Installing Requirements"
 
-pip install --upgrade cmake pip setuptools wheel zstd
+./install_executorch.sh
 
-./install_executorch.sh --pybind coreml mps xnnpack
+say "Cloning the Demo App"
+
+git clone --depth 1 https://github.com/pytorch-labs/executorch-examples.git
 
 say "Installing CoreML Backend Requirements"
 
@@ -88,11 +79,6 @@ say "Downloading Labels"
 curl https://raw.githubusercontent.com/pytorch/hub/master/imagenet_classes.txt \
   -o "$APP_PATH/Resources/Models/MobileNet/imagenet_classes.txt"
 
-say "Building Frameworks"
-
-./scripts/build_apple_frameworks.sh --coreml --custom --mps --optimized --portable --quantized --xnnpack
-mv cmake-out "$APP_PATH/Frameworks"
-
 say "Creating Simulator"
 
 xcrun simctl create "$SIMULATOR_NAME" "iPhone 15"