Skip to content

Commit 9236a68

Browse files
authored
Update MPS doc to correct file names, commands (#12772)
### Summary There are a few updates needed to the MPS docs. I made the following changes: * Link to the build from source docs, as the instructions on the MPS docs have to be run from the source directory. * Update the MV3 pte file name is some of the example commands. It previously did not match the file generated from the example export. * Update the devtools inspector command to use the devtools namespace instead of sdk, which no longer works. ### Test plan Ran through the MPS documentation page locally with the updated commands.
1 parent f6f5796 commit 9236a68

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/source/backends-mps.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ In order to be able to successfully build and run a model using the MPS backend
4040

4141
## Setting up Developer Environment
4242

43-
***Step 1.*** Please finish tutorial [Getting Started](getting-started.md).
43+
***Step 1.*** Complete the steps in [Getting Started](getting-started.md) to set up the ExecuTorch development environment.
44+
45+
You will also need a local clone of the ExecuTorch repository. See [Building ExecuTorch from Source](using-executorch-building-from-source.html) for instructions. All commands in this document should be run from the executorch repository.
4446

4547
## Build
4648

@@ -70,12 +72,12 @@ cd executorch
7072
## Run the mv3 generated model using the mps_executor_runner
7173

7274
```bash
73-
./cmake-out/examples/apple/mps/mps_executor_runner --model_path mv3_mps_bundled_fp16.pte --bundled_program
75+
./cmake-out/examples/apple/mps/mps_executor_runner --model_path mv3_mps_float16_bundled.pte --bundled_program
7476
```
7577

7678
- You should see the following results. Note that no output file will be generated in this example:
7779
```
78-
I 00:00:00.003290 executorch:mps_executor_runner.mm:286] Model file mv3_mps_bundled_fp16.pte is loaded.
80+
I 00:00:00.003290 executorch:mps_executor_runner.mm:286] Model file mv3_mps_float16_bundled.pte is loaded.
7981
I 00:00:00.003306 executorch:mps_executor_runner.mm:292] Program methods: 1
8082
I 00:00:00.003308 executorch:mps_executor_runner.mm:294] Running method forward
8183
I 00:00:00.003311 executorch:mps_executor_runner.mm:349] Setting up non-const buffer 1, size 606112.
@@ -112,11 +114,11 @@ python3 -m examples.apple.mps.scripts.mps_example --model_name="mv3" --generate_
112114
```
113115
2. Run your Program on the ExecuTorch runtime and generate an [ETDump](etdump.md).
114116
```
115-
./cmake-out/examples/apple/mps/mps_executor_runner --model_path mv3_mps_bundled_fp16.pte --bundled_program --dump-outputs
117+
./cmake-out/examples/apple/mps/mps_executor_runner --model_path mv3_mps_float16_bundled.pte --bundled_program --dump-outputs
116118
```
117119
3. Create an instance of the Inspector API by passing in the ETDump you have sourced from the runtime along with the optionally generated ETRecord from step 1.
118120
```bash
119-
python3 -m sdk.inspector.inspector_cli --etdump_path etdump.etdp --etrecord_path etrecord.bin
121+
python3 -m devtools.inspector.inspector_cli --etdump_path etdump.etdp --etrecord_path etrecord.bin
120122
```
121123

122124
## Deploying and Running on Device

0 commit comments

Comments
 (0)