Rename ethous-u-scratch to arm-scratch

.ci/scripts/test_backend.sh

@@ -64,7 +64,7 @@ if [[ "$FLOW" == *arm* ]]; then
     else
         .ci/scripts/setup-arm-baremetal-tools.sh
     fi
-    source examples/arm/ethos-u-scratch/setup_path.sh
+    source examples/arm/arm-scratch/setup_path.sh
 
     if [[ "$FLOW" == *ethos_u* ]]; then
         # Prepare a test runner binary that can run on the Corstone-3x0 FVPs

.github/workflows/trunk.yml

@@ -100,7 +100,7 @@ jobs:
 #        cd $ZEPHYR_PROJ_ROOT/modules/lib/executorch
 #        install_executorch
 #        .ci/scripts/setup-arm-baremetal-tools.sh --target-toolchain zephyr
-#        source examples/arm/ethos-u-scratch/setup_path.sh
+#        source examples/arm/arm-scratch/setup_path.sh
 #        source $ZEPHYR_PROJ_ROOT/zephyr/zephyr-env.sh
 #
 #        # Get the model as PTE
@@ -391,7 +391,7 @@ jobs:
         source .ci/scripts/utils.sh
         install_executorch "--use-pt-pinned-commit"
         .ci/scripts/setup-arm-baremetal-tools.sh ${setup_script_args}
-        source examples/arm/ethos-u-scratch/setup_path.sh
+        source examples/arm/arm-scratch/setup_path.sh
 
         # User toolchain
         ${toolchain_prefix}c++ --version
@@ -459,7 +459,7 @@ jobs:
         install_executorch "--use-pt-pinned-commit"
 
         .ci/scripts/setup-arm-baremetal-tools.sh
-        source examples/arm/ethos-u-scratch/setup_path.sh
+        source examples/arm/arm-scratch/setup_path.sh
 
         # Install requirements for converting notebooks
         pip install notebook
@@ -1123,7 +1123,7 @@ jobs:
 
         # Install arm dependencies
         .ci/scripts/setup-arm-baremetal-tools.sh
-        source examples/arm/ethos-u-scratch/setup_path.sh
+        source examples/arm/arm-scratch/setup_path.sh
 
         # To build cortex-m test runner
         backends/cortex_m/test/build_test_runner.sh

.gitignore

@@ -19,7 +19,7 @@ cmake-out-android/
 build-android/
 build-x86/
 dist/
-ethos-u-scratch/
+arm-scratch/
 executorch.egg-info
 pip-out/
 build-profiling/

backends/arm/CMakeLists.txt

@@ -55,13 +55,13 @@ if(EXECUTORCH_BUILD_VGF)
   if(APPLE
      OR CMAKE_SYSTEM_PROCESSOR MATCHES "^(arm64|aarch64)$"
      OR EXISTS
-        "${EXECUTORCH_ROOT}/examples/arm/ethos-u-scratch/ml-sdk-for-vulkan-manifest/"
+        "${EXECUTORCH_ROOT}/examples/arm/arm-scratch/ml-sdk-for-vulkan-manifest/"
   )
     message(STATUS "libvgf sourced from local scratch tree")
 
     # Legacy layout: libvgf sourced from local scratch tree
     set(LIBVGF_PATH
-        "${EXECUTORCH_ROOT}/examples/arm/ethos-u-scratch/ml-sdk-for-vulkan-manifest/sw/vgf-lib/"
+        "${EXECUTORCH_ROOT}/examples/arm/arm-scratch/ml-sdk-for-vulkan-manifest/sw/vgf-lib/"
     )
     set(LIBVGF_STATIC "${LIBVGF_PATH}/build/src/libvgf.a")
   else()

backends/arm/scripts/build_executor_runner.sh

@@ -10,7 +10,7 @@ script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 et_root_dir=$(realpath ${et_root_dir})
 toolchain=arm-none-eabi-gcc
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 source "${script_dir}/utils.sh"
 
@@ -25,7 +25,7 @@ extra_build_flags=""
 output_folder_set=false
 output_folder="."
 et_build_root="${et_root_dir}/arm_test"
-ethosu_tools_dir=${et_root_dir}/examples/arm/ethos-u-scratch
+ethosu_tools_dir=${et_root_dir}/examples/arm/arm-scratch
 select_ops_list=""
 
 build_bundleio_flags=" -DET_BUNDLE_IO=OFF "

backends/arm/scripts/build_executor_runner_vkml.sh

@@ -9,7 +9,7 @@ set -eu
 script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 et_root_dir=$(realpath ${et_root_dir})
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 build_type="Release"
 build_with_etdump=false

backends/arm/scripts/build_executorch.sh

@@ -14,7 +14,7 @@ script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 et_root_dir=$(realpath ${et_root_dir})
 toolchain=arm-none-eabi-gcc
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 
 source "${script_dir}/utils.sh"

backends/arm/scripts/run_fvp.sh

@@ -13,7 +13,7 @@ set -eu
 script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 et_root_dir=$(realpath ${et_root_dir})
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 
 

backends/arm/scripts/run_vkml.sh

@@ -14,7 +14,7 @@ set -o pipefail
 script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 et_root_dir=$(realpath ${et_root_dir})
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 
 

backends/arm/test/test_arm_baremetal.sh

@@ -14,7 +14,7 @@ script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_root_dir=$(cd ${script_dir}/../../.. && pwd)
 cd "${et_root_dir}"
 pwd
-setup_path_script=${et_root_dir}/examples/arm/ethos-u-scratch/setup_path.sh
+setup_path_script=${et_root_dir}/examples/arm/arm-scratch/setup_path.sh
 _setup_msg="please refer to ${et_root_dir}/examples/arm/setup.sh to properly install necessary tools."
 
 

docs/source/backends/arm-ethos-u/arm-ethos-u-overview.md

@@ -21,7 +21,7 @@ The target system must include an Ethos-U NPU.
 ```{tip}
 All requirements can be downloaded using `examples/arm/setup.sh --i-agree-to-the-contained-eula` and added to the path using
 set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}")
-`source examples/arm/ethos-u-scratch/setup_path.sh`. Note that this means accepting the End-User License Agreements (EULA:s) required for using the downloaded software.
+`source examples/arm/arm-scratch/setup_path.sh`. Note that this means accepting the End-User License Agreements (EULA:s) required for using the downloaded software.
 ```
 
 For the AOT flow, compilation of a model to `.pte` format using the Ethos-U backend, the requirements are:

docs/source/backends/arm-ethos-u/tutorials/ethos-u-getting-started.md

@@ -54,7 +54,7 @@ This will install:
 The setup.sh script generates a setup_path.sh script that you need to source whenever you restart your shell. Run:
 
 ```{bash}
-source  examples/arm/ethos-u-scratch/setup_path.sh
+source  examples/arm/arm-scratch/setup_path.sh
 ```
 
 As a simple check that your environment is set up correctly, run `which FVP_Corstone_SSE-320` and make sure that the executable is located where you expect, in the `examples/arm` tree.

docs/source/backends/arm-vgf/arm-vgf-overview.md

@@ -17,7 +17,7 @@ The target system must include ML SDK for Vulkan and a Vulkan driver with Vulkan
 
 ```{tip}
 All requirements can be downloaded using `examples/arm/setup.sh --enable-mlsdk-deps --disable-ethos-u-deps` and added to the path using
-`source examples/arm/ethos-u-scratch/setup_path.sh`
+`source examples/arm/arm-scratch/setup_path.sh`
 ```
 
 For the AOT flow, compilation of a model to `.pte` format using the VGF backend, the requirements are:

docs/source/backends/arm-vgf/tutorials/vgf-getting-started.md

@@ -58,7 +58,7 @@ This will install:
 
 The `setup.sh` script has generated a `setup_path.sh` script that you need to source whenever you restart your shell. Do this by running
 
-`source examples/arm/ethos-u-scratch/setup_path.sh`
+`source examples/arm/arm-scratch/setup_path.sh`
 
 As a simple check that your environment is set up correctly, run
 
