Skip to content

Distributed Data Parallel Tutorial UX improvement suggestion #1637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HDCharles opened this issue Aug 5, 2021 · 10 comments
Open

Distributed Data Parallel Tutorial UX improvement suggestion #1637

HDCharles opened this issue Aug 5, 2021 · 10 comments
Labels
content A label for incorrect descriptions that needs to be updated docathon-h2-2023 medium

Comments

@HDCharles
Copy link
Contributor

HDCharles commented Aug 5, 2021

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

@svekars svekars added the content A label for incorrect descriptions that needs to be updated label Mar 6, 2023
@svekars svekars added medium docathon-h1-2023 A label for the docathon in H1 2023 labels May 31, 2023
@Samsonboadi
Copy link
Contributor

/assigntome

@Samsonboadi
Copy link
Contributor

@svekars where is the sources file for this issue so I can address it? Is this relevant? because I dont see any link to the source file here

@HDCharles
Copy link
Contributor Author

@svekars
Copy link
Contributor

svekars commented Oct 24, 2023

This issue has been unassigned due to inactivity. If you are still planning to work on this, you can still send a PR referencing this issue.

@svekars svekars added docathon-h2-2023 and removed docathon-h1-2023 A label for the docathon in H1 2023 labels Oct 30, 2023
@JoseLuisC99
Copy link
Contributor

/assigntome

@svekars
Copy link
Contributor

svekars commented Nov 2, 2023

@JoseLuisC99 - glad to see you again! Can you please tell me which of the tasks assigned to you are you working on at the moment? You have three tasks assigned to you and I want to make sure others get a chance to participate as well.

@JoseLuisC99
Copy link
Contributor

JoseLuisC99 commented Nov 2, 2023

Hi! Ok, I will focus on #2345

@ma7dev
Copy link

ma7dev commented Nov 4, 2023

/assigntome

@gao-hongnan
Copy link

/assigntome

Copy link

github-actions bot commented Nov 9, 2023

The issue is already assigned. Please pick an opened and unnasigned issue with the docathon-h2-2023 label.

@ma7dev ma7dev removed their assignment Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content A label for incorrect descriptions that needs to be updated docathon-h2-2023 medium
Projects
None yet
Development

No branches or pull requests

6 participants