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

Docs section for SLURM troubleshooting #14873

Merged
merged 6 commits into from
Sep 29, 2022
Merged

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Sep 23, 2022

What does this PR do?

Fixes #14781

My proposal is to add a section to the docs that explains the most likely cause for hangs.
Ideally we would provide a useful error message. The issue with a concrete solution is here #10150 and here #14078. However, these still can't eliminate all user error, especially regarding the setup of the SLURM submission script.

@Felonious-Spellfire for review of the language and structure.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

I made sure I had fun coding 🙃

cc @Borda @rohitgr7 @Felonious-Spellfire @akihironitta

@awaelchli awaelchli added the docs Documentation related label Sep 23, 2022
@awaelchli awaelchli self-assigned this Sep 23, 2022
@awaelchli awaelchli added this to the pl:1.8 milestone Sep 23, 2022
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Sep 23, 2022
docs/source-pytorch/clouds/cluster_advanced.rst Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Sep 28, 2022
@awaelchli awaelchli enabled auto-merge (squash) September 28, 2022 09:19
@awaelchli awaelchli merged commit ff3c5b7 into master Sep 29, 2022
@awaelchli awaelchli deleted the docs/troubleshooting-slurm branch September 29, 2022 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

stuck at "Initializing distributed.." when using ddp with multiple gpus
6 participants