pytorch/torch
Luca Wehrstedt 3e46d6c9e4 Update docs to mention CUDA support for Future (#50048)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/50048

To reflect the many changes introduced recently.

In my mind, CUDAFuture should be considered a "private" subclass, which in practice should always be returned as a downcast pointer to an ivalue::Future. Hence, we should document the CUDA behavior in the superclass, even if it's CUDA-agnostic, since that's the interface the users will see also for CUDA-enabled futures.
ghstack-source-id: 128640983

Test Plan: Built locally and looked at them.

Reviewed By: mrshenli

Differential Revision: D25757474

fbshipit-source-id: c6f66ba88fa6c4fc33601f31136422d6cf147203
2021-05-11 08:26:33 -07:00
..
_C Update docs to mention CUDA support for Future (#50048) 2021-05-11 08:26:33 -07:00
ao [sparsity] Moving the sparsity python files to OSS (#56617) 2021-04-22 14:07:31 -07:00
autograd [kineto] Update Kineto submodule, cupti library paths (#57789) 2021-05-10 19:15:59 -07:00
backends NNAPI: flex size support for upsample_nearest2d op (#57563) 2021-05-05 13:54:43 -07:00
contrib
csrc Use RPC context streams to cover serde ops (#57926) 2021-05-11 07:07:51 -07:00
cuda [1/n][torch/elastic] Move torchelastic docs *.rst (#148) 2021-05-04 00:57:56 -07:00
distributed combine consecutive layes on the same device (#55973) 2021-05-11 08:04:08 -07:00
distributions Deprecate torch.cholesky (#57725) 2021-05-10 22:44:25 -07:00
fft Fix variable names in torch.fft examples (#57290) 2021-05-01 15:56:19 -07:00
for_onnx
futures Update docs to mention CUDA support for Future (#50048) 2021-05-11 08:26:33 -07:00
fx [fx ir] Handle the case when output consumes get_attr directly (#57844) 2021-05-10 22:04:43 -07:00
jit Revert D28117714: [pytorch][PR] ATen lu_unpack. Required for making torch.lu_solve differentiable. 2021-05-09 23:20:06 -07:00
legacy
lib [nccl] log rank when communicator is aborted (#57974) 2021-05-10 21:23:31 -07:00
linalg Alias det, slogdet, matrix_power, inverse, pinverse (#57821) 2021-05-10 22:00:59 -07:00
multiprocessing Fix typo in warning for spawn method (#57927) 2021-05-10 13:12:38 -07:00
nn Deprecate QR (#57745) 2021-05-10 22:56:37 -07:00
onnx Add correction parameter to std/var (#50903) 2021-05-07 14:40:28 -07:00
optim [optim] take kw-only argument for functional optim APIs (#56185) 2021-04-15 20:08:04 -07:00
package [package] fix corner case in PacakgeImporter.whichmodule (#57651) 2021-05-06 14:15:21 -07:00
profiler [kineto] Update Kineto submodule, cupti library paths (#57789) 2021-05-10 19:15:59 -07:00
quantization ns for fx: clean up manual string names of related ops (#57210) 2021-05-05 06:30:32 -07:00
sparse
special [special] Add xlog1py (#55138) 2021-04-30 05:51:13 -07:00
testing Use RPC context streams to cover serde ops (#57926) 2021-05-11 07:07:51 -07:00
utils Add Python-3.9 CI testing (#50992) 2021-05-10 10:51:39 -07:00
__config__.py
__future__.py
__init__.py add deterministic path for index_copy_cpu (#56900) 2021-04-26 16:57:47 -07:00
_appdirs.py
_autograd_functions.py
_classes.py
_deploy.py
_jit_internal.py Support custom Python classes in CUDAFuture (#56516) 2021-04-24 07:06:28 -07:00
_linalg_utils.py Deprecate QR (#57745) 2021-05-10 22:56:37 -07:00
_lobpcg.py Deprecate torch.cholesky (#57725) 2021-05-10 22:44:25 -07:00
_lowrank.py Deprecate QR (#57745) 2021-05-10 22:56:37 -07:00
_namedtensor_internals.py
_ops.py
_python_dispatcher.py
_six.py
_storage_docs.py
_tensor_docs.py Add correction parameter to std/var (#50903) 2021-05-07 14:40:28 -07:00
_tensor_str.py
_tensor.py Update the default detach semantic for forward mode AD (#57820) 2021-05-07 15:51:18 -07:00
_torch_docs.py Deprecate matrix_rank (#57734) 2021-05-10 23:58:46 -07:00
_utils_internal.py
_utils.py
_VF.py
_vmap_internals.py Add note about improved vmap prototype to vmap docstring (#57677) 2021-05-06 06:47:18 -07:00
abi-check.cpp
CMakeLists.txt Fix return type of getDeviceMap (#57487) 2021-05-03 15:01:24 -07:00
custom_class_detail.h
custom_class.h
deploy.h
extension.h
functional.py Deprecate chain_matmul (#57735) 2021-05-11 00:09:36 -07:00
hub.py Add lint for unqualified type: ignore (#56290) 2021-04-21 08:07:23 -07:00
library.h
overrides.py Revert D28117714: [pytorch][PR] ATen lu_unpack. Required for making torch.lu_solve differentiable. 2021-05-09 23:20:06 -07:00
py.typed
quasirandom.py
random.py
README.txt
script.h
serialization.py Ensure torch.save() deterministic output (#57536) 2021-05-10 11:51:55 -07:00
storage.py
types.py Add type annotations to nnapi (#48142) 2021-04-26 19:08:07 -07:00

Note [TH abstraction violation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

TH/THC provide some hpp headers, which are proper C++ headers rather than
C headers.  These headers serve double duty as *internal implementation
detail* headers, whose contents should largely not be used by external
clients.

Ideally, we would not install these headers at all; instead, you should
use public functions (in headers like `THTensor.h`, NOT `THTensor.hpp`)
to manipulate these structs.  However, there are a few places
in torch/csrc where we violate this abstraction.  They are marked with
a pointer to this note.  Each of those sites will have to be refactored
when we refactor the guts of THTensor and related structures.