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 metadata format to save_file in FullModelHFCheckpointer #1126

Merged
merged 2 commits into from
Jun 27, 2024

Conversation

man-shar
Copy link
Contributor

@man-shar man-shar commented Jun 26, 2024

AutoModel.xx classes from hf's transformers do not work otherwise, and we get an error because the metadata is None while loading the model here: https:/huggingface/transformers/blob/main/src/transformers/modeling_utils.py#L518-L522

That said, I only have very basic knowledge of this so might be wrong here. I personally had to re-save the model files with metadata added for them to work with AutoModel... classes.

Context

What is the purpose of this PR? Is it to

  • [x ] add a new feature
  • [x ] fix a bug (ish??)
  • update tests and/or documentation
  • other (please add here)

Please link to any issues this PR addresses.

Changelog

Adds pt metadata while saving safetensors in FullModelHFCheckpointer.

Test plan

Let me know if I have to do any of these? Also how 😅 ?

Please make sure to do each of the following if applicable to your PR. (If you're not sure about any one of these just ask and we will happily help.)

  • run pre-commit hooks and linters (make sure you've first installed via pre-commit install)
  • add unit tests for any new functionality
  • update docstrings for any new or updated methods or classes
  • run unit tests via pytest tests
  • run recipe tests via pytest tests -m integration_test
  • manually run any new or modified recipes with sufficient proof of correctness
    • include relevant commands and any other artifacts in this summary (pastes of loss curves, eval results, etc.)

`AutoModel.xx` classes from hf's transformers do not work otherwise, and an error because the metadata is `None` here: https:/huggingface/transformers/blob/main/src/transformers/modeling_utils.py#L518-L522

That said, I only have very basic knowledge of this so might be wrong here. I personally had to re-save the model files with metadata added for them to work with `AutoModel...` classes.
Copy link

pytorch-bot bot commented Jun 26, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1126

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 3193d14 with merge base 52e3283 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot
Copy link

Hi @man-shar!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 26, 2024
@joecummings
Copy link
Contributor

Hi @man-shar! Thanks for this super helpful PR - once you run the linting, we can get this merged.

pre-commit install and pre-commit run --all-files should work.

@man-shar
Copy link
Contributor Author

thank you! just ran the linter and updated.

@joecummings joecummings merged commit 88d172f into pytorch:main Jun 27, 2024
29 checks passed
maximegmd pushed a commit to maximegmd/torchtune that referenced this pull request Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants