frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Mention module desc

Joel Schlosser
2021-10-29 11:43:55 -04:00
parent ad8f5e797c
commit 9d571bee3d
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
torch.nn-Module-Documentation-Style-Guide.md

@ -56,7 +56,9 @@ Examples::
"""
```
As shown above, the docstring for every module provided by torch.nn should include the following sections in order:
As shown above, the docstring for every module provided by torch.nn should include a thorough
description of the module's computation (supporting math / references can be helpful) as well as
the following sections in order:
* **Args**
* **Shape**