[DOC] Updated documentation for get_peft_model() for in-place base model modification
#2313
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BenjaminBossan
requested changes
Jan 8, 2025
Member
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for creating this PR to make it very clear in the docs that get_peft_model modifies the base model in place. I made a few suggestions which should hopefully better clarify what's going, please check.
|
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
approved these changes
Jan 9, 2025
Member
BenjaminBossan
left a comment
There was a problem hiding this comment.
Thanks for improving the docs for get_peft_model, this should help avoid confusion in the future.
Failing CI is unrelated, so merging is fine.
Contributor
Author
|
Alright, thanks for merging! |
Guy-Bilitski
pushed a commit
to Guy-Bilitski/peft
that referenced
this pull request
May 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #2295 along with FIX #2306
Updates documentation for
get_peft_model()that the base model will be modified in-place:get_peft_model()docstring