Skip to content

Commit 67ec2a5

Browse files
authored
[FR][Tutorial] Update the tutorial to reflect the pg command arg (#3076)
1 parent 352ae64 commit 67ec2a5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

prototype_source/flight_recorder_tutorial.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,14 +190,14 @@ command directly:
190190
Currently, we support two modes for the analyzer script. The first mode allows the script to apply some heuristics to the parsed flight
191191
recorder dumps to generate a report identifying potential culprits for the timeout. The second mode is simply outputs the raw dumps.
192192
By default, the script prints flight recoder dumps for all ranks and all ``ProcessGroups``(PGs). This can be narrowed down to certain
193-
ranks and PGs using the *--selected-ranks* argument. An example command is:
193+
ranks and PGs using the *--selected-ranks* argument for ranks and *--pg-filters* argument for PGs. An example command is:
194194
195195
Caveat: tabulate module is needed, so you might need pip install it first.
196196
197197
.. code:: shell
198198
199-
python fr_trace.py <dump dir containing trace files> -j [--selected-ranks i j k ...]
200-
torchfrtrace <dump dir containing trace files> -j [--selected-ranks i j k ...]
199+
python fr_trace.py <dump dir containing trace files> -j [--selected-ranks i j k ...] [--pg-filters tp dp]
200+
torchfrtrace <dump dir containing trace files> -j [--selected-ranks i j k ...] [--pg-filters 0 2]
201201
202202
Conclusion
203203
----------

0 commit comments

Comments
 (0)