@@ -207,7 +207,7 @@ In this tutorial you have learned how to use ExecuTorch to export a PyTorch mode
 
 Issue: glslc is not found when configuring the executor runner.
 Solution: The Vulkan sdk is likely not in your path, check whether setup_path.sh contains something like
-`export PATH=$(pwd)/examples/arm/ethos-u-scratch/vulkan_sdk/1.4.321.1/x86_64/bin:$PATH`.
+`export PATH=$(pwd)/examples/arm/arm-scratch/vulkan_sdk/1.4.321.1/x86_64/bin:$PATH`.
 If not, add it and source the file.
 
 If you encountered any bugs or issues following this tutorial please file a bug/issue here on [Github](https://github.com/pytorch/executorch/issues/new).

docs/source/pico2_tutorial.md

@@ -19,7 +19,7 @@ A 28×28 MNIST digit classifier running on memory constrained, low power microco
 - Verify ARM toolchain
 
 ```bash
-which arm-none-eabi-gcc # --> arm/ethos-u-scratch/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin/
+which arm-none-eabi-gcc # --> arm/arm-scratch/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin/
 ```
 
 ## Step 1: Generate pte from given example Model

examples/arm/README.md

@@ -10,7 +10,7 @@ The main scripts are `setup.sh`, `run.sh` and `aot_arm_compiler.py`.
 `setup.sh` will install the needed tools and with --root-dir <FOLDER> 
 you can change the path to a scratch folder where it will download and generate build
 artifacts. If supplied, you must also supply the same folder to run.sh with
---scratch-dir=<FOLDER> If not supplied both script will use examples/arm/ethos-u-scratch
+--scratch-dir=<FOLDER> If not supplied both script will use examples/arm/arm-scratch
 
 `run.sh` can be used to build, run and test a model in an easy way and it will call cmake for you
 and in cases you want to run a simulator it will start it also. The script will call `aot_arm_compiler.py`
@@ -89,7 +89,7 @@ $ cd <EXECUTORCH-ROOT-FOLDER>
 $ ./examples/arm/setup.sh --i-agree-to-the-contained-eula
 
 # Step [2] - Setup path to tools, The `setup.sh` script has generated a script that you need to source every time you restart you shell.
-$ source  examples/arm/ethos-u-scratch/setup_path.sh
+$ source  examples/arm/arm-scratch/setup_path.sh
 
 # Step [3] - build and run ExecuTorch and executor_runner baremetal example application
 # on a Corstone(TM)-320 FVP to run a simple PyTorch model from a file.

examples/arm/ethos_u_minimal_example.ipynb

@@ -185,7 +185,7 @@
    "source": [
     "%%bash\n",
     "# Ensure the arm-none-eabi-gcc toolchain and FVP:s are available on $PATH\n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Build executorch libraries cross-compiled for arm baremetal to executorch/cmake-out-arm\n",
     "cmake --preset arm-baremetal \\\n",
@@ -201,7 +201,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Build example executor runner application to examples/arm/ethos_u_minimal_example\n",
     "cmake -DCMAKE_TOOLCHAIN_FILE=$(pwd)/ethos-u-setup/arm-none-eabi-gcc.cmake \\\n",
@@ -232,7 +232,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Run the example\n",
     "../../backends/arm/scripts/run_fvp.sh --elf=ethos_u_minimal_example/arm_executor_runner --target=ethos-u55-128"

examples/arm/executor_runner/CMakeLists.txt

@@ -90,7 +90,7 @@ set(ET_PTE_FILE_PATH
     CACHE PATH "Path to ExecuTorch model pte"
 )
 set(ETHOS_SDK_PATH
-    "${ET_DIR_PATH}/examples/arm/ethos-u-scratch/ethos-u"
+    "${ET_DIR_PATH}/examples/arm/arm-scratch/ethos-u"
     CACHE PATH "Path to Ethos-U bare metal driver/env"
 )
 set(PYTHON_EXECUTABLE

examples/arm/pruning_minimal_example.ipynb

@@ -426,7 +426,7 @@
    "source": [
     "%%bash\n",
     "# Ensure the arm-none-eabi-gcc toolchain and FVP:s are available on $PATH\n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Build executorch libraries cross-compiled for arm baremetal to executorch/cmake-out-arm\n",
     "cmake --preset arm-baremetal \\\n",
@@ -443,7 +443,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "# Build example executor runner application to examples/arm/ethos_u_minimal_example\n",
     "cmake -DCMAKE_TOOLCHAIN_FILE=$(pwd)/ethos-u-setup/arm-none-eabi-gcc.cmake \\\n",
     "      -DCMAKE_BUILD_TYPE=Release \\\n",
@@ -465,7 +465,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "# Run the pruned model\n",
     "../../backends/arm/scripts/run_fvp.sh --elf=ethos_u_original_model/arm_executor_runner --target=ethos-u85-128"
    ]
@@ -488,7 +488,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Build example executor runner application to examples/arm/ethos_u_minimal_example\n",
     "cmake -DCMAKE_TOOLCHAIN_FILE=$(pwd)/ethos-u-setup/arm-none-eabi-gcc.cmake \\\n",
@@ -511,7 +511,7 @@
    "outputs": [],
    "source": [
     "%%bash \n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "# Run the pruned model\n",
     "../../backends/arm/scripts/run_fvp.sh --elf=ethos_u_pruned_model/arm_executor_runner --target=ethos-u85-128"
    ]

examples/arm/run.sh

@@ -36,7 +36,7 @@ config=""
 memory_mode=""
 pte_placement="elf"
 et_build_root="${et_root_dir}/arm_test"
-ethos_u_scratch_dir=${script_dir}/ethos-u-scratch
+arm_scratch_dir=${script_dir}/arm-scratch
 scratch_dir_set=false
 toolchain=arm-none-eabi-gcc
 select_ops_list="aten::_softmax.out"
@@ -71,7 +71,7 @@ function help() {
     echo "  --memory_mode=<MODE>                   Ethos-U: Memory mode to select from the Vela configuration file (see vela.ini), e.g. Shared_Sram/Sram_Only. Default: 'Shared_Sram' for Ethos-U55 targets, 'Sram_Only' for Ethos-U85 targets"
     echo "  --pte_placement=<elf|ADDR>             Ethos-U: Control if runtime has PTE baked into the elf or if its placed in memory outside of the elf, defaults to ${pte_placement}"
     echo "  --et_build_root=<FOLDER>               Executorch build output root folder to use, defaults to ${et_build_root}"
-    echo "  --scratch-dir=<FOLDER>                 Path to your Ethos-U scrach dir if you not using default ${ethos_u_scratch_dir}"
+    echo "  --scratch-dir=<FOLDER>                 Path to your Arm scrach dir if you not using default ${arm_scratch_dir}"
     echo "  --qdq_fusion_op                        Enable QDQ fusion op"
     echo "  --model_explorer                       Enable model explorer to visualize TOSA graph."
     echo "  --perf_overlay                         With --model_explorer, include performance data from FVP PMU trace."
@@ -101,7 +101,7 @@ for arg in "$@"; do
       --memory_mode=*) memory_mode="${arg#*=}";;
       --pte_placement=*) pte_placement="${arg#*=}";;
       --et_build_root=*) et_build_root="${arg#*=}";;
-      --scratch-dir=*) ethos_u_scratch_dir="${arg#*=}" ; scratch_dir_set=true ;;
+      --scratch-dir=*) arm_scratch_dir="${arg#*=}" ; scratch_dir_set=true ;;
       --qdq_fusion_op) qdq_fusion_op=true;;
       --model_explorer) model_explorer=true ;;
       --perf_overlay) perf_overlay=true ;;
@@ -124,8 +124,8 @@ if ! [[ ${pte_placement} == "elf" ]]; then
 fi
 
 # Default Ethos-u tool folder override with --scratch-dir=<FOLDER>
-ethos_u_scratch_dir=$(realpath ${ethos_u_scratch_dir})
-setup_path_script=${ethos_u_scratch_dir}/setup_path.sh
+arm_scratch_dir=$(realpath ${arm_scratch_dir})
+setup_path_script=${arm_scratch_dir}/setup_path.sh
 if [[ ${toolchain} == "arm-none-eabi-gcc" ]]; then
     toolchain_cmake=${et_root_dir}/examples/arm/ethos-u-setup/${toolchain}.cmake
 elif [[ ${toolchain} == "arm-zephyr-eabi-gcc" ]]; then
@@ -341,7 +341,7 @@ for i in "${!test_model[@]}"; do
         fi
 
         set -x
-        backends/arm/scripts/build_executor_runner.sh --et_build_root="${et_build_root}" --pte="${pte_file_or_mem}" --build_type=${build_type} --target=${target} --system_config=${system_config} --memory_mode=${memory_mode} ${bundleio_flag} ${et_dump_flag} --extra_build_flags="${extra_build_flags}" --ethosu_tools_dir="${ethos_u_scratch_dir}" --toolchain="${toolchain}" --select_ops_list="${select_ops_list}"
+        backends/arm/scripts/build_executor_runner.sh --et_build_root="${et_build_root}" --pte="${pte_file_or_mem}" --build_type=${build_type} --target=${target} --system_config=${system_config} --memory_mode=${memory_mode} ${bundleio_flag} ${et_dump_flag} --extra_build_flags="${extra_build_flags}" --ethosu_tools_dir="${arm_scratch_dir}" --toolchain="${toolchain}" --select_ops_list="${select_ops_list}"
         if [ "$build_only" = false ] ; then
             # Execute the executor_runner on FVP Simulator
 

examples/arm/setup.sh

@@ -16,7 +16,7 @@ script_dir=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
 et_dir=$(realpath $script_dir/../..)
 ARCH="$(uname -m)"
 OS="$(uname -s)"
-root_dir="${script_dir}/ethos-u-scratch"  # TODO: rename
+root_dir="${script_dir}/arm-scratch"
 eula_acceptance=0
 enable_baremetal_toolchain=1
 target_toolchain=""

examples/arm/vgf_minimal_example.ipynb

@@ -24,7 +24,7 @@
     "Before you begin:\n",
     "1. (In a clean virtual environment with a compatible Python version) Install executorch using `./install_executorch.sh`\n",
     "2. Install MLSDK and Tosa using `examples/arm/setup.sh --disable-ethos-u-deps --enable-mlsdk-deps` (For further guidance, refer to https://docs.pytorch.org/executorch/main/tutorial-arm.html)\n",
-    "3. Export vulkan environment variables and add MLSDK components to PATH and LD_LIBRARY_PATH using `examples/arm/ethos-u-scratch/setup_path.sh`\n",
+    "3. Export vulkan environment variables and add MLSDK components to PATH and LD_LIBRARY_PATH using `examples/arm/arm-scratch/setup_path.sh`\n",
     "\n",
     "With all commands executed from the base `executorch` folder.\n",
     "\n",
@@ -163,7 +163,7 @@
    "source": [
     "%%bash\n",
     "# Ensure the vulkan environment variables and MLSDK components are available on $PATH\n",
-    "source ethos-u-scratch/setup_path.sh"
+    "source arm-scratch/setup_path.sh"
    ]
   },
   {
@@ -232,7 +232,7 @@
    "source": [
     "%%bash\n",
     "# Ensure the vulkan environment variables and MLSDK components are available on $PATH\n",
-    "source ethos-u-scratch/setup_path.sh\n",
+    "source arm-scratch/setup_path.sh\n",
     "\n",
     "# Compiled programs will appear in the executorch/cmake-out directory we create here.\n",
     "# Build example executor runner application to examples/arm/vgf_minimal_example\n",

examples/raspberry_pi/pico2/README.md

@@ -49,7 +49,7 @@ Make sure you have the toolchain configured correctly. Refer to this [setup](htt
 
 ```bash
 which arm-none-eabi-gcc
-# Should return: executorch/examples/arm/ethos-u-scratch/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-gcc
+# Should return: executorch/examples/arm/arm-scratch/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-gcc
 ```
 
 ## Build Pico2 Firmware with ExecuTorch