Document inplace_on_inputs method and remove TODO comment #1575
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.
This PR addresses the documentation of the
inplace_on_inputs
method as requested in the issue. The method allowsOp
classes to create inplace versions of themselves for specified inputs, enabling memory optimizations while maintaining correctness.Changes Made
pytensor/graph/op.py
in theinplace_on_inputs
method definitiondoc/extending/inplace.rst
explaining theinplace_on_inputs
methodDocumentation Added
The new documentation section explains:
The method signature and expected behavior are clearly documented:
This method is automatically used by PyTensor's optimization pipeline and is crucial for the efficient memory management in Blockwise operations. The documentation makes it clear that users typically don't need to call this method directly, but Op developers should understand how to implement it properly.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.