Skip to content

Commit

Permalink
Update user guide to include HTA installation and new argument for ch…
Browse files Browse the repository at this point in the history
…akra_trace_link

Co-authored-by: Joongun Park <[email protected]>
  • Loading branch information
JoongunPark authored and TaekyungHeo committed Jul 3, 2024
1 parent 40ee672 commit b758aab
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,19 @@ $ sed -i '' '13d' pyproject.toml
$ pip install .
```

### Step 4: Uninstalling Chakra
### Step 4: Install Holistic Trace Analysis
Installing Holistic Trace Analysis is necessary for Trace link.

```bash
$ git clone https://github.com/facebookresearch/HolisticTraceAnalysis.git
$ cd HolisticTraceAnalysis
$ git checkout d731cc2e2249976c97129d409a83bd53d93051f6
$ git submodule update --init
$ pip install -r requirements.txt
$ pip install -e .
```

### Step 5: Uninstalling Chakra
To uninstall Chakra, use the following command within the virtual environment.

```bash
Expand All @@ -51,6 +63,7 @@ Merge PyTorch Chakra host trace and Kineto trace to encode GPU operators into th
$ chakra_trace_link \
--pytorch-et-file /path/to/pytorch_et \
--kineto-file /path/to/kineto \
--rank [RANK]
--output-file /path/to/merged_et
```

Expand Down

0 comments on commit b758aab

Please sign in to comment.