DOC: Update & improve docstrings and type annotations for common methods and classes #1201
Conversation
This file contains 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
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.
stevhliu
approved these changes
Nov 30, 2023
Co-authored-by: Steven Liu <[email protected]>
younesbelkada
approved these changes
Dec 4, 2023
Co-authored-by: Younes Belkada <[email protected]>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
BenjaminBossan
deleted the
doc-improve-docstrings-and-type-annotations
branch
10 tasks
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 <[email protected]> Co-authored-by: Younes Belkada <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.