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

[docs] Concept guides #1269

Merged
merged 6 commits into from
Dec 20, 2023
Merged

[docs] Concept guides #1269

merged 6 commits into from
Dec 20, 2023

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented Dec 15, 2023

This PR focuses on updating the concept guides with additional PEFT methods. Among other things, it also:

  • reorganizes the concept guides into broader categories like "Reparametrization" (to include LoHa, LoKr, OFT, and AdaLoRA) and "Soft prompts"
  • adds a separate developer guide for using LoRA because some of the content in the LoRA concept guide is instructional; expands a bit more on the LoRA utility methods

todo:

  • add multitask prompt tuning
  • add Llama-Adapter

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

@BenjaminBossan
Copy link
Member

@stevhliu Let us know when this is ready for review.

@stevhliu stevhliu marked this pull request as ready for review December 18, 2023 18:15
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 so much for this work, this must have been a lot of effort and it fills a big gap we currently have in the docs.

I made a couple of suggestions, please check if they make sense to you.


-->

# Adapters
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we could cause confusion here. We use the name "adapter" pretty liberally throughout PEFT for all kinds of methods. Users may, e.g., pass an adapter_name to a LoRA model. This section makes it seem that LLaMA adapter is the the only "adapter" method in PEFT.

Honestly, I'm not sure how to correctly categorize this method, there is no clear taxonomy of adapter/tuner methods :-/ But I'd rather combine this with lora.md and call all of them adapter, as "reparametrization" is not a name I have seen used colloquially for these methods.

Copy link
Member Author

Choose a reason for hiding this comment

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

I was struggling a bit with the taxonomy of it all as well, but I think your approach is better for avoiding confusion! 👍

docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/lora.md Outdated Show resolved Hide resolved
docs/source/conceptual_guides/prompting.md Outdated Show resolved Hide resolved
Copy link
Contributor

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

Impressive work @stevhliu ! Thanks very much for all your hardwork on this!
I left one tiny suggestion, what do you think?

docs/source/conceptual_guides/adapter.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pacman100 pacman100 left a comment

Choose a reason for hiding this comment

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

Wow! Thank you @stevhliu for updating the docs with overview of all the methods, usage of the features and pointers to the related resources! 🤩🚀✨

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.

Looks great, thanks for the updates.

Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
@stevhliu stevhliu merged commit 1c9679a into huggingface:main Dec 20, 2023
14 checks passed
@stevhliu stevhliu deleted the concept-guides branch December 20, 2023 18:56
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.

5 participants