Skip to content

Tutorial for DDP + RPC. #1061

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

Closed
wants to merge 3 commits into from
Closed

Tutorial for DDP + RPC. #1061

wants to merge 3 commits into from

Conversation

pritamdamania87
Copy link
Contributor

Summary: Based on example from pytorch/examples#800

Summary: Based on example from pytorch/examples#800
@netlify
Copy link

netlify bot commented Jul 9, 2020

Deploy preview for pytorch-tutorials-preview ready!

Built with commit a701926

https://deploy-preview-1061--pytorch-tutorials-preview.netlify.app

Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
@ezyang
Copy link
Contributor

ezyang commented Jul 9, 2020

It would be much better if the tutorial code was written in runnable fashion (either by writing the tutorial directly as a python file with sphinx-gallery, or keeping the Python code separate from the rst file) so that we can test the tutorial in the future. See #1057 for an example of how to do this.

Copy link
Contributor

@mrshenli mrshenli left a comment

Choose a reason for hiding this comment

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

IIRC, tutorials for v1.6 need to use release/1.6 as the target branch.

@mrshenli
Copy link
Contributor

cc @jlin27

Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
@pritamdamania87
Copy link
Contributor Author

IIRC, tutorials for v1.6 need to use release/1.6 as the target branch.

Don't we need to commit the tutorial in master first though?

@ezyang Thanks for the great suggestion! I used literalinclude and this approach is much better.

@mrshenli @jlin27 Do we still need to add examples in pytorch/examples#800 if we have a runnable example in the tutorials repo? It seems like we can keep the runnable example in the tutorials repo and just refer to it in our tutorial?

@jlin27
Copy link
Contributor

jlin27 commented Jul 15, 2020

@pritamdamania87

IIRC, tutorials for v1.6 need to use release/1.6 as the target branch.

Don't we need to commit the tutorial in master first though?
The pytorch/tutorials branches are backwards from pytorch/pytorch. In pytorch/tutorials, master is live/stable (not sure the history but it is what it is rn :) ) For tutorials planned for 1.6, please submit them to the release/1.6 branch and I'll get them live on master for the release.

@mrshenli @jlin27 Do we still need to add examples in pytorch/examples#800 if we have a runnable example in the tutorials repo? It seems like we can keep the runnable example in the tutorials repo and just refer to it in our tutorial?

I think the pro of keeping it in the examples as well is that there are a number of other related examples there already and it would be advantageous for users to find this one there. Only downside is maintaining both.

@pritamdamania87
Copy link
Contributor Author

Created a PR against release/1.6: #1071

@mrshenli
Copy link
Contributor

@mrshenli @jlin27 Do we still need to add examples in pytorch/examples#800 if we have a runnable example in the tutorials repo? It seems like we can keep the runnable example in the tutorials repo and just refer to it in our tutorial?

I am not sure about the plan here. @ezyang do you know if we are going to completely get rid the pytorch/examples repo and stick all source code in the pytorch/tutorials repo (I assume all examples should have their associated tutorial)?

If this is the plan, then yes, let's move all distributed examples source code to tutorials repo.

If this is not the plan, then what is our guidelines to users regarding what to expect in pytorch/examples vs pytorch/tutorials? Looks like both repos will become some random subset of the example projects we have.

Another question for @jlin27 is we do plan to let tutorials CI to run the source code included in tutorials? Or will this be test be installed to the examples repo?

@jlin27
Copy link
Contributor

jlin27 commented Jul 15, 2020

Another question for @jlin27 is we do plan to let tutorials CI to run the source code included in tutorials? Or will this be test be installed to the examples repo?

The plan is to have it on both examples and tutorials. I haven't heard anything about getting rid of pytorch/examples, but please do comment if that's been under discussion.

@ezyang
Copy link
Contributor

ezyang commented Jul 16, 2020

I don't think it's a good idea to have two copies of the code. Perhaps an easy compromise is to submodule examples inside tutorials. Then you can literalinclude the examples code directly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants