mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 00:21:07 +01:00
71cb13869b
3073 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
isdanni
|
2f7bb18def |
[Doc] Add padding size constraint in nn.ReflectionPad2d (#115995)
Fixes #115532 Pull Request resolved: https://github.com/pytorch/pytorch/pull/115995 Approved by: https://github.com/mikaylagawarecki |
||
|
Mikayla Gawarecki
|
6d5fe07659 |
Fix numpy warning when importing torch without numpy installed (#115867)
Fixes #115638 I verified locally that with no numpy install the warning no longer occurs Pull Request resolved: https://github.com/pytorch/pytorch/pull/115867 Approved by: https://github.com/soulitzer |
||
|
soulitzer
|
8885128dcc |
Fix backward for SDPA NT jagged layout (#115576)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/115576 Approved by: https://github.com/jbschlosser, https://github.com/ani300 |
||
|
Isuru Fernando
|
d40a7c6026 |
Add decompositions for replication_pad (#115113)
Fixes #115395 Pull Request resolved: https://github.com/pytorch/pytorch/pull/115113 Approved by: https://github.com/peterbell10 |
||
|
Wongboo
|
68f74dd162 |
Add python and C++ support for LPPool3d (#114199)
Add python and C++ support for LPPool3d to Fixes #114114 Pull Request resolved: https://github.com/pytorch/pytorch/pull/114199 Approved by: https://github.com/mikaylagawarecki |
||
|
Mikayla Gawarecki
|
f5919335db |
Fix _load_from_state_dict for num_batches_tracked in batchnorm (#115285)
I approved https://github.com/pytorch/pytorch/pull/110850 which did the following Previously: `num_batches_tracked` not in state_dict when doing `m.load_state_dict(state_dict)` --> always overwrite module's `num_batches_tracked` in `load_from_state_dict` with a 0 cpu tensor Now: `num_batches_tracked` not in state_dict loaded when doing `m.load_state_dict(state_dict)` --> only overwrite module's `num_batches_tracked` in `load_from_state_dict` with a 0 cpu tensor if module does not have `num_batches_tracked` This causes the following issue: ``` with torch.device('meta'): m = BatchNorm(...) m.load_state_dict(state_dict, assign=True) ``` If `num_batches_tracked` is not in `state_dict`, since `modules's` `num_batches_tracked` is present on meta device, it is not overwritten with a 0 cpu tensor. When compiling, this error is raised ``` AssertionError: Does not support mixing cuda+meta ``` I am not sure whether the explicit check for meta device makes sense as a fix, will add testing if this fix is ok Pull Request resolved: https://github.com/pytorch/pytorch/pull/115285 Approved by: https://github.com/albanD |
||
|
Linus
|
7201edc0a5 |
Fix RNN class constructor signature (#115341)
Fixes #114617 Pull Request resolved: https://github.com/pytorch/pytorch/pull/115341 Approved by: https://github.com/mikaylagawarecki |
||
|
Albert Zeyer
|
3642f29a64 |
DistributedDataParallel._post_forward, fix return (#114678)
Fix `return` in case of `_delay_all_reduce_all_params`. Pull Request resolved: https://github.com/pytorch/pytorch/pull/114678 Approved by: https://github.com/Skylion007, https://github.com/fegin |
||
|
drisspg
|
d4c79a3078 |
Add an attention bias subclass for a lower right causal masking (#114823)
# Summary This PR introduces a new Tensor subclass that is designed to be used with torch.nn.functional.scaled_dot_product_attention. Currently we have a boolean `is_causal` flag that allows users to do do causal masking without the need to actually create the "realized" attention bias and pass into sdpa. We originally added this flag since there is native support in both fused kernels we support. This provides a big performance gain ( the kernels only need to iterate over ~0.5x the sequence, and for very large sequence lengths this can provide vary large memory improvements. The flag was introduced when the early on in the kernel development and at the time it was implicitly meant to "upper_left" causal attention. This distinction only matters when the attention_bias is not square. For a more detailed break down see: https://github.com/pytorch/pytorch/issues/108108. The kernels default behavior has since changed, largely due to the rise of autogressive text generation. And unfortunately this would lead to a BC break. In the long term it may actually be beneficial to change the default meaning of `is_causal` to represent lower_right causal masking. The larger theme though is laid here: https://github.com/pytorch/pytorch/issues/110681. The thesis being that there is alot of innovation in SDPA revolving around the attention_bias being used. This is the first in hopefully a few more attention_biases that we would like to add. The next interesting one would be `sliding_window` which is used by the popular mistral model family. Results from benchmarking, I improved the meff_attention perf hence the slightly decreased max perf. ```Shell +---------+--------------------+------------+-----------+-----------+-----------+-----------+----------------+----------+ | Type | Speedup | batch_size | num_heads | q_seq_len | k_seq_len | embed_dim | dtype | head_dim | +---------+--------------------+------------+-----------+-----------+-----------+-----------+----------------+----------+ | Average | 1.2388050062214226 | | | | | | | | | Max | 1.831672915579016 | 128 | 32 | 1024 | 2048 | 2048 | torch.bfloat16 | 64 | | Min | 0.9430534166730135 | 1 | 16 | 256 | 416 | 2048 | torch.bfloat16 | 128 | +---------+--------------------+------------+-----------+-----------+-----------+-----------+----------------+----------+ ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/114823 Approved by: https://github.com/cpuhrsch |
||
|
Chip Turner
|
9cc040fef6 |
Switch env variable use in test harnesses to the non-deprecated names to fix warnings (#114880)
Previously: ``` [W Utils.hpp:133] Warning: Environment variable NCCL_ASYNC_ERROR_HANDLING is deprecated; use TORCH_NCCL_ASYNC_ERROR_HANDLING instead (function getCvarInt) [W Utils.hpp:133] Warning: Environment variable NCCL_ASYNC_ERROR_HANDLING is deprecated; use TORCH_NCCL_ASYNC_ERROR_HANDLING instead (function getCvarInt) ``` With this PR, those warnings disappear. They were introduced in #114077 This change was generated with this sed script, applied with `sed -i -f /tmp/x **/*.{py,hpp,cpp,cc}` and hand inspected. ``` s/\bNCCL_BLOCKING_WAIT\b/TORCH_NCCL_BLOCKING_WAIT/g s/\bNCCL_ENABLE_TIMING\b/TORCH_NCCL_ENABLE_TIMING/g s/\bNCCL_DESYNC_DEBUG\b/TORCH_NCCL_DESYNC_DEBUG/g s/\bNCCL_ASYNC_ERROR_HANDLING\b/TORCH_NCCL_ASYNC_ERROR_HANDLING/g s/\bENABLE_NCCL_HEALTH_CHECK\b/TORCH_ENABLE_NCCL_HEALTH_CHECK/g s/\bNCCL_USE_TENSOR_REGISTER_ALLOCATOR_HOOK\b/TORCH_NCCL_USE_TENSOR_REGISTER_ALLOCATOR_HOOK/g ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/114880 Approved by: https://github.com/kwen2501 |
||
|
Kurt Mohler
|
6f32eb7eef |
Add decomp for replication_pad2d and use for CUDA deterministic (#111590)
Fixes #95578 Pull Request resolved: https://github.com/pytorch/pytorch/pull/111590 Approved by: https://github.com/peterbell10 |
||
|
wz337
|
7b3e45be59 |
[DeviceMesh] Rename get_dim_groups to get_group (#114708)
Rename get_dim_groups to get_group and update all callsites. Differential Revision: [D51629801](https://our.internmc.facebook.com/intern/diff/D51629801/) Pull Request resolved: https://github.com/pytorch/pytorch/pull/114708 Approved by: https://github.com/XilunWu, https://github.com/wanchaol, https://github.com/fegin |
||
|
PyTorch MergeBot
|
013675ff59 |
Revert "Add decomp for replication_pad2d and use for CUDA deterministic (#111590)"
This reverts commit
|
||
|
Kurt Mohler
|
f1286161a6 |
Add decomp for replication_pad2d and use for CUDA deterministic (#111590)
Fixes #95578 Pull Request resolved: https://github.com/pytorch/pytorch/pull/111590 Approved by: https://github.com/peterbell10 |
||
|
Pritam Damania
|
f505d76462 |
Bug fixes to DDP _update_process_group API. (#114194)
https://github.com/pytorch/pytorch/pull/113580 introduced the `DDP._update_process_group` API. However, the implementation did not correctly reset all of the necessary state in the reducer. In particular if an error occurred during backward, DDP would end up in an incorrect state. As a result, in this PR I've enhanced the unit test to test for this case and also appropriately fixed resetting Reducer state. Pull Request resolved: https://github.com/pytorch/pytorch/pull/114194 Approved by: https://github.com/rohan-varma |
||
|
Aaron Gokaslan
|
ea7d70aecc |
[BE]: ruff FURB136: replace ternary with min/max (preview) (#114382)
Replaces ternary if else statements with simple min max when appropriate. Pull Request resolved: https://github.com/pytorch/pytorch/pull/114382 Approved by: https://github.com/albanD |
||
|
Antonio Kim
|
7fc292930c |
Add support for torch.Generator type in TorchScript (#110413)
- Add support for `torch.Generator` type in TorchScript - Add `generator` args to all `torch.nn.init` functions that call `uniform_` or `normal_` - Add support for `torch.Generator` in LTC's TorchScript backend (CC: @wconstab) CC: @eellison @davidberard98 @GlebKazantaev @behzad-a Pull Request resolved: https://github.com/pytorch/pytorch/pull/110413 Approved by: https://github.com/wconstab, https://github.com/albanD, https://github.com/glebk-cerebras, https://github.com/davidberard98 |
||
|
drisspg
|
039a4689a2 |
Update sdpa doctstring to point to flash-attn-v2 (#114124)
# Summary See title Pull Request resolved: https://github.com/pytorch/pytorch/pull/114124 Approved by: https://github.com/albanD, https://github.com/Skylion007 |
||
|
Brian Vaughan
|
dbb96ef30d |
improve annotation device parameters where a device ordinal is allowed (#113647)
Using mypy in code that depends on pytorch, I noticed that the type annotation doesn't allow a device ordinal. `error: Argument "device" to "to_empty" of "Module" has incompatible type "int"; expected "str | device" [arg-type]` Pull Request resolved: https://github.com/pytorch/pytorch/pull/113647 Approved by: https://github.com/albanD |
||
|
Pritam Damania
|
17e2313dd3 |
Add an API to DDP for dynamically updating the underlying process group. (#113580)
# Motivation If we would like to reinitialize DDP with a different PG with `torch.compile`, we need to do the following: ``` del old_ddp del old_pg pg = init_pg(...) ddp = DDP(pg) model = torch.compile(DDP) ``` This results in recompilation of the entire model and is very expensive. Since the only thing we need to update is the PG, we should be able to do this without having to compile the model again. # Proposal As a result, in this PR I've introduced an `_update_process_group` API which can dynamically update the underlying ProcessGroup used by DDP without needing to reinitialize DDP again. Pull Request resolved: https://github.com/pytorch/pytorch/pull/113580 Approved by: https://github.com/fduwjj |
||
|
PyTorch MergeBot
|
252e68a83b |
Revert "Add support for torch.Generator type in TorchScript (#110413)"
This reverts commit
|
||
|
zabboud
|
53e7de4b65 |
Issue 112599 - fix pydocstyle errors (#113177)
Fixes #112599 Fixed errors relating to pydocstyle in the following files. The remaining errors are related to docstrings at the module level and at methods within each module, `forward()`, `reset_parameters`, `__init__` ..etc pydocstyle torch/nn/modules/pooling.py --count before: 49 after: 29 **remaining errors:** ``` torch/nn/modules/pooling.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/pooling.py:90 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:163 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:240 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:315 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:321 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:402 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:408 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:472 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:478 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:541 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:550 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:620 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:630 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:706 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:716 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:720 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/modules/pooling.py:774 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:792 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:845 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pooling.py:863 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:925 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:979 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1026 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1068 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1111 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1150 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1189 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pooling.py:1228 in public method `forward`: D102: Missing docstring in public method ``` pydocstyle torch/nn/modules/upsampling.py --count before: 14 after: 7 **remaining:** ``` torch/nn/modules/upsampling.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/upsampling.py:142 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/upsampling.py:156 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/upsampling.py:160 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/modules/upsampling.py:166 in public method `extra_repr`: D102: Missing docstring in public method torch/nn/modules/upsampling.py:216 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/upsampling.py:263 in public method `__init__`: D107: Missing docstring in __init__ ``` pydocstyle torch/nn/modules/rnn.py --count before: 47 after: 40 **remaining** ``` torch/nn/modules/rnn.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/rnn.py:59 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:160 in public method `__setattr__`: D105: Missing docstring in magic method torch/nn/modules/rnn.py:225 in public method `reset_parameters`: D102: Missing docstring in public method torch/nn/modules/rnn.py:230 in public method `check_input`: D102: Missing docstring in public method torch/nn/modules/rnn.py:242 in public method `get_expected_hidden_size`: D102: Missing docstring in public method torch/nn/modules/rnn.py:256 in public method `check_hidden_size`: D102: Missing docstring in public method torch/nn/modules/rnn.py:272 in public method `check_forward_args`: D102: Missing docstring in public method torch/nn/modules/rnn.py:278 in public method `permute_hidden`: D102: Missing docstring in public method torch/nn/modules/rnn.py:284 in public method `extra_repr`: D102: Missing docstring in public method torch/nn/modules/rnn.py:305 in public method `__getstate__`: D105: Missing docstring in magic method torch/nn/modules/rnn.py:313 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/modules/rnn.py:355 in public method `all_weights`: D102: Missing docstring in public method torch/nn/modules/rnn.py:471 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:478 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:481 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:503 in public method `forward` (skipping F811): D102: Missing docstring in public method torch/nn/modules/rnn.py:762 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:768 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:771 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:774 in public method `get_expected_cell_size`: D102: Missing docstring in public method torch/nn/modules/rnn.py:786 in public method `check_forward_args`: D102: Missing docstring in public method torch/nn/modules/rnn.py:798 in public method `permute_hidden`: D102: Missing docstring in public method torch/nn/modules/rnn.py:809 in public method `forward` (skipping F811): D102: Missing docstring in public method torch/nn/modules/rnn.py:820 in public method `forward` (skipping F811): D102: Missing docstring in public method torch/nn/modules/rnn.py:1030 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1036 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1039 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1046 in public method `forward` (skipping F811): D102: Missing docstring in public method torch/nn/modules/rnn.py:1054 in public method `forward` (skipping F811): D102: Missing docstring in public method torch/nn/modules/rnn.py:1123 in public class `RNNCellBase`: D101: Missing docstring in public class torch/nn/modules/rnn.py:1134 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1152 in public method `extra_repr`: D102: Missing docstring in public method torch/nn/modules/rnn.py:1160 in public method `reset_parameters`: D102: Missing docstring in public method torch/nn/modules/rnn.py:1224 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1230 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/rnn.py:1327 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1332 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/rnn.py:1422 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/rnn.py:1427 in public method `forward`: D102: Missing docstring in public method ``` pydocstyle torch/nn/modules/pixelshuffle.py --count before: 13 after: 8 **remaining:** ``` torch/nn/modules/pixelshuffle.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/pixelshuffle.py:52 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pixelshuffle.py:56 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pixelshuffle.py:59 in public method `extra_repr`: D102: Missing docstring in public method torch/nn/modules/pixelshuffle.py:105 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/pixelshuffle.py:109 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/pixelshuffle.py:112 in public method `extra_repr`: D102: Missing docstring in public method ``` pydocstyle torch/nn/modules/sparse.py --count before: 14 after: 8 **remaining errors:** ``` torch/nn/modules/sparse.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/sparse.py:124 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/sparse.py:153 in public method `reset_parameters`: D102: Missing docstring in public method torch/nn/modules/sparse.py:162 in public method `forward`: D102: Missing docstring in public method torch/nn/modules/sparse.py:167 in public method `extra_repr`: D102: Missing docstring in public method torch/nn/modules/sparse.py:320 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/modules/sparse.py:350 in public method `reset_parameters`: D102: Missing docstring in public method torch/nn/modules/sparse.py:396 in public method `extra_repr`: D102: Missing docstring in public method ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/113177 Approved by: https://github.com/ezyang |
||
|
Antonio Kim
|
54493fe8c4 |
Add support for torch.Generator type in TorchScript (#110413)
- Add support for `torch.Generator` type in TorchScript - Add `generator` args to all `torch.nn.init` functions that call `uniform_` or `normal_` - Add support for `torch.Generator` in LTC's TorchScript backend (CC: @wconstab) CC: @eellison @davidberard98 @GlebKazantaev @behzad-a Pull Request resolved: https://github.com/pytorch/pytorch/pull/110413 Approved by: https://github.com/wconstab, https://github.com/albanD, https://github.com/glebk-cerebras, https://github.com/davidberard98 |
||
|
pilot-j
|
9062e429db |
Fixed docstring errors in torch/nn/functional.py (Docathon H2) (#112856)
Fixes #112597 ### Output: **BEFORE:** ```functional.py:1 at module level: D400: First line should end with a period (not 'e') functional.py:438 in public function `fractional_max_pool2d_with_indices`: D400: First line should end with a period (not ')') functional.py:537 in public function `fractional_max_pool3d_with_indices`: D400: First line should end with a period (not ')') functional.py:646 in public function `max_pool1d_with_indices`: D400: First line should end with a period (not ')') functional.py:732 in public function `max_pool2d_with_indices`: D400: First line should end with a period (not ')') functional.py:818 in public function `max_pool3d_with_indices`: D400: First line should end with a period (not ')') functional.py:932 in public function `max_unpool1d`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') functional.py:968 in public function `max_unpool2d`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') functional.py:1000 in public function `max_unpool3d`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') functional.py:1031 in public function `lp_pool2d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1031 in public function `lp_pool2d`: D400: First line should end with a period (not 'f') functional.py:1031 in public function `lp_pool2d`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1056 in public function `lp_pool1d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1056 in public function `lp_pool1d`: D400: First line should end with a period (not 'f') functional.py:1056 in public function `lp_pool1d`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1077 in public function `adaptive_max_pool1d_with_indices`: D400: First line should end with a period (not ')') functional.py:1119 in public function `adaptive_max_pool2d_with_indices`: D400: First line should end with a period (not ')') functional.py:1163 in public function `adaptive_max_pool3d_with_indices`: D400: First line should end with a period (not ')') functional.py:1220 in public function `adaptive_avg_pool2d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1220 in public function `adaptive_avg_pool2d`: D400: First line should end with a period (not 'f') functional.py:1220 in public function `adaptive_avg_pool2d`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1237 in public function `adaptive_avg_pool3d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1237 in public function `adaptive_avg_pool3d`: D400: First line should end with a period (not 'f') functional.py:1237 in public function `adaptive_avg_pool3d`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1255 in public function `dropout`: D205: 1 blank line required between summary line and description (found 0) functional.py:1255 in public function `dropout`: D400: First line should end with a period (not 't') functional.py:1275 in public function `alpha_dropout`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1287 in public function `dropout1d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1287 in public function `dropout1d`: D400: First line should end with a period (not ',') functional.py:1325 in public function `dropout2d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1325 in public function `dropout2d`: D400: First line should end with a period (not ',') functional.py:1369 in public function `dropout3d`: D205: 1 blank line required between summary line and description (found 0) functional.py:1369 in public function `dropout3d`: D400: First line should end with a period (not ',') functional.py:1408 in public function `feature_alpha_dropout`: D205: 1 blank line required between summary line and description (found 0) functional.py:1408 in public function `feature_alpha_dropout`: D400: First line should end with a period (not ',') functional.py:1466 in public function `relu`: D400: First line should end with a period (not 'r') functional.py:1466 in public function `relu`: D402: First line should not be the function's "signature" functional.py:1491 in public function `glu`: D400: First line should end with a period (not 'r') functional.py:1491 in public function `glu`: D402: First line should not be the function's "signature" functional.py:1516 in public function `hardtanh`: D400: First line should end with a period (not 'r') functional.py:1516 in public function `hardtanh`: D402: First line should not be the function's "signature" functional.py:1542 in public function `relu6`: D400: First line should end with a period (not 'r') functional.py:1542 in public function `relu6`: D402: First line should not be the function's "signature" functional.py:1558 in public function `elu`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1582 in public function `selu`: D400: First line should end with a period (not 'r') functional.py:1582 in public function `selu`: D402: First line should not be the function's "signature" functional.py:1611 in public function `celu`: D400: First line should end with a period (not 'r') functional.py:1611 in public function `celu`: D402: First line should not be the function's "signature" functional.py:1638 in public function `leaky_relu`: D400: First line should end with a period (not 'r') functional.py:1638 in public function `leaky_relu`: D402: First line should not be the function's "signature" functional.py:1688 in public function `rrelu`: D400: First line should end with a period (not 'r') functional.py:1688 in public function `rrelu`: D402: First line should not be the function's "signature" functional.py:1755 in public function `tanhshrink`: D400: First line should end with a period (not 'r') functional.py:1755 in public function `tanhshrink`: D402: First line should not be the function's "signature" functional.py:1767 in public function `softsign`: D400: First line should end with a period (not 'r') functional.py:1767 in public function `softsign`: D402: First line should not be the function's "signature" functional.py:1806 in public function `softmin`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1832 in public function `softmax`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1868 in public function `gumbel_softmax`: D401: First line should be in imperative mood (perhaps 'Sample', not 'Samples') functional.py:1930 in public function `log_softmax`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:1969 in public function `tanh`: D400: First line should end with a period (not 'r') functional.py:1969 in public function `tanh`: D402: First line should not be the function's "signature" functional.py:1980 in public function `sigmoid`: D400: First line should end with a period (not 'r') functional.py:1980 in public function `sigmoid`: D402: First line should not be the function's "signature" functional.py:1990 in public function `hardsigmoid`: D400: First line should end with a period (not 'n') functional.py:1990 in public function `hardsigmoid`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2057 in public function `silu`: D205: 1 blank line required between summary line and description (found 0) functional.py:2057 in public function `silu`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2081 in public function `mish`: D205: 1 blank line required between summary line and description (found 0) functional.py:2081 in public function `mish`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2100 in public function `hardswish`: D400: First line should end with a period (not ':') functional.py:2100 in public function `hardswish`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2136 in public function `embedding`: D202: No blank lines allowed after function docstring (found 1) functional.py:2136 in public function `embedding`: D401: First line should be in imperative mood; try rephrasing (found 'A') functional.py:2254 in public function `embedding_bag`: D205: 1 blank line required between summary line and description (found 0) functional.py:2254 in public function `embedding_bag`: D400: First line should end with a period (not 'e') functional.py:2254 in public function `embedding_bag`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') functional.py:2462 in public function `batch_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2507 in public function `instance_norm`: D205: 1 blank line required between summary line and description (found 0) functional.py:2507 in public function `instance_norm`: D400: First line should end with a period (not 'a') functional.py:2507 in public function `instance_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2540 in public function `layer_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2554 in public function `group_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2567 in public function `local_response_norm`: D205: 1 blank line required between summary line and description (found 0) functional.py:2567 in public function `local_response_norm`: D400: First line should end with a period (not 'f') functional.py:2567 in public function `local_response_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') functional.py:2611 in public function `ctc_loss`: D401: First line should be in imperative mood; try rephrasing (found 'The') functional.py:2679 in public function `nll_loss`: D401: First line should be in imperative mood; try rephrasing (found 'The') functional.py:2895 in public function `kl_div`: D205: 1 blank line required between summary line and description (found 0) functional.py:2895 in public function `kl_div`: D400: First line should end with a period (not 's') functional.py:2895 in public function `kl_div`: D401: First line should be in imperative mood; try rephrasing (found 'The') functional.py:2978 in public function `cross_entropy`: D401: First line should be in imperative mood; try rephrasing (found 'This') functional.py:3069 in public function `binary_cross_entropy`: D205: 1 blank line required between summary line and description (found 0) functional.py:3069 in public function `binary_cross_entropy`: D400: First line should end with a period (not 't') functional.py:3069 in public function `binary_cross_entropy`: D401: First line should be in imperative mood; try rephrasing (found 'Function') functional.py:3139 in public function `binary_cross_entropy_with_logits`: D205: 1 blank line required between summary line and description (found 0) functional.py:3139 in public function `binary_cross_entropy_with_logits`: D400: First line should end with a period (not 't') functional.py:3139 in public function `binary_cross_entropy_with_logits`: D401: First line should be in imperative mood; try rephrasing (found 'Function') functional.py:3211 in public function `smooth_l1_loss`: D205: 1 blank line required between summary line and description (found 0) functional.py:3211 in public function `smooth_l1_loss`: D400: First line should end with a period (not 'e') functional.py:3211 in public function `smooth_l1_loss`: D401: First line should be in imperative mood; try rephrasing (found 'Function') functional.py:3251 in public function `huber_loss`: D205: 1 blank line required between summary line and description (found 0) functional.py:3251 in public function `huber_loss`: D400: First line should end with a period (not 'e') functional.py:3251 in public function `huber_loss`: D401: First line should be in imperative mood; try rephrasing (found 'Function') functional.py:3282 in public function `l1_loss`: D400: First line should end with a period (not 'r') functional.py:3282 in public function `l1_loss`: D402: First line should not be the function's "signature" functional.py:3313 in public function `mse_loss`: D400: First line should end with a period (not 'r') functional.py:3313 in public function `mse_loss`: D402: First line should not be the function's "signature" functional.py:3346 in public function `margin_ranking_loss`: D400: First line should end with a period (not 'r') functional.py:3346 in public function `margin_ranking_loss`: D402: First line should not be the function's "signature" functional.py:3382 in public function `hinge_embedding_loss`: D400: First line should end with a period (not 'r') functional.py:3382 in public function `hinge_embedding_loss`: D402: First line should not be the function's "signature" functional.py:3411 in public function `multilabel_margin_loss`: D400: First line should end with a period (not 'r') functional.py:3411 in public function `multilabel_margin_loss`: D402: First line should not be the function's "signature" functional.py:3439 in public function `soft_margin_loss`: D400: First line should end with a period (not 'r') functional.py:3439 in public function `soft_margin_loss`: D402: First line should not be the function's "signature" functional.py:3462 in public function `multilabel_soft_margin_loss`: D400: First line should end with a period (not 'r') functional.py:3462 in public function `multilabel_soft_margin_loss`: D402: First line should not be the function's "signature" functional.py:3510 in public function `cosine_embedding_loss`: D400: First line should end with a period (not 'r') functional.py:3510 in public function `cosine_embedding_loss`: D402: First line should not be the function's "signature" functional.py:3543 in public function `multi_margin_loss`: D400: First line should end with a period (not 'r') functional.py:3543 in public function `multi_margin_loss`: D402: First line should not be the function's "signature" functional.py:3708 in public function `upsample` (skipping F811,B950): D103: Missing docstring in public function functional.py:3713 in public function `upsample` (skipping F811,B950): D103: Missing docstring in public function functional.py:3718 in public function `upsample` (skipping F811): D205: 1 blank line required between summary line and description (found 0) functional.py:3718 in public function `upsample` (skipping F811): D400: First line should end with a period (not 'n') functional.py:3783 in private function `_is_integer`: D205: 1 blank line required between summary line and description (found 0) functional.py:3794 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3799 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3804 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3809 in public function `interpolate` (skipping F811): D103: Missing docstring in public function functional.py:3821 in public function `interpolate` (skipping F811,B950): D205: 1 blank line required between summary line and description (found 0) functional.py:3821 in public function `interpolate` (skipping F811,B950): D400: First line should end with a period (not 'n') functional.py:4062 in public function `upsample_nearest` (skipping F811): D103: Missing docstring in public function functional.py:4067 in public function `upsample_nearest` (skipping F811): D103: Missing docstring in public function functional.py:4100 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4107 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4114 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4121 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4174 in public function `grid_sample`: D205: 1 blank line required between summary line and description (found 0) functional.py:4174 in public function `grid_sample`: D400: First line should end with a period (not 'e') functional.py:4315 in public function `affine_grid`: D205: 1 blank line required between summary line and description (found 0) functional.py:4315 in public function `affine_grid`: D400: First line should end with a period (not 'f') functional.py:4315 in public function `affine_grid`: D401: First line should be in imperative mood (perhaps 'Generate', not 'Generates') functional.py:4608 in public function `triplet_margin_loss`: D200: One-line docstring should fit on one line with quotes (found 3) functional.py:4608 in public function `triplet_margin_loss`: D400: First line should end with a period (not 's') functional.py:4643 in public function `triplet_margin_with_distance_loss`: D200: One-line docstring should fit on one line with quotes (found 3) functional.py:4705 in public function `normalize`: D401: First line should be in imperative mood (perhaps 'Perform', not 'Performs') functional.py:4733 in public function `assert_int_or_pair`: D103: Missing docstring in public function functional.py:4743 in public function `unfold`: D401: First line should be in imperative mood (perhaps 'Extract', not 'Extracts') functional.py:4773 in public function `fold`: D205: 1 blank line required between summary line and description (found 0) functional.py:4773 in public function `fold`: D400: First line should end with a period (not 'g') functional.py:4773 in public function `fold`: D401: First line should be in imperative mood (perhaps 'Combine', not 'Combines') functional.py:4800 in private function `_in_projection_packed`: D205: 1 blank line required between summary line and description (found 0) functional.py:4800 in private function `_in_projection_packed`: D401: First line should be in imperative mood (perhaps 'Perform', not 'Performs') functional.py:4867 in private function `_in_projection`: D205: 1 blank line required between summary line and description (found 0) functional.py:4867 in private function `_in_projection`: D400: First line should end with a period (not 'y') functional.py:4867 in private function `_in_projection`: D401: First line should be in imperative mood (perhaps 'Perform', not 'Performs') functional.py:5128 in public function `multi_head_attention_forward`: D205: 1 blank line required between summary line and description (found 0) functional.py:5128 in public function `multi_head_attention_forward`: D400: First line should end with a period (not ':') 160 ``` **AFTER:** ``` functional.py:3709 in public function `upsample` (skipping F811,B950): D103: Missing docstring in public function functional.py:3714 in public function `upsample` (skipping F811,B950): D103: Missing docstring in public function functional.py:3798 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3803 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3808 in public function `interpolate` (skipping F811,B950): D103: Missing docstring in public function functional.py:3813 in public function `interpolate` (skipping F811): D103: Missing docstring in public function functional.py:4068 in public function `upsample_nearest` (skipping F811): D103: Missing docstring in public function functional.py:4073 in public function `upsample_nearest` (skipping F811): D103: Missing docstring in public function functional.py:4106 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4113 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4120 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4127 in public function `upsample_bilinear` (skipping F811): D103: Missing docstring in public function functional.py:4742 in public function `assert_int_or_pair`: D103: Missing docstring in public function 13 ``` The file contained several docstring errors. I have fixed all of them(hopefully) and have tried to improve the over all readability of the code. For most part, I have included relevant description of functions (referred from official PyTorch Docs). In some cases where functions are purely mathematical or it is difficult to give one line description, I have just included references. For testing, I relied on local system and created a separate file. For final edits, I directly changed the contents of forked repo as visible already. Kindly review @svekars @subramen @kit1980 Pull Request resolved: https://github.com/pytorch/pytorch/pull/112856 Approved by: https://github.com/kit1980 |
||
|
IvanLauLinTiong
|
91c90f232a |
Fix docstring errors in reductions.py, spawn.py, pool.py, parameter.py, cpp.py, grad.py, __init__.py, profiler.py, queue.py, graph.py (#113052)
Fixes #112595 - `torch/autograd/profiler.py` </br> **Before: 37** ``` torch/autograd/profiler.py:1 at module level: D100: Missing docstring in public module torch/autograd/profiler.py:91 in public class `profile`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:175 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:261 in public method `config`: D102: Missing docstring in public method torch/autograd/profiler.py:272 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:290 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:308 in public method `__repr__`: D105: Missing docstring in magic method torch/autograd/profiler.py:313 in public method `__str__`: D105: Missing docstring in magic method torch/autograd/profiler.py:322 in public method `table`: D102: Missing docstring in public method torch/autograd/profiler.py:346 in public method `export_chrome_trace`: D102: Missing docstring in public method torch/autograd/profiler.py:355 in public method `export_stacks`: D102: Missing docstring in public method torch/autograd/profiler.py:361 in public method `key_averages`: D102: Missing docstring in public method torch/autograd/profiler.py:368 in public method `total_average`: D102: Missing docstring in public method torch/autograd/profiler.py:377 in public method `self_cpu_time_total`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:377 in public method `self_cpu_time_total`: D400: First line should end with a period (not 'f') torch/autograd/profiler.py:555 in public class `record_function`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:555 in public class `record_function`: D400: First line should end with a period (not 'f') torch/autograd/profiler.py:591 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:602 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:608 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:625 in private method `_call_end_callbacks_on_future`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:625 in private method `_call_end_callbacks_on_future`: D400: First line should end with a period (not 'c') torch/autograd/profiler.py:707 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:712 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:733 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:826 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:831 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:853 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:863 in public function `load_nvprof`: D401: First line should be in imperative mood (perhaps 'Open', not 'Opens') torch/autograd/profiler.py:874 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:877 in public method `see`: D102: Missing docstring in public method torch/autograd/profiler.py:883 in public function `parse_nvprof_trace`: D103: Missing docstring in public function torch/autograd/profiler.py:951 in public class `KinetoStepTracker`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:991 in public method `init_step_count`: D102: Missing docstring in public method torch/autograd/profiler.py:995 in public method `erase_step_count`: D102: Missing docstring in public method torch/autograd/profiler.py:1000 in public method `increment_step`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/profiler.py:1023 in public method `current_step`: D102: Missing docstring in public method 37 ``` **After: 27** ``` torch/autograd/profiler.py:1 at module level: D100: Missing docstring in public module torch/autograd/profiler.py:176 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:262 in public method `config`: D102: Missing docstring in public method torch/autograd/profiler.py:273 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:291 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:309 in public method `__repr__`: D105: Missing docstring in magic method torch/autograd/profiler.py:314 in public method `__str__`: D105: Missing docstring in magic method torch/autograd/profiler.py:323 in public method `table`: D102: Missing docstring in public method torch/autograd/profiler.py:347 in public method `export_chrome_trace`: D102: Missing docstring in public method torch/autograd/profiler.py:356 in public method `export_stacks`: D102: Missing docstring in public method torch/autograd/profiler.py:362 in public method `key_averages`: D102: Missing docstring in public method torch/autograd/profiler.py:369 in public method `total_average`: D102: Missing docstring in public method torch/autograd/profiler.py:593 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:604 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:610 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:708 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:713 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:734 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:827 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:832 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/profiler.py:854 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/profiler.py:875 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/profiler.py:878 in public method `see`: D102: Missing docstring in public method torch/autograd/profiler.py:884 in public function `parse_nvprof_trace`: D103: Missing docstring in public function torch/autograd/profiler.py:993 in public method `init_step_count`: D102: Missing docstring in public method torch/autograd/profiler.py:997 in public method `erase_step_count`: D102: Missing docstring in public method torch/autograd/profiler.py:1025 in public method `current_step`: D102: Missing docstring in public method 27 ``` - `torch/autograd/graph.py` </br> **Before: 22** ``` torch/autograd/graph.py:1 at module level: D100: Missing docstring in public module torch/autograd/graph.py:24 in public class `Node`: D101: Missing docstring in public class torch/autograd/graph.py:27 in public method `name`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/autograd/graph.py:42 in public method `next_functions`: D102: Missing docstring in public method torch/autograd/graph.py:47 in public method `metadata`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/autograd/graph.py:56 in public method `register_hook`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/autograd/graph.py:94 in public method `register_prehook`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/autograd/graph.py:129 in public method `__subclasshook__`: D105: Missing docstring in magic method torch/autograd/graph.py:147 in public function `get_gradient_edge`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/graph.py:147 in public function `get_gradient_edge`: D400: First line should end with a period (not 'f') torch/autograd/graph.py:147 in public function `get_gradient_edge`: D401: First line should be in imperative mood; try rephrasing (found 'This') torch/autograd/graph.py:166 in public function `increment_version`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/graph.py:166 in public function `increment_version`: D400: First line should end with a period (not 'd') torch/autograd/graph.py:166 in public function `increment_version`: D401: First line should be in imperative mood; try rephrasing (found 'This') torch/autograd/graph.py:243 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/graph.py:251 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/graph.py:256 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/graph.py:261 in public class `save_on_cpu`: D205: 1 blank line required between summary line and description (found 0) torch/autograd/graph.py:261 in public class `save_on_cpu`: D400: First line should end with a period (not 'e') torch/autograd/graph.py:303 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/graph.py:365 in public function `register_multi_grad_hook`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/autograd/graph.py:588 in public function `allow_mutation_on_saved_tensors`: D400: First line should end with a period (not 'd') 22 ``` **After: 8** ``` torch/autograd/graph.py:1 at module level: D100: Missing docstring in public module torch/autograd/graph.py:24 in public class `Node`: D101: Missing docstring in public class torch/autograd/graph.py:42 in public method `next_functions`: D102: Missing docstring in public method torch/autograd/graph.py:129 in public method `__subclasshook__`: D105: Missing docstring in magic method torch/autograd/graph.py:244 in public method `__init__`: D107: Missing docstring in __init__ torch/autograd/graph.py:252 in public method `__enter__`: D105: Missing docstring in magic method torch/autograd/graph.py:257 in public method `__exit__`: D105: Missing docstring in magic method torch/autograd/graph.py:303 in public method `__init__`: D107: Missing docstring in __init__ 8 ``` - `torch/multiprocessing/pool.py` </br> **Before: 6** ``` torch/multiprocessing/pool.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/pool.py:7 in public function `clean_worker`: D103: Missing docstring in public function torch/multiprocessing/pool.py:18 in public class `Pool`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/pool.py:18 in public class `Pool`: D209: Multi-line docstring closing quotes should be on a separate line torch/multiprocessing/pool.py:29 in private method `_repopulate_pool`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/pool.py:29 in private method `_repopulate_pool`: D400: First line should end with a period (not ',') 6 ``` **After: 2** ``` torch/multiprocessing/pool.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/pool.py:7 in public function `clean_worker`: D103: Missing docstring in public function 2 ``` - `torch/multiprocessing/queue.py` </br> **Before: 11** ``` torch/multiprocessing/queue.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/queue.py:8 in public class `ConnectionWrapper`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/queue.py:8 in public class `ConnectionWrapper`: D209: Multi-line docstring closing quotes should be on a separate line torch/multiprocessing/queue.py:8 in public class `ConnectionWrapper`: D400: First line should end with a period (not 'o') torch/multiprocessing/queue.py:11 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/queue.py:14 in public method `send`: D102: Missing docstring in public method torch/multiprocessing/queue.py:19 in public method `recv`: D102: Missing docstring in public method torch/multiprocessing/queue.py:23 in public method `__getattr__`: D105: Missing docstring in magic method torch/multiprocessing/queue.py:29 in public class `Queue`: D101: Missing docstring in public class torch/multiprocessing/queue.py:30 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/queue.py:38 in public class `SimpleQueue`: D101: Missing docstring in public class 11 ``` **After: 8** ``` torch/multiprocessing/queue.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/queue.py:10 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/queue.py:13 in public method `send`: D102: Missing docstring in public method torch/multiprocessing/queue.py:18 in public method `recv`: D102: Missing docstring in public method torch/multiprocessing/queue.py:22 in public method `__getattr__`: D105: Missing docstring in magic method torch/multiprocessing/queue.py:28 in public class `Queue`: D101: Missing docstring in public class torch/multiprocessing/queue.py:29 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/queue.py:37 in public class `SimpleQueue`: D101: Missing docstring in public class 8 ``` - `torch/multiprocessing/reductions.py` </br> **Before: 31** ``` torch/multiprocessing/reductions.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/reductions.py:24 in public class `StorageWeakRef`: D209: Multi-line docstring closing quotes should be on a separate line torch/multiprocessing/reductions.py:31 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/reductions.py:38 in public method `from_weakref`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:44 in public method `expired`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:47 in public method `__del__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:50 in public method `__hash__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:53 in public method `__eq__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:60 in public class `SharedCache`: D400: First line should end with a period (not 'f') torch/multiprocessing/reductions.py:62 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/reductions.py:75 in public method `get`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:79 in public method `__setitem__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:85 in public method `free_dead_references`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:99 in public function `rebuild_event`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:103 in public function `reduce_event`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:108 in public function `rebuild_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:121 in public function `rebuild_cuda_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:189 in public function `reduce_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:347 in public function `rebuild_nested_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:364 in public function `reduce_nested_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:389 in public function `fd_id`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:397 in public function `storage_from_cache`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:404 in public function `rebuild_storage_fd`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:417 in public function `rebuild_storage_filename`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:437 in public function `rebuild_storage_empty`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:441 in public function `rebuild_typed_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:446 in public function `reduce_typed_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:450 in public function `rebuild_typed_storage_child`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:455 in public function `reduce_typed_storage_child`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:459 in public function `reduce_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:488 in public function `init_reductions`: D103: Missing docstring in public function 31 ``` **After: 29** ``` torch/multiprocessing/reductions.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/reductions.py:32 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/reductions.py:39 in public method `from_weakref`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:45 in public method `expired`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:48 in public method `__del__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:51 in public method `__hash__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:54 in public method `__eq__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:63 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/reductions.py:76 in public method `get`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:80 in public method `__setitem__`: D105: Missing docstring in magic method torch/multiprocessing/reductions.py:86 in public method `free_dead_references`: D102: Missing docstring in public method torch/multiprocessing/reductions.py:100 in public function `rebuild_event`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:104 in public function `reduce_event`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:109 in public function `rebuild_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:122 in public function `rebuild_cuda_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:190 in public function `reduce_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:348 in public function `rebuild_nested_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:365 in public function `reduce_nested_tensor`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:390 in public function `fd_id`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:398 in public function `storage_from_cache`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:405 in public function `rebuild_storage_fd`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:418 in public function `rebuild_storage_filename`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:438 in public function `rebuild_storage_empty`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:442 in public function `rebuild_typed_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:447 in public function `reduce_typed_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:451 in public function `rebuild_typed_storage_child`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:456 in public function `reduce_typed_storage_child`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:460 in public function `reduce_storage`: D103: Missing docstring in public function torch/multiprocessing/reductions.py:489 in public function `init_reductions`: D103: Missing docstring in public function 29 ``` - `torch/multiprocessing/spawn.py` </br> **Before: 19** ``` torch/multiprocessing/spawn.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/spawn.py:11 in public class `ProcessException`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:14 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:20 in public method `__reduce__`: D105: Missing docstring in magic method torch/multiprocessing/spawn.py:25 in public class `ProcessRaisedException`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/spawn.py:25 in public class `ProcessRaisedException`: D400: First line should end with a period (not 'n') torch/multiprocessing/spawn.py:30 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:40 in public class `ProcessExitedException`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/spawn.py:40 in public class `ProcessExitedException`: D400: First line should end with a period (not 'l') torch/multiprocessing/spawn.py:47 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:59 in public method `__reduce__`: D105: Missing docstring in magic method torch/multiprocessing/spawn.py:85 in public class `ProcessContext`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:86 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:93 in public method `pids`: D102: Missing docstring in public method torch/multiprocessing/spawn.py:97 in public method `join`: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/spawn.py:97 in public method `join`: D401: First line should be in imperative mood (perhaps 'Try', not 'Tries') torch/multiprocessing/spawn.py:166 in public class `SpawnContext`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:167 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:180 in public function `start_processes`: D103: Missing docstring in public function 19 ``` **After: 13** ``` torch/multiprocessing/spawn.py:1 at module level: D100: Missing docstring in public module torch/multiprocessing/spawn.py:11 in public class `ProcessException`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:14 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:20 in public method `__reduce__`: D105: Missing docstring in magic method torch/multiprocessing/spawn.py:27 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:41 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:53 in public method `__reduce__`: D105: Missing docstring in magic method torch/multiprocessing/spawn.py:79 in public class `ProcessContext`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:80 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:87 in public method `pids`: D102: Missing docstring in public method torch/multiprocessing/spawn.py:161 in public class `SpawnContext`: D101: Missing docstring in public class torch/multiprocessing/spawn.py:162 in public method `__init__`: D107: Missing docstring in __init__ torch/multiprocessing/spawn.py:175 in public function `start_processes`: D103: Missing docstring in public function 13 ``` - `torch/multiprocessing/__init__.py` </br> **Before: 0** ``` torch/multiprocessing/__init__.py:1 at module level: D205: 1 blank line required between summary line and description (found 0) torch/multiprocessing/__init__.py:1 at module level: D400: First line should end with a period (not '`') torch/multiprocessing/__init__.py:57 in public function `set_sharing_strategy`: D401: First line should be in imperative mood (perhaps 'Set', not 'Sets') torch/multiprocessing/__init__.py:69 in public function `get_sharing_strategy`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/multiprocessing/__init__.py:74 in public function `get_all_sharing_strategies`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') 5 ``` **After: 0** - `torch/nn/__init__.py` </br> **Before: 3** ``` torch/nn/__init__.py:1 at module level: D104: Missing docstring in public package torch/nn/__init__.py:14 in public function `factory_kwargs`: D205: 1 blank line required between summary line and description (found 0) torch/nn/__init__.py:14 in public function `factory_kwargs`: D400: First line should end with a period (not 'd') 3 ``` **After: 1** ``` torch/nn/__init__.py:1 at module level: D104: Missing docstring in public package 1 ``` - `torch/nn/cpp.py` </br> **Before: 16** ``` torch/nn/cpp.py:7 in public class `OrderedDictWrapper`: D205: 1 blank line required between summary line and description (found 0) torch/nn/cpp.py:7 in public class `OrderedDictWrapper`: D400: First line should end with a period (not 'e') torch/nn/cpp.py:16 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/cpp.py:21 in public method `cpp_dict`: D102: Missing docstring in public method torch/nn/cpp.py:27 in public method `items`: D102: Missing docstring in public method torch/nn/cpp.py:30 in public method `keys`: D102: Missing docstring in public method torch/nn/cpp.py:33 in public method `values`: D102: Missing docstring in public method torch/nn/cpp.py:36 in public method `__iter__`: D105: Missing docstring in magic method torch/nn/cpp.py:39 in public method `__len__`: D105: Missing docstring in magic method torch/nn/cpp.py:42 in public method `__contains__`: D105: Missing docstring in magic method torch/nn/cpp.py:45 in public method `__getitem__`: D105: Missing docstring in magic method torch/nn/cpp.py:50 in public class `ModuleWrapper`: D205: 1 blank line required between summary line and description (found 0) torch/nn/cpp.py:50 in public class `ModuleWrapper`: D400: First line should end with a period (not 'd') torch/nn/cpp.py:55 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/cpp.py:83 in public method `training`: D102: Missing docstring in public method torch/nn/cpp.py:90 in public method `__repr__`: D105: Missing docstring in magic method 16 ``` **After: 12** ``` torch/nn/cpp.py:16 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/cpp.py:21 in public method `cpp_dict`: D102: Missing docstring in public method torch/nn/cpp.py:27 in public method `items`: D102: Missing docstring in public method torch/nn/cpp.py:30 in public method `keys`: D102: Missing docstring in public method torch/nn/cpp.py:33 in public method `values`: D102: Missing docstring in public method torch/nn/cpp.py:36 in public method `__iter__`: D105: Missing docstring in magic method torch/nn/cpp.py:39 in public method `__len__`: D105: Missing docstring in magic method torch/nn/cpp.py:42 in public method `__contains__`: D105: Missing docstring in magic method torch/nn/cpp.py:45 in public method `__getitem__`: D105: Missing docstring in magic method torch/nn/cpp.py:52 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/cpp.py:80 in public method `training`: D102: Missing docstring in public method torch/nn/cpp.py:87 in public method `__repr__`: D105: Missing docstring in magic method 12 ``` - `torch/nn/grad.py` </br> **Before: 10** ``` torch/nn/grad.py:1 at module level: D400: First line should end with a period (not 'e') torch/nn/grad.py:8 in public function `conv1d_input`: D205: 1 blank line required between summary line and description (found 0) torch/nn/grad.py:8 in public function `conv1d_input`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch/nn/grad.py:40 in public function `conv1d_weight`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch/nn/grad.py:71 in public function `conv2d_input`: D205: 1 blank line required between summary line and description (found 0) torch/nn/grad.py:71 in public function `conv2d_input`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch/nn/grad.py:103 in public function `conv2d_weight`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch/nn/grad.py:134 in public function `conv3d_input`: D205: 1 blank line required between summary line and description (found 0) torch/nn/grad.py:134 in public function `conv3d_input`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch/nn/grad.py:166 in public function `conv3d_weight`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') 10 ``` **After: 0** - `torch/nn/parameter.py` </br> **Before: 17** ``` torch/nn/parameter.py:1 at module level: D100: Missing docstring in public module torch/nn/parameter.py:14 in public class `Parameter`: D204: 1 blank line required after class docstring (found 0) torch/nn/parameter.py:33 in public method `__new__`: D102: Missing docstring in public method torch/nn/parameter.py:54 in public method `__deepcopy__`: D105: Missing docstring in magic method torch/nn/parameter.py:62 in public method `__repr__`: D105: Missing docstring in magic method torch/nn/parameter.py:65 in public method `__reduce_ex__`: D105: Missing docstring in magic method torch/nn/parameter.py:84 in public class `UninitializedTensorMixin`: D101: Missing docstring in public class torch/nn/parameter.py:105 in public method `materialize`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parameter.py:125 in public method `shape`: D102: Missing docstring in public method torch/nn/parameter.py:132 in public method `share_memory_`: D102: Missing docstring in public method torch/nn/parameter.py:138 in public method `__repr__`: D105: Missing docstring in magic method torch/nn/parameter.py:141 in public method `__reduce_ex__`: D105: Missing docstring in magic method torch/nn/parameter.py:149 in public method `__torch_function__`: D105: Missing docstring in magic method torch/nn/parameter.py:164 in public function `is_lazy`: D103: Missing docstring in public function torch/nn/parameter.py:186 in public method `__new__`: D102: Missing docstring in public method torch/nn/parameter.py:191 in public method `__deepcopy__`: D105: Missing docstring in magic method torch/nn/parameter.py:217 in public method `__new__`: D102: Missing docstring in public method 17 ``` **After: 15** ``` torch/nn/parameter.py:1 at module level: D100: Missing docstring in public module torch/nn/parameter.py:34 in public method `__new__`: D102: Missing docstring in public method torch/nn/parameter.py:55 in public method `__deepcopy__`: D105: Missing docstring in magic method torch/nn/parameter.py:63 in public method `__repr__`: D105: Missing docstring in magic method torch/nn/parameter.py:66 in public method `__reduce_ex__`: D105: Missing docstring in magic method torch/nn/parameter.py:85 in public class `UninitializedTensorMixin`: D101: Missing docstring in public class torch/nn/parameter.py:127 in public method `shape`: D102: Missing docstring in public method torch/nn/parameter.py:134 in public method `share_memory_`: D102: Missing docstring in public method torch/nn/parameter.py:140 in public method `__repr__`: D105: Missing docstring in magic method torch/nn/parameter.py:143 in public method `__reduce_ex__`: D105: Missing docstring in magic method torch/nn/parameter.py:151 in public method `__torch_function__`: D105: Missing docstring in magic method torch/nn/parameter.py:166 in public function `is_lazy`: D103: Missing docstring in public function torch/nn/parameter.py:188 in public method `__new__`: D102: Missing docstring in public method torch/nn/parameter.py:193 in public method `__deepcopy__`: D105: Missing docstring in magic method torch/nn/parameter.py:219 in public method `__new__`: D102: Missing docstring in public method 15 ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/113052 Approved by: https://github.com/mikaylagawarecki, https://github.com/soulitzer |
||
|
markstur
|
5540d276ce |
Fix docstring errors in container.py, _functions.py, transformer.py, comm.py, parallel_apply.py, data_parallel.py, scatter_gather.py (#113250)
Fix docstring errors in container.py, _functions.py, transformer.py, comm.py, parallel_apply.py, data_parallel.py, scatter_gather.py Fixes #112603 Pull Request resolved: https://github.com/pytorch/pytorch/pull/113250 Approved by: https://github.com/mikaylagawarecki |
||
|
giacomo
|
7b28f8c5ea |
Better error message when applying interpolation on non-4D tensors (#113459)
Fixes #113445 Pull Request resolved: https://github.com/pytorch/pytorch/pull/113459 Approved by: https://github.com/albanD |
||
|
Alperen ÜNLÜ
|
cb233dada4 |
Fix docstrings on torch/nn/modules (#113260)
Fixes #112598 ## Description Fixes the docstrings on following files. ```bash pydocstyle path-to-file --count ``` | File | Count | | ------------------------------------- | ------- | | torch/nn/modules/adaptive.py | 20 -> 4 | | torch/nn/modules/channelshuffle.py | 7 -> 4 | | torch/nn/modules/conv.py | 37 -> 25 | | torch/nn/modules/distance.py | 7 -> 5 | | torch/nn/modules/dropout.py | 17 -> 7 | | torch/nn/modules/flatten.py | 10 -> 7 | | torch/nn/modules/fold.py | 11 -> 7 | | torch/nn/modules/instancenorm.py | 13 -> 1 | | torch/nn/modules/lazy.py | 11 -> 2 | | torch/nn/modules/linear.py | 20 -> 14 | | torch/nn/modules/normalization.py | 25 -> 16 | | torch/nn/modules/padding.py | 33 -> 19 | Pull Request resolved: https://github.com/pytorch/pytorch/pull/113260 Approved by: https://github.com/mikaylagawarecki |
||
|
wz337
|
f2963642c2 |
[DDP] Add device_mesh to DDP ctor (#112761)
As title. Pull Request resolved: https://github.com/pytorch/pytorch/pull/112761 Approved by: https://github.com/fegin |
||
|
NVS Abhilash
|
eb5487361d |
docs: fix docstring errors in quantized modules and others (#112695)
Fixes #112632 Before: 171 ``` torch/backends/_nnapi/prepare.py:24 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/_nnapi/prepare.py:46 in public method `init`: D102: Missing docstring in public method torch/backends/_nnapi/prepare.py:60 in public method `forward`: D102: Missing docstring in public method torch/backends/_nnapi/prepare.py:94 in public function `convert_model_to_nnapi`: D103: Missing docstring in public function torch/backends/_nnapi/prepare.py:153 in public function `process_for_nnapi`: D103: Missing docstring in public function torch/backends/_nnapi/prepare.py:177 in private nested class `ShapeComputeModule`: D400: First line should end with a period (not 'n') torch/backends/_nnapi/serializer.py:19 in public class `NNAPI_OperandCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:35 in public class `NNAPI_OperationCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:133 in public class `NNAPI_FuseCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:140 in public class `OperandValueSourceType`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:150 in public class `TorchScalarTypes`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:154 in public function `approx_equal`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:158 in public function `tensor_size`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:172 in public function `change_element`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:194 in public class `DimOrder`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:225 in public method `use_nchw`: D102: Missing docstring in public method torch/backends/_nnapi/serializer.py:233 in public function `broadcast_shapes`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:260 in public function `get_conv_pool_shape`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:284 in public function `fix_shape`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:301 in public function `reverse_map_dim`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:312 in public function `flex_name`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:1337 in private method `_do_add_binary`: D400: First line should end with a period (not 's') torch/backends/_nnapi/serializer.py:1337 in private method `_do_add_binary`: D401: First line should be in imperative mood; try rephrasing (found 'Helper') torch/backends/_nnapi/serializer.py:2180 in public function `serialize_model`: D202: No blank lines allowed after function docstring (found 1) torch/backends/_nnapi/serializer.py:2180 in public function `serialize_model`: D205: 1 blank line required between summary line and description (found 0) torch/backends/_nnapi/serializer.py:2180 in public function `serialize_model`: D400: First line should end with a period (not ':') torch/backends/cuda/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/cuda/__init__.py:30 in public function `is_built`: D205: 1 blank line required between summary line and description (found 0) torch/backends/cuda/__init__.py:30 in public function `is_built`: D209: Multi-line docstring closing quotes should be on a separate line torch/backends/cuda/__init__.py:30 in public function `is_built`: D400: First line should end with a period (not 's') torch/backends/cuda/__init__.py:30 in public function `is_built`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/backends/cuda/__init__.py:37 in public class `cuFFTPlanCacheAttrContextProp`: D101: Missing docstring in public class torch/backends/cuda/__init__.py:40 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:44 in public method `__get__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:47 in public method `__set__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:54 in public class `cuFFTPlanCache`: D205: 1 blank line required between summary line and description (found 0) torch/backends/cuda/__init__.py:54 in public class `cuFFTPlanCache`: D400: First line should end with a period (not 'e') torch/backends/cuda/__init__.py:60 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:73 in public method `clear`: D102: Missing docstring in public method torch/backends/cuda/__init__.py:78 in public class `cuFFTPlanCacheManager`: D205: 1 blank line required between summary line and description (found 0) torch/backends/cuda/__init__.py:78 in public class `cuFFTPlanCacheManager`: D400: First line should end with a period (not ',') torch/backends/cuda/__init__.py:89 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:93 in public method `__getitem__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:106 in public method `__getattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:109 in public method `__setattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:116 in public class `cuBLASModule`: D101: Missing docstring in public class torch/backends/cuda/__init__.py:117 in public method `__getattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:126 in public method `__setattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:147 in public function `preferred_linalg_library`: D202: No blank lines allowed after function docstring (found 1) torch/backends/cuda/__init__.py:204 in public class `SDPBackend`: D204: 1 blank line required after class docstring (found 0) torch/backends/cudnn/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/cudnn/__init__.py:81 in public function `version`: D400: First line should end with a period (not 'N') torch/backends/cudnn/__init__.py:81 in public function `version`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/backends/cudnn/__init__.py:95 in public function `is_available`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/backends/cudnn/__init__.py:99 in public function `is_acceptable`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:122 in public function `set_flags`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:150 in public function `flags`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:174 in public class `CudnnModule`: D101: Missing docstring in public class torch/backends/cudnn/__init__.py:175 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkl/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/mkl/__init__.py:5 in public function `is_available`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/backends/mkl/__init__.py:14 in public class `verbose`: D205: 1 blank line required between summary line and description (found 0) torch/backends/mkl/__init__.py:14 in public class `verbose`: D400: First line should end with a period (not 'y') torch/backends/mkl/__init__.py:41 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkl/__init__.py:44 in public method `__enter__`: D105: Missing docstring in magic method torch/backends/mkl/__init__.py:53 in public method `__exit__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/mkldnn/__init__.py:9 in public function `is_available`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/backends/mkldnn/__init__.py:19 in public class `verbose`: D205: 1 blank line required between summary line and description (found 0) torch/backends/mkldnn/__init__.py:19 in public class `verbose`: D400: First line should end with a period (not 'y') torch/backends/mkldnn/__init__.py:47 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkldnn/__init__.py:50 in public method `__enter__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:59 in public method `__exit__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:64 in public function `set_flags`: D103: Missing docstring in public function torch/backends/mkldnn/__init__.py:71 in public function `flags`: D103: Missing docstring in public function torch/backends/mkldnn/__init__.py:81 in public class `MkldnnModule`: D101: Missing docstring in public class torch/backends/mkldnn/__init__.py:82 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/openmp/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/openmp/__init__.py:5 in public function `is_available`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/nn/intrinsic/qat/modules/conv_fused.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/intrinsic/qat/modules/linear_fused.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/intrinsic/qat/modules/linear_relu.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/__init__.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/dynamic/__init__.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/dynamic/modules/linear.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/modules/__init__.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/modules/conv.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/modules/embedding_ops.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/qat/modules/linear.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantizable/modules/activation.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantizable/modules/rnn.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/__init__.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/conv.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/linear.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/rnn.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/sparse.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/_reference/modules/utils.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/dynamic/modules/__init__.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/dynamic/modules/conv.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/dynamic/modules/linear.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/dynamic/modules/rnn.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/functional.py:1 at module level: D400: First line should end with a period (not 'l') torch/nn/quantized/modules/__init__.py:1 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/activation.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/batchnorm.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/conv.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/dropout.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/embedding_ops.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/functional_modules.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/linear.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/normalization.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/rnn.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/quantized/modules/utils.py:2 at module level: D400: First line should end with a period (not 's') torch/nn/utils/_expanded_weights/conv_utils.py:13 in public function `conv_picker`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:23 in public function `conv_args_and_kwargs`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:31 in public function `conv_normalizer`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:35 in public function `conv_input_for_string_padding`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:43 in public function `int_padding_for_string_padding`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:59 in public function `conv_padding_for_same`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:66 in public function `conv_backward`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:131 in public function `conv_unfold_weight_grad_sample`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:166 in public function `conv_group_weight_grad_sample`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:189 in public function `unfold3d`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/_expanded_weights/conv_utils.py:189 in public function `unfold3d`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_expanded_weights/conv_utils.py:189 in public function `unfold3d`: D401: First line should be in imperative mood (perhaps 'Extract', not 'Extracts') torch/nn/utils/_expanded_weights/expanded_weights_utils.py:6 in public function `is_batch_first`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:19 in public function `standard_kwargs`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_expanded_weights/expanded_weights_utils.py:19 in public function `standard_kwargs`: D300: Use """triple double quotes""" (found '''-quotes) torch/nn/utils/_expanded_weights/expanded_weights_utils.py:19 in public function `standard_kwargs`: D400: First line should end with a period (not 'e') torch/nn/utils/_expanded_weights/expanded_weights_utils.py:28 in public function `forward_helper`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_expanded_weights/expanded_weights_utils.py:28 in public function `forward_helper`: D300: Use """triple double quotes""" (found '''-quotes) torch/nn/utils/_expanded_weights/expanded_weights_utils.py:28 in public function `forward_helper`: D400: First line should end with a period (not ')') torch/nn/utils/_expanded_weights/expanded_weights_utils.py:84 in public function `maybe_scale_by_batch_size`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:90 in public function `set_grad_sample_if_exists`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:108 in public function `unpack_expanded_weight_or_tensor`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:123 in public function `sum_over_all_but_batch_and_last_n`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_expanded_weights/expanded_weights_utils.py:123 in public function `sum_over_all_but_batch_and_last_n`: D400: First line should end with a period (not 't') torch/nn/utils/_expanded_weights/expanded_weights_utils.py:123 in public function `sum_over_all_but_batch_and_last_n`: D401: First line should be in imperative mood (perhaps 'Calculate', not 'Calculates') torch/nn/utils/convert_parameters.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/convert_parameters.py:57 in private function `_check_param_device`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/convert_parameters.py:57 in private function `_check_param_device`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/convert_parameters.py:57 in private function `_check_param_device`: D400: First line should end with a period (not 'd') torch/nn/utils/convert_parameters.py:57 in private function `_check_param_device`: D401: First line should be in imperative mood; try rephrasing (found 'This') torch/nn/utils/rnn.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/rnn.py:28 in public class `PackedSequence`: D204: 1 blank line required after class docstring (found 0) torch/nn/utils/rnn.py:63 in public method `__new__`: D102: Missing docstring in public method torch/nn/utils/rnn.py:73 in public method `pin_memory`: D102: Missing docstring in public method torch/nn/utils/rnn.py:80 in public method `cuda`: D102: Missing docstring in public method torch/nn/utils/rnn.py:87 in public method `cpu`: D102: Missing docstring in public method torch/nn/utils/rnn.py:94 in public method `double`: D102: Missing docstring in public method torch/nn/utils/rnn.py:97 in public method `float`: D102: Missing docstring in public method torch/nn/utils/rnn.py:100 in public method `half`: D102: Missing docstring in public method torch/nn/utils/rnn.py:103 in public method `long`: D102: Missing docstring in public method torch/nn/utils/rnn.py:106 in public method `int`: D102: Missing docstring in public method torch/nn/utils/rnn.py:109 in public method `short`: D102: Missing docstring in public method torch/nn/utils/rnn.py:112 in public method `char`: D102: Missing docstring in public method torch/nn/utils/rnn.py:115 in public method `byte`: D102: Missing docstring in public method torch/nn/utils/rnn.py:119 in public method `to`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/rnn.py:119 in public method `to`: D401: First line should be in imperative mood (perhaps 'Perform', not 'Performs') torch/nn/utils/rnn.py:146 in public method `is_cuda`: D400: First line should end with a period (not 'u') torch/nn/utils/rnn.py:150 in public method `is_pinned`: D400: First line should end with a period (not 'y') torch/nn/utils/rnn.py:150 in public method `is_pinned`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/nn/utils/rnn.py:198 in public function `invert_permutation`: D103: Missing docstring in public function torch/nn/utils/rnn.py:274 in public function `pad_packed_sequence`: D401: First line should be in imperative mood (perhaps 'Pad', not 'Pads') torch/nn/utils/rnn.py:347 in public function `pad_sequence`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/rnn.py:347 in public function `pad_sequence`: D400: First line should end with a period (not '`') torch/nn/utils/rnn.py:408 in public function `unpad_sequence`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/rnn.py:408 in public function `unpad_sequence`: D400: First line should end with a period (not 's') torch/nn/utils/rnn.py:454 in public function `pack_sequence`: D400: First line should end with a period (not 's') torch/nn/utils/rnn.py:490 in public function `unpack_sequence`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/rnn.py:490 in public function `unpack_sequence`: D400: First line should end with a period (not 's') 171 ``` After: 81 ``` torch/backends/_nnapi/prepare.py:24 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/_nnapi/prepare.py:46 in public method `init`: D102: Missing docstring in public method torch/backends/_nnapi/prepare.py:60 in public method `forward`: D102: Missing docstring in public method torch/backends/_nnapi/prepare.py:94 in public function `convert_model_to_nnapi`: D103: Missing docstring in public function torch/backends/_nnapi/prepare.py:153 in public function `process_for_nnapi`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:19 in public class `NNAPI_OperandCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:35 in public class `NNAPI_OperationCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:133 in public class `NNAPI_FuseCode`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:140 in public class `OperandValueSourceType`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:150 in public class `TorchScalarTypes`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:154 in public function `approx_equal`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:158 in public function `tensor_size`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:172 in public function `change_element`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:194 in public class `DimOrder`: D101: Missing docstring in public class torch/backends/_nnapi/serializer.py:225 in public method `use_nchw`: D102: Missing docstring in public method torch/backends/_nnapi/serializer.py:233 in public function `broadcast_shapes`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:260 in public function `get_conv_pool_shape`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:284 in public function `fix_shape`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:301 in public function `reverse_map_dim`: D103: Missing docstring in public function torch/backends/_nnapi/serializer.py:312 in public function `flex_name`: D103: Missing docstring in public function torch/backends/cuda/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/cuda/__init__.py:39 in public class `cuFFTPlanCacheAttrContextProp`: D101: Missing docstring in public class torch/backends/cuda/__init__.py:42 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:46 in public method `__get__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:49 in public method `__set__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:63 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:76 in public method `clear`: D102: Missing docstring in public method torch/backends/cuda/__init__.py:91 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/cuda/__init__.py:95 in public method `__getitem__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:108 in public method `__getattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:111 in public method `__setattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:118 in public class `cuBLASModule`: D101: Missing docstring in public class torch/backends/cuda/__init__.py:119 in public method `__getattr__`: D105: Missing docstring in magic method torch/backends/cuda/__init__.py:128 in public method `__setattr__`: D105: Missing docstring in magic method torch/backends/cudnn/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/cudnn/__init__.py:99 in public function `is_acceptable`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:122 in public function `set_flags`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:150 in public function `flags`: D103: Missing docstring in public function torch/backends/cudnn/__init__.py:174 in public class `CudnnModule`: D101: Missing docstring in public class torch/backends/cudnn/__init__.py:175 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkl/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/mkl/__init__.py:42 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkl/__init__.py:45 in public method `__enter__`: D105: Missing docstring in magic method torch/backends/mkl/__init__.py:54 in public method `__exit__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:1 at module level: D104: Missing docstring in public package torch/backends/mkldnn/__init__.py:48 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/mkldnn/__init__.py:51 in public method `__enter__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:60 in public method `__exit__`: D105: Missing docstring in magic method torch/backends/mkldnn/__init__.py:65 in public function `set_flags`: D103: Missing docstring in public function torch/backends/mkldnn/__init__.py:72 in public function `flags`: D103: Missing docstring in public function torch/backends/mkldnn/__init__.py:82 in public class `MkldnnModule`: D101: Missing docstring in public class torch/backends/mkldnn/__init__.py:83 in public method `__init__`: D107: Missing docstring in __init__ torch/backends/openmp/__init__.py:1 at module level: D104: Missing docstring in public package torch/nn/utils/_expanded_weights/conv_utils.py:13 in public function `conv_picker`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:23 in public function `conv_args_and_kwargs`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:31 in public function `conv_normalizer`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:35 in public function `conv_input_for_string_padding`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:43 in public function `int_padding_for_string_padding`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:59 in public function `conv_padding_for_same`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:66 in public function `conv_backward`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:131 in public function `conv_unfold_weight_grad_sample`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/conv_utils.py:166 in public function `conv_group_weight_grad_sample`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:6 in public function `is_batch_first`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:87 in public function `maybe_scale_by_batch_size`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:93 in public function `set_grad_sample_if_exists`: D103: Missing docstring in public function torch/nn/utils/_expanded_weights/expanded_weights_utils.py:111 in public function `unpack_expanded_weight_or_tensor`: D103: Missing docstring in public function torch/nn/utils/convert_parameters.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/rnn.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/rnn.py:64 in public method `__new__`: D102: Missing docstring in public method torch/nn/utils/rnn.py:74 in public method `pin_memory`: D102: Missing docstring in public method torch/nn/utils/rnn.py:81 in public method `cuda`: D102: Missing docstring in public method torch/nn/utils/rnn.py:88 in public method `cpu`: D102: Missing docstring in public method torch/nn/utils/rnn.py:95 in public method `double`: D102: Missing docstring in public method torch/nn/utils/rnn.py:98 in public method `float`: D102: Missing docstring in public method torch/nn/utils/rnn.py:101 in public method `half`: D102: Missing docstring in public method torch/nn/utils/rnn.py:104 in public method `long`: D102: Missing docstring in public method torch/nn/utils/rnn.py:107 in public method `int`: D102: Missing docstring in public method torch/nn/utils/rnn.py:110 in public method `short`: D102: Missing docstring in public method torch/nn/utils/rnn.py:113 in public method `char`: D102: Missing docstring in public method torch/nn/utils/rnn.py:116 in public method `byte`: D102: Missing docstring in public method torch/nn/utils/rnn.py:198 in public function `invert_permutation`: D103: Missing docstring in public function 81 ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/112695 Approved by: https://github.com/mikaylagawarecki |
||
|
PyTorch MergeBot
|
9a28a7b498 |
Revert "Add support for torch.Generator type in TorchScript (#110413)"
This reverts commit
|
||
|
Edward Z. Yang
|
b4dbb02d46 |
Adjust _list_with_default to also work with SymInt input (#113073)
Fixes https://github.com/pytorch/pytorch/issues/112496 Signed-off-by: Edward Z. Yang <ezyang@meta.com> Pull Request resolved: https://github.com/pytorch/pytorch/pull/113073 Approved by: https://github.com/jbschlosser |
||
|
Aaron Gokaslan
|
8219bf051b |
[BE]: Apply RUF015 to torch folder (#113025)
Removes unnecessary allocations of iterators. There is a small chance this may have side effects as the entire iterator is no longer consumed, but this is a way more efficient method for retrieving the first element. Pull Request resolved: https://github.com/pytorch/pytorch/pull/113025 Approved by: https://github.com/ezyang, https://github.com/malfet |
||
|
Antonio Kim
|
27e31ab6e8 |
Add support for torch.Generator type in TorchScript (#110413)
- Add support for `torch.Generator` type in TorchScript - Add `generator` args to all `torch.nn.init` functions that call `uniform_` or `normal_` - Add support for `torch.Generator` in LTC's TorchScript backend (CC: @wconstab) CC: @eellison @davidberard98 @GlebKazantaev @behzad-a Pull Request resolved: https://github.com/pytorch/pytorch/pull/110413 Approved by: https://github.com/wconstab, https://github.com/albanD, https://github.com/glebk-cerebras, https://github.com/davidberard98 |
||
|
Senthil Kumar N
|
3f62531191 |
Fix: docstring errors in torch.nn.utils - parametrizations.py/prune.py/weight_norm.py (#113021)
Fixes #112631. As the previous PR #112943 has some accidental merge and it resolved through this PR. - torch/nn/utils/parametrizations.py **Before - 6** ``` torch\nn\utils\parametrizations.py:1 at module level: D100: Missing docstring in public module torch\nn\utils\parametrizations.py:23 in private function `_make_orthogonal`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\parametrizations.py:23 in private function `_make_orthogonal`: D210: No whitespaces allowed surrounding docstring text torch\nn\utils\parametrizations.py:178 in public function `orthogonal`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') torch\nn\utils\parametrizations.py:309 in public function `weight_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') torch\nn\utils\parametrizations.py:483 in public function `spectral_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') 6 ``` **After - 1** ``` torch\nn\utils\parametrizations.py:1 at module level: D100: Missing docstring in public module 1 ``` - torch/nn/utils/prune.py **Before - 100** ``` torch\nn\utils\prune.py:1 at module level: D200: One-line docstring should fit on one line with quotes (found 3) torch\nn\utils\prune.py:1 at module level: D400: First line should end with a period (not 's') torch\nn\utils\prune.py:13 in public class `BasePruningMethod`: D204: 1 blank line required after class docstring (found 0) torch\nn\utils\prune.py:21 in public method `__call__`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:21 in public method `__call__`: D400: First line should end with a period (not ')') torch\nn\utils\prune.py:34 in public method `compute_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:34 in public method `compute_mask`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch\nn\utils\prune.py:53 in public method `apply_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:53 in public method `apply_mask`: D400: First line should end with a period (not 'g') torch\nn\utils\prune.py:74 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:74 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:74 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:200 in public method `prune`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:200 in public method `prune`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:200 in public method `prune`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch\nn\utils\prune.py:229 in public method `remove`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:229 in public method `remove`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:229 in public method `remove`: D401: First line should be in imperative mood (perhaps 'Remove', not 'Removes') torch\nn\utils\prune.py:256 in public class `PruningContainer`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:264 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:277 in public method `add_pruning_method`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:297 in public method `__len__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:300 in public method `__iter__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:303 in public method `__getitem__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:307 in public method `compute_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:307 in public method `compute_mask`: D400: First line should end with a period (not 's') torch\nn\utils\prune.py:307 in public method `compute_mask`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') torch\nn\utils\prune.py:335 in private nested function `_combine_masks`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:335 in private nested function `_combine_masks`: D400: First line should end with a period (not ':') torch\nn\utils\prune.py:404 in public class `Identity`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:404 in public class `Identity`: D400: First line should end with a period (not 'e') torch\nn\utils\prune.py:410 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:416 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:416 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:416 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:442 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:447 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:469 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:469 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:469 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:486 in public class `L1Unstructured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:486 in public class `L1Unstructured`: D400: First line should end with a period (not 's') torch\nn\utils\prune.py:498 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:503 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:527 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:527 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:527 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:564 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:571 in public method `compute_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:571 in public method `compute_mask`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch\nn\utils\prune.py:634 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:634 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:634 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:653 in public class `LnStructured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:653 in public class `LnStructured`: D400: First line should end with a period (not 'r') torch\nn\utils\prune.py:669 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:677 in public method `compute_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:677 in public method `compute_mask`: D401: First line should be in imperative mood (perhaps 'Compute', not 'Computes') torch\nn\utils\prune.py:747 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:747 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:747 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:779 in public class `CustomFromMask`: D101: Missing docstring in public class torch\nn\utils\prune.py:783 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:786 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:793 in public method `apply`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:793 in public method `apply`: D400: First line should end with a period (not 'd') torch\nn\utils\prune.py:793 in public method `apply`: D401: First line should be in imperative mood (perhaps 'Add', not 'Adds') torch\nn\utils\prune.py:806 in public function `identity`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:806 in public function `identity`: D400: First line should end with a period (not 'e') torch\nn\utils\prune.py:806 in public function `identity`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') torch\nn\utils\prune.py:839 in public function `random_unstructured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:839 in public function `random_unstructured`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:874 in public function `l1_unstructured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:874 in public function `l1_unstructured`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:916 in public function `random_structured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:916 in public function `random_structured`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:955 in public function `ln_structured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:955 in public function `ln_structured`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:1000 in public function `global_unstructured`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1000 in public function `global_unstructured`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:1120 in public function `custom_from_mask`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1120 in public function `custom_from_mask`: D400: First line should end with a period (not '`') torch\nn\utils\prune.py:1154 in public function `remove`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1154 in public function `remove`: D400: First line should end with a period (not 'e') torch\nn\utils\prune.py:1154 in public function `remove`: D401: First line should be in imperative mood (perhaps 'Remove', not 'Removes') torch\nn\utils\prune.py:1184 in public function `is_pruned`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1184 in public function `is_pruned`: D400: First line should end with a period (not 'r') torch\nn\utils\prune.py:1211 in private function `_validate_pruning_amount_init`: D401: First line should be in imperative mood (perhaps 'Validate', not 'Validation') torch\nn\utils\prune.py:1243 in private function `_validate_pruning_amount`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1243 in private function `_validate_pruning_amount`: D400: First line should end with a period (not 'e') torch\nn\utils\prune.py:1243 in private function `_validate_pruning_amount`: D401: First line should be in imperative mood (perhaps 'Validate', not 'Validation') torch\nn\utils\prune.py:1265 in private function `_validate_structured_pruning`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1265 in private function `_validate_structured_pruning`: D400: First line should end with a period (not '-') torch\nn\utils\prune.py:1265 in private function `_validate_structured_pruning`: D401: First line should be in imperative mood (perhaps 'Validate', not 'Validation') torch\nn\utils\prune.py:1284 in private function `_compute_nparams_toprune`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1284 in private function `_compute_nparams_toprune`: D400: First line should end with a period (not 'a') torch\nn\utils\prune.py:1308 in private function `_validate_pruning_dim`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1308 in private function `_validate_pruning_dim`: D400: First line should end with a period (not ':') torch\nn\utils\prune.py:1318 in private function `_compute_norm`: D205: 1 blank line required between summary line and description (found 0) torch\nn\utils\prune.py:1318 in private function `_compute_norm`: D400: First line should end with a period (not 'n') 100 ``` **After - 14** ``` torch\nn\utils\prune.py:266 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:299 in public method `__len__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:302 in public method `__iter__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:305 in public method `__getitem__`: D105: Missing docstring in magic method torch\nn\utils\prune.py:411 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:445 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:450 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:502 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:507 in public method `compute_mask`: D102: Missing docstring in public method torch\nn\utils\prune.py:570 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:677 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:790 in public class `CustomFromMask`: D101: Missing docstring in public class torch\nn\utils\prune.py:794 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\prune.py:797 in public method `compute_mask`: D102: Missing docstring in public method 14 ``` - torch/nn/utils/weight_norm.py **Before - 10** ``` torch\nn\utils\weight_norm.py:1 at module level: D200: One-line docstring should fit on one line with quotes (found 3) torch\nn\utils\weight_norm.py:1 at module level: D400: First line should end with a period (not '8') torch\nn\utils\weight_norm.py:12 in public class `WeightNorm`: D101: Missing docstring in public class torch\nn\utils\weight_norm.py:16 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\weight_norm.py:23 in public method `compute_weight`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:29 in public method `apply`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:59 in public method `remove`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:66 in public method `__call__`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:73 in public function `weight_norm`: D401: First line should be in imperative mood (perhaps 'Apply', not 'Applies') torch\nn\utils\weight_norm.py:137 in public function `remove_weight_norm`: D401: First line should be in imperative mood (perhaps 'Remove', not 'Removes') 10 ``` **After - 6** ``` torch\nn\utils\weight_norm.py:10 in public class `WeightNorm`: D101: Missing docstring in public class torch\nn\utils\weight_norm.py:14 in public method `__init__`: D107: Missing docstring in __init__ torch\nn\utils\weight_norm.py:21 in public method `compute_weight`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:27 in public method `apply`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:57 in public method `remove`: D102: Missing docstring in public method torch\nn\utils\weight_norm.py:64 in public method `__call__`: D102: Missing docstring in public method 6 ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/113021 Approved by: https://github.com/lezcano |
||
|
stan
|
57a3af900e |
Add suggested changes to init.py (#112864)
A follow-up of PR #112617 on issue #112596 Added suggested changes from the review. - More specific on the type of uniform and normal distribution used. ```py def xavier_uniform_(tensor: Tensor, gain: float = 1.) -> Tensor: r"""Fill the input `Tensor` with values using a Xavier uniform distribution. The method is described in `Understanding the difficulty of training... """ ``` ```py def kaiming_normal_( tensor: Tensor, a: float = 0, mode: str = 'fan_in', nonlinearity: str = 'leaky_relu' ): r"""Fill the input `Tensor` with values using a Kaiming normal distribution. The method is described in `Delving deep into rectifiers: Surpassing... """ ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/112864 Approved by: https://github.com/kit1980 |
||
|
BJ Hargrave
|
a3db4377eb |
docs: Fix some docstring errors in torch.nn.utils parametrize/spectral_norm/stateless (#112786)
Fixes https://github.com/pytorch/pytorch/issues/112630 Pull Request resolved: https://github.com/pytorch/pytorch/pull/112786 Approved by: https://github.com/lezcano |
||
|
isdanni
|
43fb5147e2 |
[BE] Enable Ruff's Flake8 PYI001 (#112823)
Enable [unprefixed-type-param (PYI001)](https://docs.astral.sh/ruff/rules/unprefixed-type-param/#unprefixed-type-param-pyi001) Link: #110950 Pull Request resolved: https://github.com/pytorch/pytorch/pull/112823 Approved by: https://github.com/Skylion007 |
||
|
stanleyedward
|
12dab00173 |
Fix Docstring errors in init.py (#112617)
Fixes #112596 Fix docstring errors in init.py ### Before the change -> 38 errors ``` ╭─user@pc ~/Path/to/pytorch ‹fix/docstring_init› ╰─➤ pydocstyle torch/nn/init.py --count 127 ↵ torch/nn/init.py:1 at module level: D100: Missing docstring in public module torch/nn/init.py:68 in public function `calculate_gain`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:123 in public function `uniform_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:123 in public function `uniform_`: D400: First line should end with a period (not 'm') torch/nn/init.py:123 in public function `uniform_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:141 in public function `normal_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:141 in public function `normal_`: D400: First line should end with a period (not 'l') torch/nn/init.py:141 in public function `normal_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:165 in public function `trunc_normal_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:165 in public function `trunc_normal_`: D400: First line should end with a period (not 'd') torch/nn/init.py:165 in public function `trunc_normal_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:187 in public function `constant_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:203 in public function `ones_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:216 in public function `zeros_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:229 in public function `eye_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:229 in public function `eye_`: D400: First line should end with a period (not 'y') torch/nn/init.py:229 in public function `eye_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:249 in public function `dirac_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:249 in public function `dirac_`: D400: First line should end with a period (not 'c') torch/nn/init.py:249 in public function `dirac_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:311 in public function `xavier_uniform_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:311 in public function `xavier_uniform_`: D400: First line should end with a period (not 'd') torch/nn/init.py:311 in public function `xavier_uniform_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:338 in public function `xavier_normal_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:338 in public function `xavier_normal_`: D400: First line should end with a period (not 'd') torch/nn/init.py:338 in public function `xavier_normal_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:376 in public function `kaiming_uniform_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:376 in public function `kaiming_uniform_`: D400: First line should end with a period (not 'd') torch/nn/init.py:376 in public function `kaiming_uniform_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:425 in public function `kaiming_normal_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:425 in public function `kaiming_normal_`: D400: First line should end with a period (not 'd') torch/nn/init.py:425 in public function `kaiming_normal_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:462 in public function `orthogonal_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:462 in public function `orthogonal_`: D400: First line should end with a period (not 's') torch/nn/init.py:462 in public function `orthogonal_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') torch/nn/init.py:507 in public function `sparse_`: D205: 1 blank line required between summary line and description (found 0) torch/nn/init.py:507 in public function `sparse_`: D400: First line should end with a period (not 'e') torch/nn/init.py:507 in public function `sparse_`: D401: First line should be in imperative mood (perhaps 'Fill', not 'Fills') 38 ``` ### After the change -> 0 errors ``` ╭─user@pc ~/Path/to/pytorch ‹fix/docstring_init*› ╰─➤ pydocstyle torch/nn/init.py --count 0 ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/112617 Approved by: https://github.com/mikaylagawarecki |
||
|
Adrian Wälchli
|
157bda1bf0 |
Fix pydocstyle errors in torch/nn/module (#112674)
Fixes #112601 ``` pydocstyle torch/nn/modules/module.py --count ``` On master: 115 After my changes on this PR: 8 The remaining 8 are due to missing docstrings in the magic methods: ``` torch/nn/modules/module.py:1 at module level: D100: Missing docstring in public module torch/nn/modules/module.py:1635 in public method `__getstate__`: D105: Missing docstring in magic method torch/nn/modules/module.py:1640 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/modules/module.py:1674 in public method `__getattr__`: D105: Missing docstring in magic method torch/nn/modules/module.py:1689 in public method `__setattr__`: D105: Missing docstring in magic method torch/nn/modules/module.py:1748 in public method `__delattr__`: D105: Missing docstring in magic method torch/nn/modules/module.py:2480 in public method `__repr__`: D105: Missing docstring in magic method torch/nn/modules/module.py:2505 in public method `__dir__`: D105: Missing docstring in magic method ``` Should I add them too? Happy to do it, I just wasn't sure if you wanted these documented. Please let me know. Pull Request resolved: https://github.com/pytorch/pytorch/pull/112674 Approved by: https://github.com/mikaylagawarecki |
||
|
NVS Abhilash
|
db66f15785 |
docs: fix docstrings in distributed.py and others (fixes #112604) (#112657)
Fixes #112604 Fixes docstring by following `pydocstyle` outputs. - torch/nn/parallel/distributed.py Before: 84 ``` torch/nn/parallel/distributed.py:1 at module level: D100: Missing docstring in public module torch/nn/parallel/distributed.py:92 in private function `_cast_buffers`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:103 in private function `_setup_mixed_precision_params`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:103 in private function `_setup_mixed_precision_params`: D401: First line should be in imperative mood (perhaps 'Create', not 'Creates') torch/nn/parallel/distributed.py:143 in private function `_find_tensors`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:273 in private method `__init__`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:273 in private method `__init__`: D401: First line should be in imperative mood (perhaps 'Set', not 'Sets') torch/nn/parallel/distributed.py:287 in private method `main_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:287 in private method `main_hook`: D400: First line should end with a period (not 'd') torch/nn/parallel/distributed.py:324 in private method `post_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:324 in private method `post_hook`: D400: First line should end with a period (not 'l') torch/nn/parallel/distributed.py:324 in private method `post_hook`: D401: First line should be in imperative mood (perhaps 'Sync', not 'Syncs') torch/nn/parallel/distributed.py:332 in public class `DistributedDataParallel`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:332 in public class `DistributedDataParallel`: D400: First line should end with a period (not 'n') torch/nn/parallel/distributed.py:633 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/parallel/distributed.py:960 in private method `_fire_reducer_autograd_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:960 in private method `_fire_reducer_autograd_hook`: D401: First line should be in imperative mood (perhaps 'Fire', not 'Fires') torch/nn/parallel/distributed.py:969 in private method `_root_copy_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:969 in private method `_root_copy_hook`: D400: First line should end with a period (not 's') torch/nn/parallel/distributed.py:1012 in private method `_module_wait_for_copy_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1012 in private method `_module_wait_for_copy_hook`: D400: First line should end with a period (not 'e') torch/nn/parallel/distributed.py:1050 in private method `_ddp_init_helper`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1050 in private method `_ddp_init_helper`: D400: First line should end with a period (not ':') torch/nn/parallel/distributed.py:1050 in private method `_ddp_init_helper`: D401: First line should be in imperative mood (perhaps 'Initialize', not 'Initialization') torch/nn/parallel/distributed.py:1146 in public method `__getstate__`: D105: Missing docstring in magic method torch/nn/parallel/distributed.py:1154 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/parallel/distributed.py:1222 in private method `_assign_modules_buffers`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1222 in private method `_assign_modules_buffers`: D400: First line should end with a period (not 'o') torch/nn/parallel/distributed.py:1222 in private method `_assign_modules_buffers`: D401: First line should be in imperative mood (perhaps 'Assign', not 'Assigns') torch/nn/parallel/distributed.py:1277 in private method `_get_parameters`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:1277 in private method `_get_parameters`: D400: First line should end with a period (not 's') torch/nn/parallel/distributed.py:1277 in private method `_get_parameters`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/nn/parallel/distributed.py:1312 in public method `no_sync`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1312 in public method `no_sync`: D400: First line should end with a period (not 'P') torch/nn/parallel/distributed.py:1312 in public method `no_sync`: D401: First line should be in imperative mood; try rephrasing (found 'A') torch/nn/parallel/distributed.py:1340 in private method `_get_active_ddp_module`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:1340 in private method `_get_active_ddp_module`: D403: First word of the first line should be properly capitalized ('Torchdynamo', not 'TorchDynamo') torch/nn/parallel/distributed.py:1517 in public method `forward`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1527 in public method `scatter`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1530 in public method `to_kwargs`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1539 in public method `gather`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1542 in public method `train`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1617 in public method `join`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1617 in public method `join`: D400: First line should end with a period (not 'f') torch/nn/parallel/distributed.py:1617 in public method `join`: D401: First line should be in imperative mood; try rephrasing (found 'A') torch/nn/parallel/distributed.py:1723 in public method `join_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1723 in public method `join_hook`: D400: First line should end with a period (not 'y') torch/nn/parallel/distributed.py:1723 in public method `join_hook`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/nn/parallel/distributed.py:1752 in public method `join_device`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1756 in public method `join_process_group`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1765 in private method `_register_buffer_comm_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1765 in private method `_register_buffer_comm_hook`: D400: First line should end with a period (not 'e') torch/nn/parallel/distributed.py:1765 in private method `_register_buffer_comm_hook`: D401: First line should be in imperative mood (perhaps 'Allow', not 'Allows') torch/nn/parallel/distributed.py:1805 in public method `register_comm_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1805 in public method `register_comm_hook`: D400: First line should end with a period (not 'a') torch/nn/parallel/distributed.py:1805 in public method `register_comm_hook`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/nn/parallel/distributed.py:1887 in private method `_register_builtin_comm_hook`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1887 in private method `_register_builtin_comm_hook`: D400: First line should end with a period (not 'P') torch/nn/parallel/distributed.py:1887 in private method `_register_builtin_comm_hook`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/nn/parallel/distributed.py:1914 in private method `_register_fused_optim`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:1914 in private method `_register_fused_optim`: D400: First line should end with a period (not 'a') torch/nn/parallel/distributed.py:1914 in private method `_register_fused_optim`: D401: First line should be in imperative mood (perhaps 'Register', not 'Registers') torch/nn/parallel/distributed.py:2005 in public method `will_sync_module_buffers`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:2060 in private method `_default_broadcast_coalesced`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2060 in private method `_default_broadcast_coalesced`: D400: First line should end with a period (not 'e') torch/nn/parallel/distributed.py:2128 in private method `_get_data_parallel_params`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:2128 in private method `_get_data_parallel_params`: D401: First line should be in imperative mood (perhaps 'Return', not 'Returns') torch/nn/parallel/distributed.py:2141 in private method `_set_params_and_buffers_to_ignore_for_model`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2141 in private method `_set_params_and_buffers_to_ignore_for_model`: D400: First line should end with a period (not 'r') torch/nn/parallel/distributed.py:2141 in private method `_set_params_and_buffers_to_ignore_for_model`: D401: First line should be in imperative mood (perhaps 'Set', not 'Sets') torch/nn/parallel/distributed.py:2170 in private method `_get_ddp_logging_data`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2170 in private method `_get_ddp_logging_data`: D400: First line should end with a period (not 's') torch/nn/parallel/distributed.py:2170 in private method `_get_ddp_logging_data`: D401: First line should be in imperative mood; try rephrasing (found 'This') torch/nn/parallel/distributed.py:2184 in private method `_set_ddp_runtime_logging_sample_rate`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2184 in private method `_set_ddp_runtime_logging_sample_rate`: D400: First line should end with a period (not 'g') torch/nn/parallel/distributed.py:2184 in private method `_set_ddp_runtime_logging_sample_rate`: D401: First line should be in imperative mood; try rephrasing (found 'This') torch/nn/parallel/distributed.py:2202 in private method `_set_static_graph`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2202 in private method `_set_static_graph`: D400: First line should end with a period (not 'l') torch/nn/parallel/distributed.py:2202 in private method `_set_static_graph`: D401: First line should be in imperative mood; try rephrasing (found 'It') torch/nn/parallel/distributed.py:2227 in private method `_remove_autograd_hooks`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/parallel/distributed.py:2227 in private method `_remove_autograd_hooks`: D401: First line should be in imperative mood (perhaps 'Remove', not 'Removes') torch/nn/parallel/distributed.py:2233 in private method `_check_reducer_finalized`: D205: 1 blank line required between summary line and description (found 0) torch/nn/parallel/distributed.py:2233 in private method `_check_reducer_finalized`: D400: First line should end with a period (not 'd') torch/nn/parallel/distributed.py:2233 in private method `_check_reducer_finalized`: D401: First line should be in imperative mood (perhaps 'Check', not 'Checks') 84 ``` After: 12 ``` torch/nn/parallel/distributed.py:1 at module level: D100: Missing docstring in public module torch/nn/parallel/distributed.py:618 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/parallel/distributed.py:1133 in public method `__getstate__`: D105: Missing docstring in magic method torch/nn/parallel/distributed.py:1141 in public method `__setstate__`: D105: Missing docstring in magic method torch/nn/parallel/distributed.py:1503 in public method `forward`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1513 in public method `scatter`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1516 in public method `to_kwargs`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1525 in public method `gather`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1528 in public method `train`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1734 in public method `join_device`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1738 in public method `join_process_group`: D102: Missing docstring in public method torch/nn/parallel/distributed.py:1986 in public method `will_sync_module_buffers`: D102: Missing docstring in public method 12 ``` - torch/nn/utils/_named_member_accessor.py Before: 23 ``` torch/nn/utils/_named_member_accessor.py:12 in public function `set_tensor`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:29 in public function `swap_tensor`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:85 in public function `swap_submodule`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:109 in public class `NamedMemberAccessor`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:109 in public class `NamedMemberAccessor`: D400: First line should end with a period (not 's') torch/nn/utils/_named_member_accessor.py:115 in public method `__init__`: D107: Missing docstring in __init__ torch/nn/utils/_named_member_accessor.py:122 in public method `get_submodule`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:155 in public method `swap_submodule`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:164 in public method `get_tensor`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:185 in public method `set_tensor`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:194 in public method `del_tensor`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:211 in public method `swap_tensor`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:224 in public method `get_tensors`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:233 in public method `set_tensors`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:249 in public method `set_tensors_dict`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:261 in public method `del_tensors`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:276 in public method `swap_tensors`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:296 in public method `swap_tensors_dict`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_named_member_accessor.py:325 in public method `check_keys`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/utils/_named_member_accessor.py:340 in public method `named_parameters`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/utils/_named_member_accessor.py:349 in public method `named_buffers`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/utils/_named_member_accessor.py:358 in public method `named_tensors`: D200: One-line docstring should fit on one line with quotes (found 3) torch/nn/utils/_named_member_accessor.py:368 in public method `named_modules`: D200: One-line docstring should fit on one line with quotes (found 3) 23 ``` After: 4 ``` torch/nn/utils/_named_member_accessor.py:12 in public function `set_tensor`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:29 in public function `swap_tensor`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:85 in public function `swap_submodule`: D103: Missing docstring in public function torch/nn/utils/_named_member_accessor.py:116 in public method `__init__`: D107: Missing docstring in __init__ 4 ``` - torch/nn/utils/_per_sample_grad.py Before: 3 ``` torch/nn/utils/_per_sample_grad.py:12 in public function `call_for_per_sample_grads`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/_per_sample_grad.py:12 in public function `call_for_per_sample_grads`: D400: First line should end with a period (not ')') torch/nn/utils/_per_sample_grad.py:12 in public function `call_for_per_sample_grads`: D402: First line should not be the function's "signature" 3 ``` After: 0 ``` 0 ``` - torch/nn/utils/init.py Before: 3 ``` torch/nn/utils/init.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/init.py:6 in public function `skip_init`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/init.py:6 in public function `skip_init`: D400: First line should end with a period (not 'g') 3 ``` After: 1 ``` torch/nn/utils/init.py:1 at module level: D100: Missing docstring in public module 1 ``` - torch/nn/utils/memory_format.py Before: 4 ``` torch/nn/utils/memory_format.py:1 at module level: D100: Missing docstring in public module torch/nn/utils/memory_format.py:5 in public function `convert_conv2d_weight_memory_format`: D202: No blank lines allowed after function docstring (found 1) torch/nn/utils/memory_format.py:5 in public function `convert_conv2d_weight_memory_format`: D205: 1 blank line required between summary line and description (found 0) torch/nn/utils/memory_format.py:5 in public function `convert_conv2d_weight_memory_format`: D400: First line should end with a period (not '`') 4 ``` After: 1 ``` torch/nn/utils/memory_format.py:1 at module level: D100: Missing docstring in public module 1 ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/112657 Approved by: https://github.com/fduwjj |
||
|
Peter Bell
|
66c32d099a |
Use pytree.arg_tree_leaves everywhere (#112394)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/112394 Approved by: https://github.com/lezcano ghstack dependencies: #112391, #112392, #112393 |
||
|
Peter Bell
|
bbd5b935e4 |
Use pytree.tree_leaves everywhere (#112324)
This changes all the instances I could find of `tree_flatten(...)[0]` or `x, _ = tree_flatten` to use `tree_leaves`. Pull Request resolved: https://github.com/pytorch/pytorch/pull/112324 Approved by: https://github.com/lezcano ghstack dependencies: #112327, #112323 |
||
|
XiaobingSuper
|
395614c1a4 |
keep sync bn training flag same with converted bn's training flag (#111998)
When converting bn to sync bn, we need to keep sync bn's training flag with the original bn flag, the motivation is there in case the given origin model has set some bn training flag and others are not seated, after we convert sync bn, we hoping not to change this behavior. Pull Request resolved: https://github.com/pytorch/pytorch/pull/111998 Approved by: https://github.com/mikaylagawarecki |
||
|
Oleg Bulatov
|
192477b5ba |
Enable flake8-bugbear B020 lint (#110823)
Fixes part of https://github.com/pytorch/pytorch/issues/106571 Pull Request resolved: https://github.com/pytorch/pytorch/pull/110823 Approved by: https://github.com/Skylion007 |
||
|
FFFrog
|
0e0f6a248d |
Fix num_batches_tracked of BatchNorm when load_state_dict (#110850)
Fixes #110361 as the title shown Pull Request resolved: https://github.com/pytorch/pytorch/pull/110850 Approved by: https://github.com/mikaylagawarecki |
||
|
Federico Galatolo
|
d118531733 |
Use \odot everywhere instead of mixing \odot and * for the Hadamard product (#111763)
This pull request addresses an inconsistency in the representation of the Hadamard product across PyTorch documentation. Currently, the notation varies among different modules: - In `torch.nn.LSTM` documentation the Hadamard product is represented with $\odot$ - In `torch.nn.GRU` documentation the Hadamard product is represented with $*$ - In `torch.nn.LSTMCell` documentation the Hadamard product is represented with $*$ - In `torch.nn.GRUCell` documentation the Hadamard product is represented with $*$ - In `torch.ao.nn.quantized.dynamic.GRU` documentation the Hadamard product is represented with $*$ This PR proposes consistently representing the Hadamard product throughout the documentation to enhance clarity and align with established standards. The notation $\odot$ will be uniformly adopted, following the convention in the [Deep Learning Book](https://www.deeplearningbook.org/contents/linear_algebra.html). **Changes Made:** - Modified `torch.nn.GRU` documentation to represent the Hadamard product with $\odot$ - Modified `torch.nn.LSTMCell` documentation to represent the Hadamard product with $\odot$ - Modified `torch.nn.GRUCell` documentation to represent the Hadamard product with $\odot$ - Modified `torch.ao.nn.quantized.dynamic.GRU` documentation to represent the Hadamard product with $\odot$ Pull Request resolved: https://github.com/pytorch/pytorch/pull/111763 Approved by: https://github.com/albanD |
||
|
Aaron Gokaslan
|
cb856b08b2 |
[BE]: Attach cause to some exceptions and enable RUFF TRY200 (#111496)
Did some easy fixes from enabling TRY200. Most of these seem like oversights instead of intentional. The proper way to silence intentional errors is with `from None` to note that you thought about whether it should contain the cause and decided against it. Pull Request resolved: https://github.com/pytorch/pytorch/pull/111496 Approved by: https://github.com/malfet |
||
|
Aniket Patil
|
6f06832219 |
Fixed typo in activation.py (#111358)
liner -> linear Pull Request resolved: https://github.com/pytorch/pytorch/pull/111358 Approved by: https://github.com/mikaylagawarecki |
||
|
isdanni
|
382327bd0e |
[BE] Enable Ruff's Flake8 PYI034 (#111105)
Enable [non-self-return-type (PYI034)](https://docs.astral.sh/ruff/rules/non-self-return-type/#non-self-return-type-pyi034) Link: #110950 **EDIT**: to newly added reviewers, please ignore the request, it's due to a rebase error 😅 Pull Request resolved: https://github.com/pytorch/pytorch/pull/111105 Approved by: https://github.com/Skylion007 |