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 example and update deepspeed/FSDP docs #1489

Merged
merged 14 commits into from
Feb 26, 2024
Merged

Conversation

pacman100
Copy link
Contributor

@pacman100 pacman100 commented Feb 20, 2024

What does this PR do?

  1. Add SFT example and update DeepSpeed/FSDP docs.

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

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

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

This is a great guide, thanks a lot Sourab. I already took a look at it, not sure if it's ready for review yet :)

Apart from the comments I left, do you know some common mistakes that are easy to make when using PEFT + DS? Or some PEFT features that won't work when combined with DS (like merging weights)? Maybe those could be added to the troubleshooting section and a link added in this guide.

docs/source/accelerate/deepspeed.md Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Outdated Show resolved Hide resolved
@pacman100 pacman100 changed the title add example and update deepspeed docs add example and update deepspeed/FSDP docs Feb 21, 2024
@BenjaminBossan
Copy link
Member

Let me know once this is ready for another review round.

@pacman100 pacman100 marked this pull request as ready for review February 22, 2024 12:29
Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

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

Thanks a lot for extending the PEFT docs on DeepSpeed and FSDP. Your additions are super good 🔥🔥🔥

Also very nice that you added the example scripts to along with the docs. Some comments on those:

  • Is examples/sft/__init__.py needed? I think it can be deleted.
  • Pretty cool that you also included the multi-GPU and unsloth script. Right now, they are not referenced in the docs. Maybe a short README.md could be added to the folder to explain the individual scripts, just very briefly.

I also added some small comments to the docs, but those are just nits, not blockers. Do we also want to ask Steven for a review?

docs/source/accelerate/fsdp.md Outdated Show resolved Hide resolved
docs/source/accelerate/fsdp.md Outdated Show resolved Hide resolved
docs/source/accelerate/deepspeed.md Show resolved Hide resolved
@pacman100
Copy link
Contributor Author

Pretty cool that you also included the multi-GPU and unsloth script. Right now, they are not referenced in the docs. Maybe a short README.md could be added to the folder to explain the individual scripts, just very briefly.

Done.

@pacman100 pacman100 merged commit aa2ca83 into main Feb 26, 2024
14 checks passed
BenjaminBossan added a commit to BenjaminBossan/peft that referenced this pull request Mar 14, 2024
* add example and update deepspeed docs

* fixes

* fixes and update FSDP docs

* fixes and addressing commentsa

* fixes

* resolve comments

* Apply suggestions from code review

Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>

* address comments

* Update fsdp.md

* Update docs/source/accelerate/fsdp.md

Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>

* addressing comments

* address comments

---------

Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
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.

3 participants