Skip to content

DOC: Update & improve docstrings and type annotations for common methods and classes#1201

Merged
BenjaminBossan merged 8 commits into
huggingface:mainfrom
BenjaminBossan:doc-improve-docstrings-and-type-annotations
Dec 4, 2023
Merged

DOC: Update & improve docstrings and type annotations for common methods and classes#1201
BenjaminBossan merged 8 commits into
huggingface:mainfrom
BenjaminBossan:doc-improve-docstrings-and-type-annotations

Conversation

@BenjaminBossan
Copy link
Copy Markdown
Member

The docstrings of the most user-exposed methods and classes have been updated, or added if not already present. Furthermore, type annotations have been updated or added for those methods and classes.

The docstrings of the most user-exposed methods and classes have been
updated, or added if not already present. Furthermore, type annotations
have been updated or added for those methods and classes.
Copy link
Copy Markdown
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.

Thanks for cleaning these up (most of my suggestions are just minor formatting nits)! ❤️

Comment thread src/peft/peft_model.py Outdated
Comment thread src/peft/peft_model.py Outdated
Comment thread src/peft/peft_model.py Outdated
Comment thread src/peft/peft_model.py Outdated
Comment thread src/peft/tuners/lycoris_utils.py Outdated
Comment thread src/peft/tuners/oft/layer.py Outdated
Comment thread src/peft/tuners/oft/layer.py Outdated
Comment thread src/peft/tuners/tuners_utils.py Outdated
Comment thread src/peft/tuners/tuners_utils.py Outdated
Comment thread src/peft/tuners/tuners_utils.py Outdated
BenjaminBossan and others added 2 commits December 1, 2023 11:55
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Copy link
Copy Markdown
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.

Thanks for the great clean up!

Comment thread src/peft/peft_model.py Outdated
Comment thread src/peft/tuners/tuners_utils.py Outdated
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@BenjaminBossan BenjaminBossan merged commit c456d55 into huggingface:main Dec 4, 2023
@BenjaminBossan BenjaminBossan deleted the doc-improve-docstrings-and-type-annotations branch December 4, 2023 11:22
TaoSunVoyage pushed a commit to TaoSunVoyage/peft that referenced this pull request Dec 14, 2023
…ods and classes (huggingface#1201)

The docstrings of the most user-exposed methods and classes have been
updated, or added if not already present. Furthermore, type annotations
have been updated or added for those methods and classes.

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Guy-Bilitski pushed a commit to Guy-Bilitski/peft that referenced this pull request May 13, 2025
…ods and classes (huggingface#1201)

The docstrings of the most user-exposed methods and classes have been
updated, or added if not already present. Furthermore, type annotations
have been updated or added for those methods and classes.

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
cyyever pushed a commit to cyyever/peft that referenced this pull request Sep 4, 2025
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.

4 participants