Update FR tutorial to include file path, writer and print usage #3058
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3058
Note: Links to docs will display an error until the docs builds have been completed. ✅ You can merge normally! (1 Unrelated Failure)As of commit 143d736 with merge base 0b23f46 ( FLAKY - The following job failed but was likely due to flakiness present on trunk:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
c-p-i-o
approved these changes
Sep 23, 2024
c-p-i-o
reviewed
Sep 23, 2024
| @@ -71,6 +73,9 @@ Additional Settings | |||
|
|
|||
| ``fast`` is a new experimental mode that is shown to be much faster than the traditional ``addr2line``. | |||
| Use this setting in conjunction with ``TORCH_NCCL_TRACE_CPP_STACK`` to collect C++ traces in the Flight Recorder data. | |||
| - If you prefer not to have the flight recorder data dumped into the local disk but rather onto your own storage, you can define your own writer class. | |||
| This class should inherit from class ``::c10d::DebugInfoWriter`` and then register the new writer using ``::c10d::DebugInfoWriter::registerWriter`` | |||
There was a problem hiding this comment.
Suggestion:
Can you make this (DebugInfoWriter) a link to the code in PyTorch?
c-p-i-o
reviewed
Sep 23, 2024
| @@ -48,6 +48,8 @@ Enabling Flight Recorder | |||
| ------------------------ | |||
| There are two required environment variables to get the initial version of Flight Recorder working. | |||
|
|
|||
| - ``TORCH_NCCL_DEBUG_INFO_TEMP_FILE``: Setting the path where the flight recorder will be dumped with file prefix. One file per | |||
There was a problem hiding this comment.
Nit: Can you move this to the Optional settings section?
Otherwise the comment on Line 49 can be confusing to the customer (there are two required environment variables).
Or you can fix the comment.
c-p-i-o
reviewed
Sep 23, 2024
| Currently, we support two modes for the analyzer script. The first mode allows the script to apply some heuristics to the parsed flight | ||
| recorder dumps to generate a report identifying potential culprits for the timeout. The second mode is simply outputs the raw dumps. | ||
| By default, the script prints flight recoder dumps for all ranks and all ``ProcessGroups``(PGs). This can be narrowed down to certain | ||
| ranks and PGs. An example command is: |
There was a problem hiding this comment.
Suggested clarification to sentence.
can be narrowed down to certain ranks and PGs using the selected-ranks option.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is the PR trying to update the tutorial of FR to reflect the latest changes and provide more context on how to use it.
Checklist