tutorials
tutorials copied to clipboard
pytorch
Distributed Data Parallel Tutorial UX improvement suggestion
referring to the tutorial: https://pytorch.org/tutorials/intermediate/ddp_tutorial.html
Though the tutorial is broken down into sections, it doesn't show how to actually run the code from each section until the very end of the tutorial.
The code as presented in each section only gives function definitions despite the tutorial text carrying on as though the user is supposed to be able to see something from running the code snippet that has been provided. This combination of info presented in a way that seems self contained, with code that seems self contained but isn't was rather confusing.
to remedy this issue I think it'd make things easier if either A) the code to run each section is included in that code snippet B) a notebook is included in the tutorial so users can see how the code is actually run, without having to guess/find that this code is only listed at the bottom of the tutorial C) mention that a reasonable default set to run the code snippets can be found at the bottom of the tutorial.
additional data point: Before I noticed the code at the bottom of the tutorial to invoke the functions, I looked for other resources and came across an external tutorial: https://yangkky.github.io/2019/07/08/distributed-pytorch-tutorial.html which specifically references the pytorch DDP tutorial and raises similar criticism. Though some of the flaws pointed out have been fixed, this piece remains
cc @sekyondaMeta @svekars @carljparker @NicolasHug @kit1980 @subramen
@galrotem has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.
