From 5db2b0546a2b281882ed8cb1cc37600fa86355c5 Mon Sep 17 00:00:00 2001
From: JoongunPark <8554137+JoongunPark@users.noreply.github.com>
Date: Fri, 10 May 2024 18:00:36 -0400
Subject: [PATCH] Update user guide to include HTA installation and new
 argument for chakra_trace_link

Co-authored-by: Joongun Park <8554137+JoongunPark@users.noreply.github.com>
---
 USER_GUIDE.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index 2a1b95fb..9f59cd62 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -35,7 +35,19 @@ $ git checkout c83ce8429110a86549c40fec5a01acbd9fbd54a4
 $ 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 5c7898abbc52a1d4051ef6c93365477feb6c08a8
+$ 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
@@ -50,6 +62,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
 ```