mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 12:21:27 +01:00
d3f98b5ffc
Summary: vishwakftw Your patch needed some updates because the default native function dispatches changed from `[function, method]` to `[function]`. The CI was run before that change happened so it still shows green, but the internal test caught it. I did some changes when rebasing and updating so I didn't just force push to your branch. Let's see if this passes CI and internal test. If it does, let me know if you want me to force push to your branch or use this PR instead. Note to reviewers: patch was already approved at #10068 . cc yf225 Pull Request resolved: https://github.com/pytorch/pytorch/pull/11421 Differential Revision: D9733407 Pulled By: SsnL fbshipit-source-id: cf2ed293bb9942dcc5158934ff4def2f63252599
318 lines
7.7 KiB
ReStructuredText
318 lines
7.7 KiB
ReStructuredText
torch
|
|
===================================
|
|
.. automodule:: torch
|
|
|
|
Tensors
|
|
----------------------------------
|
|
.. autofunction:: is_tensor
|
|
.. autofunction:: is_storage
|
|
.. autofunction:: set_default_dtype
|
|
.. autofunction:: get_default_dtype
|
|
.. autofunction:: set_default_tensor_type
|
|
.. autofunction:: numel
|
|
.. autofunction:: set_printoptions
|
|
.. autofunction:: set_flush_denormal
|
|
|
|
.. _tensor-creation-ops:
|
|
|
|
Creation Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. note::
|
|
Random sampling creation ops are listed under :ref:`random-sampling` and
|
|
include:
|
|
:func:`torch.rand`
|
|
:func:`torch.rand_like`
|
|
:func:`torch.randn`
|
|
:func:`torch.randn_like`
|
|
:func:`torch.randint`
|
|
:func:`torch.randint_like`
|
|
:func:`torch.randperm`
|
|
You may also use :func:`torch.empty` with the :ref:`inplace-random-sampling`
|
|
methods to create :class:`torch.Tensor` s with values sampled from a broader
|
|
range of distributions.
|
|
|
|
.. autofunction:: tensor
|
|
.. autofunction:: sparse_coo_tensor
|
|
.. autofunction:: as_tensor
|
|
.. autofunction:: from_numpy
|
|
.. autofunction:: zeros
|
|
.. autofunction:: zeros_like
|
|
.. autofunction:: ones
|
|
.. autofunction:: ones_like
|
|
.. autofunction:: arange
|
|
.. autofunction:: range
|
|
.. autofunction:: linspace
|
|
.. autofunction:: logspace
|
|
.. autofunction:: eye
|
|
.. autofunction:: empty
|
|
.. autofunction:: empty_like
|
|
.. autofunction:: full
|
|
.. autofunction:: full_like
|
|
|
|
Indexing, Slicing, Joining, Mutating Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autofunction:: cat
|
|
.. autofunction:: chunk
|
|
.. autofunction:: gather
|
|
.. autofunction:: index_select
|
|
.. autofunction:: masked_select
|
|
.. autofunction:: narrow
|
|
.. autofunction:: nonzero
|
|
.. autofunction:: reshape
|
|
.. autofunction:: split
|
|
.. autofunction:: squeeze
|
|
.. autofunction:: stack
|
|
.. autofunction:: t
|
|
.. autofunction:: take
|
|
.. autofunction:: transpose
|
|
.. autofunction:: unbind
|
|
.. autofunction:: unsqueeze
|
|
.. autofunction:: where
|
|
|
|
.. _random-sampling:
|
|
|
|
Random sampling
|
|
----------------------------------
|
|
.. autofunction:: manual_seed
|
|
.. autofunction:: initial_seed
|
|
.. autofunction:: get_rng_state
|
|
.. autofunction:: set_rng_state
|
|
.. autodata:: default_generator
|
|
.. autofunction:: bernoulli
|
|
.. autofunction:: multinomial
|
|
.. autofunction:: normal
|
|
.. autofunction:: rand
|
|
.. autofunction:: rand_like
|
|
.. autofunction:: randint
|
|
.. autofunction:: randint_like
|
|
.. autofunction:: randn
|
|
.. autofunction:: randn_like
|
|
.. autofunction:: randperm
|
|
|
|
.. _inplace-random-sampling:
|
|
|
|
In-place random sampling
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
There are a few more in-place random sampling functions defined on Tensors as well. Click through to refer to their documentation:
|
|
|
|
- :func:`torch.Tensor.bernoulli_` - in-place version of :func:`torch.bernoulli`
|
|
- :func:`torch.Tensor.cauchy_` - numbers drawn from the Cauchy distribution
|
|
- :func:`torch.Tensor.exponential_` - numbers drawn from the exponential distribution
|
|
- :func:`torch.Tensor.geometric_` - elements drawn from the geometric distribution
|
|
- :func:`torch.Tensor.log_normal_` - samples from the log-normal distribution
|
|
- :func:`torch.Tensor.normal_` - in-place version of :func:`torch.normal`
|
|
- :func:`torch.Tensor.random_` - numbers sampled from the discrete uniform distribution
|
|
- :func:`torch.Tensor.uniform_` - numbers sampled from the continuous uniform distribution
|
|
|
|
|
|
Serialization
|
|
----------------------------------
|
|
.. autofunction:: save
|
|
.. autofunction:: load
|
|
|
|
|
|
Parallelism
|
|
----------------------------------
|
|
.. autofunction:: get_num_threads
|
|
.. autofunction:: set_num_threads
|
|
|
|
Locally disabling gradient computation
|
|
--------------------------------------
|
|
The context managers :func:`torch.no_grad`, :func:`torch.enable_grad`, and
|
|
:func:`torch.set_grad_enabled` are helpful for locally disabling and enabling
|
|
gradient computation. See :ref:`locally-disable-grad` for more details on
|
|
their usage.
|
|
|
|
Examples::
|
|
|
|
>>> x = torch.zeros(1, requires_grad=True)
|
|
>>> with torch.no_grad():
|
|
... y = x * 2
|
|
>>> y.requires_grad
|
|
False
|
|
|
|
>>> is_train = False
|
|
>>> with torch.set_grad_enabled(is_train):
|
|
... y = x * 2
|
|
>>> y.requires_grad
|
|
False
|
|
|
|
>>> torch.set_grad_enabled(True) # this can also be used as a function
|
|
>>> y = x * 2
|
|
>>> y.requires_grad
|
|
True
|
|
|
|
>>> torch.set_grad_enabled(False)
|
|
>>> y = x * 2
|
|
>>> y.requires_grad
|
|
False
|
|
|
|
|
|
Math operations
|
|
----------------------------------
|
|
|
|
Pointwise Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autofunction:: abs
|
|
.. autofunction:: acos
|
|
.. autofunction:: add
|
|
.. autofunction:: addcdiv
|
|
.. autofunction:: addcmul
|
|
.. autofunction:: asin
|
|
.. autofunction:: atan
|
|
.. autofunction:: atan2
|
|
.. autofunction:: ceil
|
|
.. autofunction:: clamp
|
|
.. autofunction:: cos
|
|
.. autofunction:: cosh
|
|
.. autofunction:: div
|
|
.. autofunction:: digamma
|
|
.. autofunction:: erf
|
|
.. autofunction:: erfc
|
|
.. autofunction:: erfinv
|
|
.. autofunction:: exp
|
|
.. autofunction:: expm1
|
|
.. autofunction:: floor
|
|
.. autofunction:: fmod
|
|
.. autofunction:: frac
|
|
.. autofunction:: lerp
|
|
.. autofunction:: log
|
|
.. autofunction:: log10
|
|
.. autofunction:: log1p
|
|
.. autofunction:: log2
|
|
.. autofunction:: mul
|
|
.. autofunction:: mvlgamma
|
|
.. autofunction:: neg
|
|
.. autofunction:: pow
|
|
.. autofunction:: reciprocal
|
|
.. autofunction:: remainder
|
|
.. autofunction:: round
|
|
.. autofunction:: rsqrt
|
|
.. autofunction:: sigmoid
|
|
.. autofunction:: sign
|
|
.. autofunction:: sin
|
|
.. autofunction:: sinh
|
|
.. autofunction:: sqrt
|
|
.. autofunction:: tan
|
|
.. autofunction:: tanh
|
|
.. autofunction:: trunc
|
|
|
|
|
|
Reduction Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autofunction:: argmax
|
|
.. autofunction:: argmin
|
|
.. autofunction:: cumprod
|
|
.. autofunction:: cumsum
|
|
.. autofunction:: dist
|
|
.. autofunction:: logsumexp
|
|
.. autofunction:: mean
|
|
.. autofunction:: median
|
|
.. autofunction:: mode
|
|
.. autofunction:: norm
|
|
.. autofunction:: prod
|
|
.. autofunction:: std
|
|
.. autofunction:: sum
|
|
.. autofunction:: unique
|
|
.. autofunction:: var
|
|
|
|
|
|
Comparison Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autofunction:: allclose
|
|
.. autofunction:: eq
|
|
.. autofunction:: equal
|
|
.. autofunction:: ge
|
|
.. autofunction:: gt
|
|
.. autofunction:: isfinite
|
|
.. autofunction:: isinf
|
|
.. autofunction:: isnan
|
|
.. autofunction:: kthvalue
|
|
.. autofunction:: le
|
|
.. autofunction:: lt
|
|
.. autofunction:: max
|
|
.. autofunction:: min
|
|
.. autofunction:: ne
|
|
.. autofunction:: sort
|
|
.. autofunction:: topk
|
|
|
|
|
|
Spectral Ops
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autofunction:: fft
|
|
.. autofunction:: ifft
|
|
.. autofunction:: rfft
|
|
.. autofunction:: irfft
|
|
.. autofunction:: stft
|
|
.. autofunction:: bartlett_window
|
|
.. autofunction:: blackman_window
|
|
.. autofunction:: hamming_window
|
|
.. autofunction:: hann_window
|
|
|
|
|
|
Other Operations
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autofunction:: bincount
|
|
.. autofunction:: cross
|
|
.. autofunction:: diag
|
|
.. autofunction:: diagflat
|
|
.. autofunction:: diagonal
|
|
.. autofunction:: einsum
|
|
.. autofunction:: flatten
|
|
.. autofunction:: flip
|
|
.. autofunction:: histc
|
|
.. autofunction:: meshgrid
|
|
.. autofunction:: renorm
|
|
.. autofunction:: tensordot
|
|
.. autofunction:: trace
|
|
.. autofunction:: tril
|
|
.. autofunction:: triu
|
|
|
|
|
|
BLAS and LAPACK Operations
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autofunction:: addbmm
|
|
.. autofunction:: addmm
|
|
.. autofunction:: addmv
|
|
.. autofunction:: addr
|
|
.. autofunction:: baddbmm
|
|
.. autofunction:: bmm
|
|
.. autofunction:: btrifact
|
|
.. autofunction:: btrifact_with_info
|
|
.. autofunction:: btrisolve
|
|
.. autofunction:: btriunpack
|
|
.. autofunction:: dot
|
|
.. autofunction:: eig
|
|
.. autofunction:: gels
|
|
.. autofunction:: geqrf
|
|
.. autofunction:: ger
|
|
.. autofunction:: gesv
|
|
.. autofunction:: inverse
|
|
.. autofunction:: det
|
|
.. autofunction:: logdet
|
|
.. autofunction:: slogdet
|
|
.. autofunction:: matmul
|
|
.. autofunction:: matrix_power
|
|
.. autofunction:: matrix_rank
|
|
.. autofunction:: mm
|
|
.. autofunction:: mv
|
|
.. autofunction:: orgqr
|
|
.. autofunction:: ormqr
|
|
.. autofunction:: pinverse
|
|
.. autofunction:: potrf
|
|
.. autofunction:: potri
|
|
.. autofunction:: potrs
|
|
.. autofunction:: pstrf
|
|
.. autofunction:: qr
|
|
.. autofunction:: svd
|
|
.. autofunction:: symeig
|
|
.. autofunction:: trtrs
|
|
|
|
Utilities
|
|
----------------------------------
|
|
.. autofunction:: compiled_with_cxx11_abi
|