Skip to content

Commit 327a079

Browse files
colesburysoumith
authored andcommitted
Add missing parameters to tensor docs (pytorch#2541)
1 parent 50129be commit 327a079

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

torch/_tensor_docs.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ def add_docstr_all(method, docstr):
725725

726726
add_docstr_all('kthvalue',
727727
"""
728-
kthvalue(k, dim=None) -> (Tensor, LongTensor)
728+
kthvalue(k, dim=None, keepdim=False) -> (Tensor, LongTensor)
729729
730730
See :func:`torch.kthvalue`
731731
""")
@@ -867,28 +867,28 @@ def callable(a, b) -> number
867867

868868
add_docstr_all('max',
869869
"""
870-
max(dim=None) -> float or (Tensor, Tensor)
870+
max(dim=None, keepdim=False) -> float or (Tensor, Tensor)
871871
872872
See :func:`torch.max`
873873
""")
874874

875875
add_docstr_all('mean',
876876
"""
877-
mean(dim=None) -> float or (Tensor, Tensor)
877+
mean(dim=None, keepdim=False) -> float or (Tensor, Tensor)
878878
879879
See :func:`torch.mean`
880880
""")
881881

882882
add_docstr_all('median',
883883
"""
884-
median(dim=-1, values=None, indices=None) -> (Tensor, LongTensor)
884+
median(dim=None, keepdim=False) -> (Tensor, LongTensor)
885885
886886
See :func:`torch.median`
887887
""")
888888

889889
add_docstr_all('min',
890890
"""
891-
min(dim=None) -> float or (Tensor, Tensor)
891+
min(dim=None, keepdim=False) -> float or (Tensor, Tensor)
892892
893893
See :func:`torch.min`
894894
""")
@@ -902,7 +902,7 @@ def callable(a, b) -> number
902902

903903
add_docstr_all('mode',
904904
"""
905-
mode(dim=-1, values=None, indices=None) -> (Tensor, LongTensor)
905+
mode(dim=None, keepdim=False) -> (Tensor, LongTensor)
906906
907907
See :func:`torch.mode`
908908
""")
@@ -1012,7 +1012,7 @@ def callable(a, b) -> number
10121012

10131013
add_docstr_all('norm',
10141014
"""
1015-
norm(p=2) -> float
1015+
norm(p=2, dim=None, keepdim=False) -> float
10161016
10171017
See :func:`torch.norm`
10181018
""")
@@ -1092,7 +1092,7 @@ def callable(a, b) -> number
10921092

10931093
add_docstr_all('prod',
10941094
"""
1095-
prod() -> float
1095+
prod(dim=None, keepdim=False) -> float
10961096
10971097
See :func:`torch.prod`
10981098
""")
@@ -1408,7 +1408,7 @@ def callable(a, b) -> number
14081408

14091409
add_docstr_all('std',
14101410
"""
1411-
std() -> float
1411+
std(dim=None, unbiased=True, keepdim=False) -> float
14121412
14131413
See :func:`torch.std`
14141414
""")
@@ -1465,7 +1465,7 @@ def callable(a, b) -> number
14651465

14661466
add_docstr_all('sum',
14671467
"""
1468-
sum(dim=None) -> float
1468+
sum(dim=None, keepdim=False) -> float
14691469
14701470
See :func:`torch.sum`
14711471
""")
@@ -1682,7 +1682,7 @@ def callable(a, b) -> number
16821682

16831683
add_docstr_all('var',
16841684
"""
1685-
var() -> float
1685+
var(dim=None, unbiased=True, keepdim=False) -> float
16861686
16871687
See :func:`torch.var`
16881688
""")

0 commit comments

Comments
 (0)