Skip to content

Conversation

c-p-i-o
Copy link
Contributor

@c-p-i-o c-p-i-o commented Oct 4, 2024

Summary:
Update readme with reference to the flight recorder tutorial to help users diagnose stuck jobs.

Test Plan:
none.

Summary:
Update readme with reference to the flight recorder tutorial to help
users diagnose stuck jobs.

Test Plan:
none.
@c-p-i-o c-p-i-o self-assigned this Oct 4, 2024
@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Oct 4, 2024
@c-p-i-o c-p-i-o requested a review from fduwjj October 4, 2024 23:21
Copy link
Contributor

@lessw2020 lessw2020 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!
I have feedback on the tutorial itself (not the readme add).
You break up the flow of the document here:

An example command is:

Caveat: tabulate module is needed, so you might need pip install it first.

Two suggestions:
a - don't interrupt the flow - move from 'an example command is:' to the actual command. Don't distract in the middle...i.e. Move the caveat to afterwards.

b - you tell the user they might need to pip install tabulate module...so please show the exact command. Is it 'pip install tabulate' or is it 'pip install tabulate module' or is it 'pip install tabulate-module' or ?

@c-p-i-o
Copy link
Contributor Author

c-p-i-o commented Oct 7, 2024

looks good! I have feedback on the tutorial itself (not the readme add). You break up the flow of the document here:

An example command is:

Caveat: tabulate module is needed, so you might need pip install it first.

Two suggestions: a - don't interrupt the flow - move from 'an example command is:' to the actual command. Don't distract in the middle...i.e. Move the caveat to afterwards.

b - you tell the user they might need to pip install tabulate module...so please show the exact command. Is it 'pip install tabulate' or is it 'pip install tabulate module' or is it 'pip install tabulate-module' or ?

Thanks! I've create pytorch/tutorials#3081 with these suggestions!

@c-p-i-o c-p-i-o merged commit 40a1026 into main Oct 7, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants