pytorch/docs/source
Tzu-Wei Huang 98e312cf96 TensorBoard support within PyTorch (#16196)
Summary:
This PR adds TensorBoard logging support natively within PyTorch. It is based on the tensorboardX  code developed by lanpa and relies on changes inside the tensorflow/tensorboard repo landing at https://github.com/tensorflow/tensorboard/pull/2065.

With  these changes users can simply `pip install tensorboard; pip install torch` and then log PyTorch data directly to the TensorBoard protobuf format using

```
import torch
from torch.utils.tensorboard import SummaryWriter
writer = SummaryWriter()
s1 = torch.rand(1)
writer.add_scalar('data/scalar1', s1[0], 0)
writer.close()
```

Design:
- `EventFileWriter` and `RecordWriter` from tensorboardX now live in tensorflow/tensorboard
- `SummaryWriter` and PyTorch-specific conversion from tensors, nn modules, etc. now live in pytorch/pytorch. We also support Caffe2 blobs and nets.

Action items:
- [x] `from torch.utils.tensorboard import SummaryWriter`
- [x] rename functions
- [x] unittests
- [x] move actual writing function to tensorflow/tensorboard in https://github.com/tensorflow/tensorboard/pull/2065

Review:
- Please review for PyTorch standard formatting, code usage, etc.
- Please verify unittest usage is correct and executing in CI

Any significant changes made here will likely be synced back to github.com/lanpa/tensorboardX/ in the future.

cc orionr, ezyang
Pull Request resolved: https://github.com/pytorch/pytorch/pull/16196

Differential Revision: D15062901

Pulled By: orionr

fbshipit-source-id: 3812eb6aa07a2811979c5c7b70810261f9ea169e
2019-04-25 21:30:23 -07:00
..
_static/img upload alias tracker graph for docs (#17476) 2019-02-25 16:58:43 -08:00
_templates Generate sphinx docs with secure content. (#18508) 2019-03-27 11:01:48 -07:00
community Delete duplicated technical content from contribution_guide.rst (#18628) 2019-03-31 19:13:22 -07:00
notes Move cuFFT plan cache note outside Best Practices (#19538) 2019-04-20 21:39:59 -07:00
scripts Add CELU activation to pytorch (#8551) 2018-08-01 07:54:44 -07:00
__config__.rst Add torch.__config__.show(), reporting detailed version of all libraries. (#18579) 2019-04-09 11:13:24 -07:00
autograd.rst Update Tensor doc (#14339) 2018-11-28 15:28:17 -08:00
bottleneck.rst [docs] Clarify more CUDA profiling gotchas in bottleneck docs (#6763) 2018-04-19 13:15:27 -04:00
checkpoint.rst Stashing checkpointing RNG states based on devices of arg tensors (#14518) 2018-12-11 09:48:45 -08:00
conf.py Turn on F401: Unused import warning. (#18598) 2019-03-30 09:01:17 -07:00
cpp_extension.rst Inline JIT C++ Extensions (#7059) 2018-04-30 11:48:44 -04:00
cuda_deterministic_backward.rst Amend nondeterminism notes (#12217) 2018-10-16 23:59:26 -07:00
cuda_deterministic.rst Amend nondeterminism notes (#12217) 2018-10-16 23:59:26 -07:00
cuda.rst Add cuda.reset_max_memory_* (#15985) 2019-01-14 07:31:51 -08:00
cudnn_deterministic.rst Amend nondeterminism notes (#12217) 2018-10-16 23:59:26 -07:00
cudnn_persistent_rnn.rst don't copy weight gradients in rnn (#12600) 2018-10-12 13:34:10 -07:00
data.rst add fold example and add nn.Fold/nn.Unfold and F.fold/F.unfold to doc (#8600) 2018-06-18 09:36:42 -04:00
distributed_deprecated.rst Documentation for c10d: torch.distributed and deprecate the old distributed doc (#11450) 2018-09-11 02:10:28 -07:00
distributed.rst fix typo: pytoch -> pytorch 2019-04-25 06:40:40 -07:00
distributions.rst Typos and broken RSTs fixed in torch.distribution (#16136) 2019-01-23 03:03:10 -08:00
dlpack.rst document torch.utils.dlpack (#9343) 2018-07-11 07:46:09 -07:00
hub.rst fix hub doc formatting issues (#19434) 2019-04-18 16:02:19 -07:00
index.rst TensorBoard support within PyTorch (#16196) 2019-04-25 21:30:23 -07:00
jit.rst Fix bad annotation in docs (#19501) 2019-04-19 12:42:26 -07:00
model_zoo.rst add/move a few apis in torch.hub (#18758) 2019-04-10 23:10:39 -07:00
multiprocessing.rst Implement reference counting for shared IPC CUDA tensors (#16854) 2019-03-25 10:24:38 -07:00
nn.rst Add an identity module (#19249) 2019-04-19 10:12:18 -07:00
onnx.rst Add trigonometry functions to docs/source/onnx.rst 2018-09-12 12:10:01 -07:00
optim.rst fix lint in optim doc 2019-04-04 19:08:13 -07:00
sparse.rst sparse.mm(), reland #14526 (#14661) 2018-12-03 10:39:27 -08:00
storage.rst Start documenting torch.Tensor (#377) 2016-12-30 01:21:34 -05:00
tensor_attributes.rst Fix the error in the note about torch.device documentation. (#16839) 2019-02-09 20:18:58 -08:00
tensorboard.rst TensorBoard support within PyTorch (#16196) 2019-04-25 21:30:23 -07:00
tensors.rst Rename potri to cholesky_inverse (#19498) 2019-04-22 08:18:39 -07:00
torch.rst Rename potri to cholesky_inverse (#19498) 2019-04-22 08:18:39 -07:00
type_info.rst Allow converting char tensor to numpy; add [fi]info.min (#15046) 2018-12-24 09:11:24 -08:00