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

[Feature] Support save_optimizer=False for DeepSpeed #1474

Merged
merged 1 commit into from
Jan 24, 2024

Conversation

LZHgrla
Copy link
Contributor

@LZHgrla LZHgrla commented Jan 18, 2024

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers. By the way, if you're not familiar with how to use pre-commit to fix lint issues or add unit tests, please refer to Contributing to OpenMMLab.

Motivation

self.model.save_checkpoint saves much more files, including model weights, optimizer states.

  1. By passing save_optimizer=False to default_hooks.CheckpointHook, we can only save weights of DeepSpeed model.
default_hooks = dict(
    # record the time of every iteration.
    timer=dict(type=IterTimerHook),
    # print log every 100 iterations.
    logger=dict(type=LoggerHook, interval=10),
    # enable the parameter scheduler.
    param_scheduler=dict(type=ParamSchedulerHook),
    # save checkpoint per epoch.
-   checkpoint=dict(type=CheckpointHook, interval=1),
+   checkpoint=dict(type=CheckpointHook, save_optimizer=False, interval=1),
    # set sampler seed in distributed evrionment.
    sampler_seed=dict(type=DistSamplerSeedHook),
)
  1. This feature relies on the config of DeepSpeed
    1. stage <= 2, ok!
    2. stage == 3, set zero_optimization.[stage3_gather_16bit_weights_on_model_save/gather_16bit_weights_on_model_save] = True, as https://github.com/InternLM/xtuner/blob/f9dd540344715fac2527b490c259ec11bc6b8ec7/xtuner/configs/deepspeed/deepspeed_zero3.json#L10

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDetection or MMPretrain.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@zhouzaida zhouzaida merged commit cd298e3 into open-mmlab:main Jan 24, 2024
15 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants