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

Enable Unwrapping for Model State Dicts (FSDP) #2959

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

alex-jw-brooks
Copy link
Contributor

What does this PR do?

Fixes #2958

There are more details and a repro case in the issue above - it appears the unwrap args is unused when getting the state dict and running FSDP, which seems to cause shared pointers/tied weights to behave inconsistently.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Thanks! Makes sense to me :)

(Test failures are unrelated)

@muellerzr muellerzr merged commit f35cbd1 into huggingface:main Jul 31, 2024
20 of 25 checks passed
@alex-jw-brooks
Copy link
Contributor Author

Awesome, thank you! 😄

@evkogs
Copy link

evkogs commented Aug 30, 2024

Dude its wrong...

This breaks FSDP

Instead model should be unwraped after FSDP figured out what was the config, like this:

        elif self.distributed_type == DistributedType.FSDP:
            from torch.distributed.fsdp import FullStateDictConfig, StateDictType
            from torch.distributed.fsdp import FullyShardedDataParallel as FSDP

            full_state_dict_config = FullStateDictConfig(offload_to_cpu=True, rank0_only=True)
            with FSDP.state_dict_type(model, StateDictType.FULL_STATE_DICT, full_state_dict_config):

                print(f"using this config: {StateDictType.FULL_STATE_DICT}")

                if unwrap:
                    model = self.unwrap_model(model)

                state_dict = model.state_dict()

Otherwise with FSDP.state_dict_type(model, StateDictType.FULL_STATE_DICT, full_state_dict_config): receive regular torch module and has no idea how to handle it

I think we need to create a new pool request but with more robust testing, I'm still unsure that my fix is correct

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.

get_state_dict() Does Not Unwrap FSDP Models
4 participants