OSSForks/pytorch
1
0
Fork 0
mirror of https://github.com/zebrajr/pytorch.git synced 2025-12-06 12:20:52 +01:00
Code Issues Actions 38 Packages Projects Releases Wiki Activity

docs: clarify alias usage for x parameter in vector_norm function (#136921)

Browse Source 
- Added a note in the documentation specifying that the `input` parameter can be used as an alias for `x`.

Fixes #136560

Pull Request resolved: https://github.com/pytorch/pytorch/pull/136921
Approved by: https://github.com/ezyang

Co-authored-by: Edward Z. Yang <ezyang@meta.com>
This commit is contained in:
Thomas 2024-09-30 02:50:06 +00:00 committed by PyTorch MergeBot
parent 377e4bc877
commit 80393c90b3
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
torch/linalg/__init__.py
View File

@ -1440,7 +1440,8 @@ but it is faster in some cases.
Args: Args:
x (Tensor): tensor, flattened by default, but this behavior can be x (Tensor): tensor, flattened by default, but this behavior can be
controlled using :attr:`dim`. controlled using :attr:`dim`. (Note: the keyword argument
`input` can also be used as an alias for `x`.)
ord (int, float, inf, -inf, 'fro', 'nuc', optional): order of norm. Default: `2` ord (int, float, inf, -inf, 'fro', 'nuc', optional): order of norm. Default: `2`
dim (int, Tuple[int], optional): dimensions over which to compute dim (int, Tuple[int], optional): dimensions over which to compute
the norm. See above for the behavior when :attr:`dim`\ `= None`. the norm. See above for the behavior when :attr:`dim`\ `= None`.