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

Update Torch Elastic documentation #8248

Merged
merged 2 commits into from
Jul 1, 2021

Conversation

kaushikb11
Copy link
Contributor

What does this PR do?

TorchElastic is now upstream, part of torch.distributed.

Fixes #8243

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?

Make sure you had fun coding 🙃

@kaushikb11 kaushikb11 added the docs Documentation related label Jul 1, 2021
@kaushikb11 kaushikb11 added this to the v1.4 milestone Jul 1, 2021
@codecov
Copy link

codecov bot commented Jul 1, 2021

Codecov Report

Merging #8248 (5fcb1a9) into master (d51b0ae) will decrease coverage by 5%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #8248    +/-   ##
=======================================
- Coverage      93%     88%    -5%     
=======================================
  Files         212     212            
  Lines       13695   13703     +8     
=======================================
- Hits        12735   12060   -675     
- Misses        960    1643   +683     

Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

eggsellent!

Copy link
Contributor

@ananthsub ananthsub left a comment

Choose a reason for hiding this comment

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

thanks @kaushikb11 !

Comment on lines +642 to +650
Torch Distributed Elastic
-------------------------
Lightning supports the use of Torch Distributed Elastic to enable fault-tolerant and elastic distributed job scheduling. To use it, specify the 'ddp' or 'ddp2' backend and the number of gpus you want to use in the trainer.

.. code-block:: python

Trainer(gpus=8, accelerator='ddp')


Following the `TorchElastic Quickstart documentation <https://pytorch.org/elastic/latest/quickstart.html>`_, you then need to start a single-node etcd server on one of the hosts:
To launch a fault-tolerant job, run the following on all nodes.
Copy link
Contributor

Choose a reason for hiding this comment

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

@edenafek - do you think its worth having a dedicated docs section on which schedulers/launchers Lightning supports? This could cover launching with SLURM, torch distributed elastic, etc

@Borda Borda added the ready PRs ready to be merged label Jul 1, 2021
docs/source/advanced/multi_gpu.rst Show resolved Hide resolved
docs/source/advanced/multi_gpu.rst Outdated Show resolved Hide resolved
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
@kaushikb11 kaushikb11 enabled auto-merge (squash) July 1, 2021 21:16
@kaushikb11 kaushikb11 merged commit 365a9ba into Lightning-AI:master Jul 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update torchelstic docs in Lightning
6 participants