Add docstrings to type validator functions#45700
Closed
dhruv7477 wants to merge 1 commit intohuggingface:mainfrom
Closed
Add docstrings to type validator functions#45700dhruv7477 wants to merge 1 commit intohuggingface:mainfrom
dhruv7477 wants to merge 1 commit intohuggingface:mainfrom
Conversation
Signed-off-by: Dhruv Sharma <dhruv7477@gmail.com>
Member
|
We generally don't want things like code agent docstrings right now, I'm sorry! We might do this ourselves in an agent cleanup pass at some point, but it just creates a lot of reviewer noise at the moment. |
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
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.
Add missing docstrings to the 11 undocumented public functions in
src/transformers/utils/type_validators.py. The existinginterval,probability, andactivation_fn_keyfunctions already had docstrings; this brings the rest of the file up to the same standard.Each docstring follows the Google-style format used elsewhere in the file, listing accepted types and valid values where non-obvious (e.g. the valid keys for
image_size_validator, the accepted device names fordevice_validator, the nested structure accepted byvideo_metadata_validator).No logic changes.