pytorch/docs/source
Ivan Yashchuk 564456ac44 Added autograd support for torch.orgqr (#52637)
Summary:
This PR adds autograd support for `torch.orgqr`.

Since `torch.orgqr` is one of few functions that expose LAPACK's naming and all other linear algebra routines were renamed a long time ago, I also added a new function with a new name and `torch.orgqr` now is an alias for it.

The new proposed name is `householder_product`. For a matrix `input` and a vector `tau` LAPACK's orgqr operation takes columns of `input` (called Householder vectors or elementary reflectors) scalars of `tau` that together represent Householder matrices and then the product of these matrices is computed. See https://www.netlib.org/lapack/lug/node128.html.
Other linear algebra libraries that I'm aware of do not expose this LAPACK function, so there is some freedom in naming it. It is usually used internally only for QR decomposition, but can be useful for deep learning tasks now when it supports differentiation.

Resolves https://github.com/pytorch/pytorch/issues/50104

Pull Request resolved: https://github.com/pytorch/pytorch/pull/52637

Reviewed By: agolynski

Differential Revision: D27114246

Pulled By: mruberry

fbshipit-source-id: 9ab51efe52aec7c137aa018c7bd486297e4111ce
2021-03-18 05:42:18 -07:00
..
_static Add documentation page for pipeline parallelism. (#50791) 2021-01-25 13:47:13 -08:00
_templates various doc building cleanups (#53851) 2021-03-16 15:01:59 -07:00
community update persons of interest (#45803) 2020-10-05 21:28:00 -07:00
notes Fix inport -> import typo in documentation (#53589) 2021-03-08 23:56:42 -08:00
rpc Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
scripts Optimize SiLU (Swish) op in PyTorch (#42976) 2020-08-16 13:21:57 -07:00
__config__.rst Fix __config__ docs (#48557) 2020-11-29 23:57:06 -08:00
amp.rst Reference amp tutorial (recipe) from core amp docs (#44725) 2020-09-16 11:37:58 -07:00
autograd.rst Update docs feature classifications (#39966) 2020-06-24 15:35:59 -07:00
backends.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
benchmark_utils.rst Expand benchmark utils docs (#51664) 2021-02-04 00:22:41 -08:00
bottleneck.rst
checkpoint.rst
complex_numbers.rst various doc building cleanups (#53851) 2021-03-16 15:01:59 -07:00
conf.py various doc building cleanups (#53851) 2021-03-16 15:01:59 -07:00
cpp_extension.rst correct some cpp extension code usages and documents (#39766) 2020-06-10 08:31:22 -07:00
cpp_index.rst Add C++ Landing Page (#38450) 2020-05-14 16:02:01 -07:00
cuda.rst expose memory_fraction and gpu_process docs (#51372) 2021-01-29 18:22:34 -08:00
cudnn_persistent_rnn.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
cudnn_rnn_determinism.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
data.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
ddp_comm_hooks.rst [Gradient Compression] Introduce fp16_compress_wrapper in ddp_comm_hooks.rst (#54052) 2021-03-16 15:40:10 -07:00
distributed.optim.rst [Reland] Update and expose ZeroRedundancyOptimizer docs (#53112) 2021-03-02 14:16:12 -08:00
distributed.rst [doc] reorg dist init and non-init functions (#52976) 2021-03-12 08:48:18 -08:00
distributions.rst Add sample validation for LKJCholesky.log_prob (#52763) 2021-02-25 16:12:29 -08:00
dlpack.rst
docutils.conf Revert "Revert D21337640: [pytorch][PR] Split up documentation into subpages and clean up some warnings" (#37778) 2020-05-04 14:32:35 -07:00
fft.rst Remove deprecated spectral ops from torch namespace (#48594) 2020-12-05 04:12:32 -08:00
futures.rst [JIT x RPC] Consolidate Future type class and Future impl class (#40406) 2020-06-24 01:44:49 -07:00
fx.rst [FX][docs] Render inherited methods in fx.Tracer API reference (#53630) 2021-03-09 14:30:41 -08:00
hub.rst Add a torch.hub.load_local() function that can load models from any local directory with a hubconf.py (#44204) 2020-09-21 14:17:21 -07:00
index.rst [special] add torch.special namespace (#52296) 2021-03-04 00:04:36 -08:00
jit_builtin_functions.rst Fix builtin function reference (#24056) 2019-08-09 15:58:15 -07:00
jit_language_reference_v2.rst [docs] Add starter content for new TorchScript language reference (#53837) 2021-03-11 18:18:27 -08:00
jit_language_reference.rst add type annotations to torch.nn.modules.conv (#49564) 2021-01-15 11:16:11 -08:00
jit_python_reference.rst [JIT] Add support for with statements (#34705) 2020-06-18 16:57:18 -07:00
jit_unsupported.rst [JIT] Update docs for recently added features (#45232) 2020-09-28 18:17:42 -07:00
jit.rst [docs] Add starter content for new TorchScript language reference (#53837) 2021-03-11 18:18:27 -08:00
linalg.rst Added autograd support for torch.orgqr (#52637) 2021-03-18 05:42:18 -07:00
math-quantizer-equation.png adding quantization.rst file for quantization feature (#27559) 2019-10-09 16:45:09 -07:00
mobile_optimizer.rst Mod lists to neutral+descriptive terms in caffe2/docs (#49803) 2020-12-23 11:37:11 -08:00
model_zoo.rst add/move a few apis in torch.hub (#18758) 2019-04-10 23:10:39 -07:00
multiprocessing.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
name_inference.rst Fixed median nan propagation and implemented nanmedian (#45847) 2020-10-08 11:20:21 -07:00
named_tensor.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
nn.functional.rst Huber loss (#50553) 2021-03-02 17:30:45 -08:00
nn.init.rst Bag of documentation fixes; fix more sphinx warnings (#27850) 2019-10-15 07:31:14 -07:00
nn.rst Parametrization Functionality (#33344) 2021-03-04 12:45:27 -08:00
onnx.rst [ONNX] Update ONNX documentation (#51362) (#53313) 2021-03-12 02:49:38 -08:00
optim.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
pipeline.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
profiler.rst Update docs for torch.profiler.tensorboard_trace_handler (#51636) 2021-02-04 13:32:59 -08:00
quantization-support.rst [quantization] Add some support for 3d operations (#50003) 2021-03-10 16:40:35 -08:00
quantization.rst Fix quantization doc issue (#50187) 2021-02-02 20:33:21 -08:00
random.rst Remove duplicated entries in random.rst (#39725) 2020-06-10 16:51:15 -07:00
rpc.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
sparse.rst [wip] doc_fix (#51825) 2021-02-06 11:36:36 -08:00
special.rst [special] add torch.special namespace (#52296) 2021-03-04 00:04:36 -08:00
storage.rst [docs] Add docs for storage and tensors for quantized Tensor (#51817) 2021-02-09 13:20:56 -08:00
tensor_attributes.rst Fix the repeated entry in the Tensor Attributes doc (#52995) 2021-03-01 16:42:32 -08:00
tensor_view.rst Add torch.swapdims and torch.swapaxes (#46041) 2020-11-18 11:35:53 -08:00
tensorboard.rst Add method add_hparams to API doc (#27344) 2019-10-03 17:07:45 -07:00
tensors.rst Implements cpu_kernel_multiple_outputs and torch.frexp (#51097) 2021-03-15 10:44:32 -07:00
torch.nn.intrinsic.qat.rst [quantization] Add some support for 3d operations (#50003) 2021-03-10 16:40:35 -08:00
torch.nn.intrinsic.quantized.rst DOC: split quantization.rst into smaller pieces (#41321) 2020-07-25 23:59:40 -07:00
torch.nn.intrinsic.rst [quantization] Add some support for 3d operations (#50003) 2021-03-10 16:40:35 -08:00
torch.nn.qat.rst DOC: split quantization.rst into smaller pieces (#41321) 2020-07-25 23:59:40 -07:00
torch.nn.quantized.dynamic.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
torch.nn.quantized.rst [quant] add docs for embedding/embedding_bag (#51770) 2021-02-05 11:43:15 -08:00
torch.overrides.rst Add documentation for torch.overrides submodule. (#48170) 2020-11-30 11:25:31 -08:00
torch.quantization.rst Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
torch.rst Implements cpu_kernel_multiple_outputs and torch.frexp (#51097) 2021-03-15 10:44:32 -07:00
type_info.rst DOC: split quantization.rst into smaller pieces (#41321) 2020-07-25 23:59:40 -07:00