docs(operations): add missing docstrings to predicate utility functions#4095
Open
RavSinghChandan wants to merge 1 commit into
Open
docs(operations): add missing docstrings to predicate utility functions#4095RavSinghChandan wants to merge 1 commit into
RavSinghChandan wants to merge 1 commit into
Conversation
Add Args/Returns docstrings to is_torch_tensor, is_torch_xpu_tensor, is_tensor_information
RavSinghChandan
force-pushed
the
docs/add-missing-docstrings-operations
branch
from
39a35a8 to
3517d9e
Compare
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
1 participant
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.
Summary
Three small public predicate functions in
src/accelerate/utils/operations.pyhad no docstrings, making their purpose, expected input type, and return value invisible to IDE tooling and contributors:is_torch_tensorArgs+Returnsis_torch_xpu_tensorArgs+Returns(lists all 7 XPU tensor types checked)is_tensor_informationArgs+ReturnsThe docstring style follows the existing pattern used throughout
operations.py(e.g.is_namedtuple,honor_type,recursively_apply).No logic changes
Documentation only — no behaviour was modified.
CI
ruff check(with project config) ✅ruff format --check✅