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

Add learning rate scheduling support for DeepSpeedStrategy #20320

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

amorehead
Copy link
Contributor

@amorehead amorehead commented Oct 5, 2024

What does this PR do?

  • Adds learning rate scheduling support for DeepSpeedStrategy
  • Credit to lvhoaa for suggesting this change to make Fabric's support for internal DeepSpeed features even more robust
Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs) N
  • x ] 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 list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

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

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--20320.org.readthedocs.build/en/20320/

@github-actions github-actions bot added the fabric lightning.fabric.Fabric label Oct 5, 2024
@lantiga
Copy link
Collaborator

lantiga commented Oct 7, 2024

Thanks for the contribution @amorehead! Let's get to a green CI and take it from there

@lantiga
Copy link
Collaborator

lantiga commented Nov 12, 2024

hey @amorehead looks like CI failures are legit, let me know if you can fix those

@lantiga lantiga added the waiting on author Waiting on user action, correction, or update label Nov 12, 2024
@mergify mergify bot removed the has conflicts label Nov 25, 2024
src/lightning/fabric/strategies/deepspeed.py Outdated Show resolved Hide resolved
src/lightning/fabric/strategies/fsdp.py Outdated Show resolved Hide resolved
src/lightning/fabric/strategies/strategy.py Outdated Show resolved Hide resolved
src/lightning/fabric/strategies/xla_fsdp.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@lantiga lantiga left a comment

Choose a reason for hiding this comment

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

Thank you @amorehead! I added a few comments. Essentially we need to turn this into a non-breaking change.

Also a small update to docs is needed.


Currently, only a single optimizer is supported.
self, module: Module, optimizers: list[Optimizer], scheduler: Optional[_LRScheduler] = None
) -> tuple["DeepSpeedEngine", list[Optimizer], Optional[_LRScheduler]]:
Copy link
Collaborator

Choose a reason for hiding this comment

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

This will return None, we need to return Any here so we can ignore the scheduler if it is not provided in input.

@@ -266,7 +269,7 @@ def setup(

if optimizers:
# join both types in a tuple for API convenience
return (module, *optimizers)
return (module, *optimizers, scheduler)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a breaking change, it will cause existing user code to fail, because scheduler is returned unconditionally.

Since scheduler is Optional in the signature, I suggest we only return it if it was not None as an argument, so we won't break anyone's code.

optimizer: Optional[Optimizer] = None,
) -> tuple["DeepSpeedEngine", Optimizer]:
self, model: Module, optimizer: Optional[Optimizer] = None, scheduler: Optional[_LRScheduler] = None
) -> tuple["DeepSpeedEngine", Optimizer, Optional[_LRScheduler]]:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment as above

@@ -104,7 +104,10 @@ def pl_worker_init_function(worker_id: int, rank: Optional[int] = None) -> None:
if _NUMPY_AVAILABLE:
import numpy as np

np.random.seed(seed_sequence[3] & 0xFFFFFFFF) # numpy takes 32-bit seed only
ss = np.random.SeedSequence([base_seed, worker_id, global_rank])
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is an unrelated change, it shouldn't be included

@lantiga
Copy link
Collaborator

lantiga commented Dec 10, 2024

@amorehead I'm wrapping up the last few PRs for the release. Do you have time to fix this one in the next couple of days?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fabric lightning.fabric.Fabric strategy: deepspeed waiting on author Waiting on user action, correction, or update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants