Skip to content
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

Dead Links in "Implementing your own DDP" documentation #5031

Closed
alanhdu opened this issue Dec 8, 2020 · 4 comments · Fixed by #5046
Closed

Dead Links in "Implementing your own DDP" documentation #5031

alanhdu opened this issue Dec 8, 2020 · 4 comments · Fixed by #5046
Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on

Comments

@alanhdu
Copy link
Contributor

alanhdu commented Dec 8, 2020

📚 Documentation

In the "Implementing your own DDP section" (https://pytorch-lightning.readthedocs.io/en/stable/multi_gpu.html#implement-your-own-distributed-ddp-training), the text says:

If you need your own way to init PyTorch DDP you can override pytorch_lightning.core.LightningModule.().

If you also need to use your own DDP implementation, override: pytorch_lightning.core.LightningModule.configure_ddp().

Unfortunately, both of those seem to be dead links. I'm not sure what would replace them -- the custom DDP implementation should presumably point to https://pytorch-lightning.readthedocs.io/en/stable/accelerators.html#implement-a-custom-accelerator, but I'm not sure where the "overriding the init Pytorch DDP" should live (from the Git blame, it looks like used to call to a init_ddp_connection function that doesn't seem to exist anymore).

@alanhdu alanhdu added the docs Documentation related label Dec 8, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2020

Hi! thanks for your contribution!, great first issue!

@alanhdu alanhdu changed the title Outdated documentation Outdated documentation for "Implementing your own DDP" Dec 8, 2020
@alanhdu alanhdu changed the title Outdated documentation for "Implementing your own DDP" Dead Links in "Implementing your own DDP" documentation Dec 8, 2020
@Borda
Copy link
Member

Borda commented Dec 8, 2020

@alanhdu mind send a PR?

@Borda Borda added good first issue Good for newcomers help wanted Open to be worked on labels Dec 8, 2020
@alanhdu
Copy link
Contributor Author

alanhdu commented Dec 8, 2020

@Borda -- what should the updated links point to? Presumably the configure_ddp should point to the custom accelerator docs, but I don't know where the first link ("init Pytorch ddp") should go.

@awaelchli
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants