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 <8554137+JoongunPark@users.noreply.github.com>
  • Loading branch information
JoongunPark authored and TaekyungHeo committed Oct 7, 2024
1 parent 4080d6f commit b26cc9f
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 @@ -35,7 +35,19 @@ $ git checkout 7b19f586dd8b267333114992833a0d7e0d601630
$ 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 @@ -49,6 +61,7 @@ Merge Chakra host execution trace and Chakra device execution trace to encode GP
$ chakra_trace_link \
--chakra-host-trace /path/to/chakra_host_trace \
--chakra-device-trace /path/to/chakra_device_trace \
--rank [RANK] \
--output-file /path/to/chakra_host_device_trace.json
```

Expand Down

0 comments on commit b26cc9f

Please sign in to comment.