Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding more docs for torch.* functions #430

Closed
wants to merge 1 commit into from
Closed

adding more docs for torch.* functions #430

wants to merge 1 commit into from

Conversation

soumith
Copy link
Member

@soumith soumith commented Jan 11, 2017

now only the following are left:

  • ones, zeros, rand, randn
  • scatter
  • multinomial, normal
  • unfold
  • symeig
  • geqrf
  • ger
  • gesv
  • inverse
  • orgqr
  • ormqr
  • potrf
  • potri
  • potrs
  • pstrf
  • qr
  • svd
  • trtrs

Copy link
Contributor

@apaszke apaszke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you wrap the strings around ~80th column? Otherwise they're going to wrap in the middle of a word when printed in the interpreter.

add_docstr(torch._C.reshape,
"""
Returns a Tensor where each sub-tensor of :attr:`input` along dimension :attr:`dim`
is normalized such that the `p`-norm of the sub-tensor is lower than the value :attr:`maxnorm`

This comment was marked as off-topic.

If `input` is of shape: :math:`(A x 1 x B)`, `squeeze(input, 0)` leaves the Tensor unchanged,
but `squeeze(input, 1)` will squeeze the tensor to the shape :math:`(A x B)`.

.. note:: The returned Tensor shares the storage with the input Tensor,

This comment was marked as off-topic.

This comment was marked as off-topic.

@@ -1833,6 +1946,48 @@

add_docstr(torch._C.masked_select,
"""
index_select(input, mask, out=None) -> Tensor

This comment was marked as off-topic.

@@ -2935,6 +3167,39 @@

add_docstr(torch._C.squeeze,
"""
squeeze(input, dim=None, out=None)

Returns a `Tensor` with all the dimensions of :attr:`input` of size `1`.

This comment was marked as off-topic.

@soumith
Copy link
Member Author

soumith commented Jan 11, 2017

made changes requested and pushed to master.

@soumith soumith closed this Jan 11, 2017
@soumith soumith deleted the moredocs branch January 21, 2017 19:43
colesbury pushed a commit to colesbury/pytorch that referenced this pull request Feb 9, 2017
cuda implementation of Gated Linear Unit, fixed issues with genericization
Krovatkin pushed a commit to Krovatkin/pytorch that referenced this pull request Nov 4, 2020
Add bcast flags to BroadcastOp
KyleCZH pushed a commit to KyleCZH/pytorch that referenced this pull request Sep 20, 2021
eellison pushed a commit to eellison/pytorch that referenced this pull request Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants