Skip to content

Commit 62d4041

Browse files
metascroymalfet
authored andcommitted
doc updates (#567)
1 parent ac46947 commit 62d4041

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/executorch_setup.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ Before running any commands in torchchat that require ExecuTorch, you must first
55
To install ExecuTorch, run the following commands *from the torchchat root directory*.
66

77
```
8-
export TORCHCHAT_ROOT=${PWD}
9-
export ENABLE_ET_PYBIND=true
10-
./scripts/install_et.sh $ENABLE_ET_PYBIND
8+
export TORCHCHAT_ROOT=$PWD
9+
./scripts/install_et.sh
1110
```
1211

1312
This will download the ExecuTorch repo to ./et-build/src and install various ExecuTorch libraries to ./et-build/install.

docs/runner_build.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,7 @@ Options:
4747
To build runner-aoti, run the following commands *from the torchchat root directory*
4848

4949
```
50-
# Pull submodules (re2, abseil) for Tiktoken
51-
git submodule sync
52-
git submodule update --init
53-
54-
cmake -S . -B ./cmake-out -G Ninja -DCMAKE_PREFIX_PATH=`python3 -c 'import torch;print(torch.utils.cmake_prefix_path)'`
55-
cmake --build ./cmake-out --target aoti_run
50+
./scripts/build_native.sh aoti
5651
```
5752

5853
After running these, the runner-aoti binary is located at ./cmake-out/aoti_run.
@@ -80,6 +75,12 @@ Before building runner-et, you must first setup ExecuTorch by following [setup E
8075

8176
To build runner-et, run the following commands *from the torchchat root directory*
8277

78+
```
79+
./scripts/build_native.sh et
80+
```
81+
82+
Note: the above script will wipe ./et-build if present and re-install ExecuTorch to ./et-build, which can take a while. If you already installed ExecuTorch, running the commands below will build the runner, without re-installing ExecuTorch from source:
83+
8384
```
8485
# Pull submodules (re2, abseil) for Tiktoken
8586
git submodule sync

scripts/build_native.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ fi
7676
cmake -S . -B ./cmake-out -DCMAKE_PREFIX_PATH=`python -c 'import torch;print(torch.utils.cmake_prefix_path)'` -G Ninja
7777
cmake --build ./cmake-out --target "${TARGET}"_run
7878

79-
printf "Build finished. Please run: \n./cmake-out/${TARGET}_run model.<pte|so> -z tokenizer.model -l <llama version (2 or 3)> -i <prompt>"
79+
printf "Build finished. Please run: \n./cmake-out/${TARGET}_run model.<pte|so> -z tokenizer.model -l <llama version (2 or 3)> -i <prompt>\n"

0 commit comments

Comments
 (0)