Edward Yang
4fef3763dd
Revert "Revert D21337640: [pytorch][PR] Split up documentation into subpages and clean up some warnings" ( #37778 )
...
Summary:
Original PR: https://github.com/pytorch/pytorch/pull/37419
cc mattip suo
Pull Request resolved: https://github.com/pytorch/pytorch/pull/37778
Differential Revision: D21385774
Pulled By: ezyang
fbshipit-source-id: 5de532faab8bae132736b6b5189e0ee2ac9935be
2020-05-04 14:32:35 -07:00
Michael Suo
20f7e62b1d
Revert D21337640: [pytorch][PR] Split up documentation into subpages and clean up some warnings
...
Test Plan: revert-hammer
Differential Revision:
D21337640
Original commit changeset: d4ad198780c3
fbshipit-source-id: fa9ba6ac542173a50bdb45bfa12f3fec0ed704fb
2020-05-04 10:57:55 -07:00
mattip
f10fbcc820
Split up documentation into subpages and clean up some warnings ( #37419 )
...
Summary:
xref gh-32838, gh-34032
This is a major refactor of parts of the documentation to split it up using sphinx's `autosummary` feature which will build out `autofuction` and `autoclass` stub files and link to them. The end result is that the top module pages like torch.nn.rst and torch.rst are now more like table-of-contents to the actual single-class or single-function documentations pages.
Along the way, I modified many of the docstrings to eliminate sphinx warnings when building. I think the only thing I changed from a non-documentation perspective is to add names to `__all__` when adding them to `globals()` in `torch.__init__.py`
I do not know the CI system: are the documentation build artifacts available after the build, so reviewers can preview before merging?
Pull Request resolved: https://github.com/pytorch/pytorch/pull/37419
Differential Revision: D21337640
Pulled By: ezyang
fbshipit-source-id: d4ad198780c3ae7a96a9f22651e00ff2d31a0c0f
2020-05-04 09:39:22 -07:00
Peter Bell
bd0ef784e0
FAQ: Add note about recovering from OOM ( #35214 )
...
Summary:
Closes https://github.com/pytorch/pytorch/issues/18853
This documents the workaround needed to solve the issues in https://github.com/pytorch/pytorch/issues/18853
Pull Request resolved: https://github.com/pytorch/pytorch/pull/35214
Differential Revision: D20604877
Pulled By: ezyang
fbshipit-source-id: 71ed13cfa567d8e88fa9f18180a171cd174fb528
2020-03-23 20:22:46 -07:00
Sergii Dymchenko
a5c90aaf47
Use "length of the RNN input" instead of "length of the RNN"
...
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/20873
Differential Revision: D15495570
Pulled By: ezyang
fbshipit-source-id: e3b4cd67ccf97d0053ac053c3bcb74415b928c0a
2019-05-24 09:03:50 -07:00
Tongzhou Wang
b6313d74e1
fix faq typo
...
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/17851
Differential Revision: D14401791
Pulled By: soumith
fbshipit-source-id: ed6d64d6f5985e7ce76dca1e9e376782736b90f9
2019-03-10 15:33:52 -07:00
Tongzhou Wang
c30790797f
Minor data loader doc improvements
...
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/11821
Differential Revision: D9948292
Pulled By: SsnL
fbshipit-source-id: 01c21c129423c0f7844b403e665a8fe021a9c820
2018-09-19 15:33:25 -07:00
Tongzhou Wang
6b7ec95abb
Link relevant FAQ section in DataLoader docs ( #6476 )
...
* Link FAQ section on workers returning same random numbers in DataLoader docs
* explicitly mention section names
2018-04-11 13:41:46 -04:00
Tongzhou Wang
4d15442ebc
Add total_length option to pad_packed_sequence ( #6327 )
...
* add total_length to pad_packed_sequence; add example on how to use pack->rnn->unpack with DP
* address comments
* fix typo
2018-04-08 20:25:48 -04:00
Kento NOZAWA
c00ee6da8f
Fix typos ( #6348 )
...
* Fix typo
* Fix typo
* Update faq.rst
2018-04-06 11:06:42 -04:00
Peter Goldsborough
47f31cb1e6
Update FAQ to make more sense after tensor/variable merge ( #6017 )
2018-03-27 07:48:25 -07:00
Tongzhou Wang
00cc962670
typo ( #5847 )
2018-03-17 10:26:00 -04:00
Tongzhou Wang
392fc8885c
add faq on cuda memory management and dataloder ( #5378 )
2018-02-27 18:35:30 -05:00
Tongzhou Wang
8c18220a59
Fix layer_norm initialization and nn.Module docs ( #5422 )
...
* Fix LN initialization; Support single int normalized_shape
* disable docstring inheritance
* fix sphinx warnings
2018-02-26 19:32:08 -05:00
brett koonce
596470011b
minor sp, underlyhing->underlying ( #5304 )
2018-02-19 22:28:17 -05:00
Edward Z. Yang
e411525f2c
Add a FAQ, for now just 'out of memory' advice. ( #5251 )
...
* Add a FAQ, for now just 'out of memory' advice.
Signed-off-by: Edward Z. Yang <ezyang@fb.com>
* Updates based on comments.
Signed-off-by: Edward Z. Yang <ezyang@fb.com>
* minor copyedit
2018-02-15 17:38:55 -08:00
