Skip to content

Commit 637bf93

Browse files
authored
Fix broken links in flight recorder tutorial (#3656)
Updated all references from tools/flight_recorder to the correct path torch/distributed/flight_recorder and ensured links point to the main branch. Fixes #3654 cc @svekars @sekyondaMeta @AlannaBurke
1 parent 86b1c62 commit 637bf93

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

unstable_source/flight_recorder_tutorial.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Flight Recorder consists of two core parts:
4444

4545
- The collection portion: when enabled, information about collectives is recorded in an in-memory circular buffer. Upon job timeout, or on demand, the in-memory buffer can be retrieved or dumped to file.
4646

47-
- An analyzer script is available in the `tools/flight_recorder <https://github.com/pytorch/pytorch/tree/main/tools/flight_recorder>`__ directory (details below).
47+
- An analyzer script is available in the `torch/distributed/flight_recorder <https://github.com/pytorch/pytorch/tree/main/torch/distributed/flight_recorder>`__ directory (details below).
4848
The analyzer script runs known heuristics using the collected data and attempts to automatically identify the underlying issue that caused the job to stall.
4949

5050
Enabling Flight Recorder
@@ -169,7 +169,7 @@ The contents of a Flight Recorder ``unpickled`` file are shown below:
169169
Analyzing Flight Recorder Dumps
170170
-------------------------------
171171

172-
We have convenient scripts available in `pytorch/tools/flight_recorder` directory for analyzing captured
172+
We have convenient scripts available in `pytorch/torch/distributed/flight_recorder <https://github.com/pytorch/pytorch/tree/main/torch/distributed/flight_recorder>`__ directory for analyzing captured
173173
data.
174174

175175
To run the convenience script, follow these steps:
@@ -300,5 +300,5 @@ Conclusion
300300
In this tutorial, we have learned about a new PyTorch diagnostic tool called Flight Recorder.
301301
We have discussed how to enable Flight Recorder to collect diagnostic data from a machine.
302302
Additionally, we explored how to analyze the data captured from the Flight Recorder using a
303-
convenience script located in the `tools/flight_recorder <https://github.com/pytorch/pytorch/tree/main/tools/flight_recorder>`__
303+
convenience script located in the `torch/distributed/flight_recorder <https://github.com/pytorch/pytorch/tree/main/torch/distributed/flight_recorder>`__
304304
directory of the PyTorch repository.

0 commit comments

Comments
 (0)