Add FSDP docs #7791
Merged
Add FSDP docs #7791
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SeanNaren
requested review from
awaelchli,
Borda,
edenlightning and
tchaton
as code owners
Codecov Report
@@ Coverage Diff @@
## master #7791 +/- ##
======================================
- Coverage 93% 92% -0%
======================================
Files 199 199
Lines 12987 13008 +21
======================================
- Hits 12020 12006 -14
- Misses 967 1002 +35 |
justusschock
approved these changes
Jun 1, 2021
| Wrap the Model | ||
| """""""""""""" | ||
|
|
||
| To activate parameter sharding, you must wrap your model using provided ``wrap`` or ``auto_wrap`` functions as described below. Internally in Lightning, we enable a context manager around the ``configure_sharded_model`` function to make sure the ``wrap`` and ``auto_wrap`` parameters are passed correctly. |
There was a problem hiding this comment.
Not really docs, but came to my mind (ignore it if not appropriate): Is it possible to add a maximum recursion depth here as a stopping condition for recursion instead of just the parameter number?
There was a problem hiding this comment.
Good point! Atm we use a policy in lightning to wrap modules, but this can be changed. Will be exposed eventually but I think the current consensus is to use wrap right now as things are getting ironed out!
awaelchli
approved these changes
Jun 1, 2021
Borda
approved these changes
Jun 1, 2021
ethanwharris
approved these changes
Jun 1, 2021
|
Test is failing atm, but let's keep it like that cos I want @ananthsub and @shuyingsunshine21 to take a look :) |
|
lgtm overall, thanks @SeanNaren |
|
Re-running the jobs! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds docs for #7487, with usage instructions for this V1 case
cc @shuyingsunshine21 @ananthsub
Before submitting
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:
Did you have fun?
Make sure you had fun coding 🙃