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

DOC Document the PEFT checkpoint format #1717

Merged

Conversation

BenjaminBossan
Copy link
Member

@BenjaminBossan BenjaminBossan commented May 8, 2024

Document the PEFT checkpoint format, with a focus on how to convert to this format.

Link to rendered docs.

This is a bit of a brain dump, so let me know if there is more to add or to remove.

@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
Contributor

@stas00 stas00 left a comment

Choose a reason for hiding this comment

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

Fantastic work, @BenjaminBossan - thank you!

I proposed a few typo fixes

docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
Copy link
Collaborator

@younesbelkada younesbelkada left a comment

Choose a reason for hiding this comment

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

Fantastic work @BenjaminBossan ! Thanks for shipping this !

docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Great work as usual!

My main feedback is mostly about centering the doc on converting to PEFT format rather than to and from other formats, and making things a bit less wordy where appropriate 🙂

docs/source/_toctree.yml Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
docs/source/developer_guides/checkpoint.md Outdated Show resolved Hide resolved
BenjaminBossan and others added 2 commits May 14, 2024 11:12
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@BenjaminBossan BenjaminBossan merged commit 47b3712 into huggingface:main May 14, 2024
1 check passed
@BenjaminBossan BenjaminBossan deleted the doc-peft-checkpoint-format branch May 14, 2024 09:38
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.

None yet

5 participants