Skip to content

Arm backend: Add info about setup_path.sh and arm-none-eabi-gcc #9454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 1 commit into from
Mar 21, 2025
Merged

Arm backend: Add info about setup_path.sh and arm-none-eabi-gcc #9454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,25 @@ At the end of the setup, if everything goes well, your top level devlopement dir
└── setup_path.sh
```

### Notes:

The `setup.sh` script has generated a `setup_path.sh` script that you need to source everytime you restart you shell.

e.g. run
`source executorch/examples/arm/ethos-u-scratch/setup_path.sh`

As `setup.sh` will download and setup the needed Arm toolchain make sure it is used by calling

`which arm-none-eabi-gcc`

It should show `arm-none-eabi-gcc` in the `executorch` project and not anything in `/usr/bin` something like:

`<EXECUTORCH_ROOT>/examples/arm/ethos-u-scratch/arm-gnu-toolchain-13.3.rel1-aarch64-arm-none-eabi/bin/arm-none-eabi-gcc`
or
`<EXECUTORCH_ROOT>/examples/arm/ethos-u-scratch/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-gcc`

If not you might need to uninstall `arm-none-eabi-gcc` or make sure its picked after the one in the project in your $PATH env varable.

## Convert the PyTorch Model to the `.pte` File

`.pte` is a binary file produced by ExecuTorch Ahead-of-Time (AoT) pipeline by taking in a PyTorch Model (a torch.nn.Module), exporting it, running a variety of passes, and finally serializing it to a `.pte` file format. This binary file is typically consumed by the ExecuTorch Runtime. This [document](https://github.com/pytorch/executorch/blob/main/docs/source/getting-started-architecture.md) goes in much more depth about the ExecuTorch software stack for both AoT as well as Runtime.
Expand Down
13 changes: 9 additions & 4 deletions examples/arm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,19 @@ build artifacts. If supplied, the same argument must be supplied to both the scr
To run these scripts. On a Linux system, in a terminal, with a working internet connection,
```
# Step [1] - setup necessary tools
$ ./setup.sh --i-agree-to-the-contained-eula [optional-scratch-dir]
$ cd <EXECUTORCH-ROOT-FOLDER>
$ executorch/examples/arm/setup.sh --i-agree-to-the-contained-eula [optional-scratch-dir]

# Step [2] - build + run ExecuTorch and executor_runner baremetal application
# Step [2] - Setup Patch to tools, The `setup.sh` script has generated a script that you need to source everytime you restart you shell.
$ source executorch/examples/arm/ethos-u-scratch/setup_path.sh

# Step [3] - build + run ExecuTorch and executor_runner baremetal application
# suited for Corstone FVP's to run a simple PyTorch model.
$ ./run.sh [--scratch-dir=same-optional-scratch-dir-as-before]
$ executorch/examples/arm/run.sh --model_name=mv2 --target=ethos-u85-128 [--scratch-dir=same-optional-scratch-dir-as-before]
```

### Online Tutorial

We also have a [tutorial](https://pytorch.org/executorch/stable/executorch-arm-delegate-tutorial.html) explaining the steps performed in these
scripts, expected results, and more. It is a step-by-step guide
scripts, expected results, possible problems and more. It is a step-by-step guide
you can follow to better understand this delegate.
Loading