Skip to content

Commit 0b68778

Browse files
committed
[doc] Minor fix
Summary: Don't interrupt user's flow that they may need to install `tabulate`. Also, show them the actual command that they need to run to install `tabulate`. Test Plan: Look at rendered doc.
1 parent 67ec2a5 commit 0b68778

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

prototype_source/flight_recorder_tutorial.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,14 @@ Caveat: tabulate module is needed, so you might need pip install it first.
199199
python fr_trace.py <dump dir containing trace files> -j [--selected-ranks i j k ...] [--pg-filters tp dp]
200200
torchfrtrace <dump dir containing trace files> -j [--selected-ranks i j k ...] [--pg-filters 0 2]
201201
202+
203+
You may need to install the `tabulate` python module if the command does not work.
204+
205+
.. code:: shell
206+
207+
pip install tabulate
208+
209+
202210
Conclusion
203211
----------
204212
In this tutorial, we have learned about a new PyTorch diagnostic tool called Flight Recorder.

0 commit comments

Comments
 (0)