Repository: pytorch
Issue: Fix docstring errors in _common_utils.py, _optim_utils.py, _wrap_utils.py, _unshard_param_utils.py, _fsdp_extensions.py, api.py, _debug_utils.py, _utils.py, wrap.py, sharded_grad_scaler.py
Labels: module: docs,triaged,medium,docathon-h2-2023

Please fix the following issues.
First, make sure to install the required tools:
```
pip3 install pydocstyle
```
```
pip3 install ruff
```
Then complete the followings steps:
 1. Run `pydocstyle` to see the number of errors in the file: 
 ```
pydocstyle path-to-file --count
```
 &nbsp; &nbsp; This command prints out the number of errors at the end of the output. Save this output to later add it to your PR description.
2. Next, run `ruff` which should help autofix many of these errors:
```
ruff --select RULECODE --fix path_to_file
```
&nbsp; &nbsp; `RULECODE` is the error code from the output in the issue, for example, **D200**. See the complete list of rules and autofixes [here](https://docs.astral.sh/ruff/rules/#pydocstyle-d).
3. You can run the above command with the `--unsafe-fixes` option. Double-check that the applied fixes are correct.
4. Fix the remaining issues. Fix **only** the errors listed in the issue. Skip the 'Missing docstrings' errors.
5. Run pydocstyle again:
```
pydocstyle path-to-file --count
```
This **number might not be 0** which is **OK**. Add the count of fixed errors to your PR description. 
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_writeback_to_local_shard`, **Line**: 35, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_writeback_to_local_shard`, **Line**: 35, **Description**: First line should end with a period (not 'd')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_deregister_flat_param`, **Line**: 72, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_deregister_flat_param`, **Line**: 72, **Description**: First line should end with a period (not 't')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_register_flat_param`, **Line**: 86, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_register_flat_param`, **Line**: 86, **Description**: First line should end with a period (not 't')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_register_flat_param`, **Line**: 86, **Description**: First line should be in imperative mood (perhaps 'Register', not 'Registers')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unflatten_as_params`, **Line**: 102, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unflatten_as_params`, **Line**: 102, **Description**: First line should end with a period (not ',')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_fsdp_state_params`, **Line**: 167, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_fsdp_state_params`, **Line**: 167, **Description**: First line should end with a period (not 't')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_fsdp_state_params`, **Line**: 167, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params_recurse`, **Line**: 248, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params_recurse`, **Line**: 248, **Description**: First line should end with a period (not 's')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params_recurse`, **Line**: 248, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params`, **Line**: 310, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params`, **Line**: 310, **Description**: First line should end with a period (not 'n')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_unshard_params`, **Line**: 310, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D200**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_deregister_orig_params`, **Line**: 335, **Description**: One-line docstring should fit on one line with quotes (found 3)
- **Error Code**: **D200**, **File**: `torch/distributed/fsdp/_unshard_param_utils.py`, **Entity**: `_register_orig_params`, **Line**: 357, **Description**: One-line docstring should fit on one line with quotes (found 3)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_debug_utils.py`, **Entity**: `_get_sharded_module_tree_with_module_name_to_fqns`, **Line**: 15, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_debug_utils.py`, **Entity**: `_get_sharded_module_tree_with_module_name_to_fqns`, **Line**: 15, **Description**: First line should end with a period (not 's')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_debug_utils.py`, **Entity**: `_get_sharded_module_tree_with_module_name_to_fqns`, **Line**: 15, **Description**: First line should be in imperative mood; try rephrasing (found 'It')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `FullyShardedModuleState`, **Line**: 21, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `FullyShardedModuleState`, **Line**: 21, **Description**: First line should end with a period (not 'g')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_auto_wrap`, **Line**: 35, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_auto_wrap`, **Line**: 35, **Description**: First line should end with a period (not 'n')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_get_fully_sharded_module_to_states`, **Line**: 92, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_get_fully_sharded_module_to_states`, **Line**: 92, **Description**: First line should end with a period (not ',')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_get_fully_sharded_module_to_states`, **Line**: 92, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_record_module_wrapper_cls`, **Line**: 175, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_record_module_wrapper_cls`, **Line**: 175, **Description**: First line should end with a period (not '`')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_wrap_utils.py`, **Entity**: `_record_module_wrapper_cls`, **Line**: 175, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `always_wrap_policy`, **Line**: 36, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `always_wrap_policy`, **Line**: 36, **Description**: First line should end with a period (not 's')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `always_wrap_policy`, **Line**: 36, **Description**: First line should be in imperative mood; try rephrasing (found 'A')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_FSDPPolicy`, **Line**: 45, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_FSDPPolicy`, **Line**: 45, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_module_wrap_policy`, **Line**: 65, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_module_wrap_policy`, **Line**: 65, **Description**: First line should end with a period (not 'n')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_module_wrap_policy`, **Line**: 65, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `lambda_auto_wrap_policy`, **Line**: 112, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `lambda_auto_wrap_policy`, **Line**: 112, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `lambda_auto_wrap_policy`, **Line**: 112, **Description**: First line should be in imperative mood; try rephrasing (found 'A')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `transformer_auto_wrap_policy`, **Line**: 143, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `transformer_auto_wrap_policy`, **Line**: 143, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_or_policy`, **Line**: 170, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_or_policy`, **Line**: 170, **Description**: First line should end with a period (not 'f')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_or_policy`, **Line**: 170, **Description**: First line should be in imperative mood; try rephrasing (found 'A')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `size_based_auto_wrap_policy`, **Line**: 189, **Description**: First line should be in imperative mood; try rephrasing (found 'A')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `wrap`, **Line**: 276, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `wrap`, **Line**: 276, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_recursive_wrap`, **Line**: 334, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_recursive_wrap`, **Line**: 334, **Description**: First line should end with a period (not 's')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_recursive_wrap`, **Line**: 334, **Description**: First line should be in imperative mood (perhaps 'Wrap', not 'Wraps')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/wrap.py`, **Entity**: `_ConfigAutoWrap`, **Line**: 400, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `_GeneralMultiDeviceReplicator`, **Line**: 23, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `_GeneralMultiDeviceReplicator`, **Line**: 23, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `ShardedGradScaler`, **Line**: 35, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `ShardedGradScaler`, **Line**: 35, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `_amp_update_scale_cpu_`, **Line**: 297, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D202**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `update`, **Line**: 313, **Description**: No blank lines allowed after function docstring (found 1)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `update`, **Line**: 313, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/sharded_grad_scaler.py`, **Entity**: `update`, **Line**: 313, **Description**: First line should be in imperative mood (perhaps 'Update', not 'Updates')
- **Error Code**: **D200**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: ``, **Line**: 1, **Description**: One-line docstring should fit on one line with quotes (found 3)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_FSDPDeviceHandle`, **Line**: 47, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_FSDPDeviceHandle`, **Line**: 47, **Description**: First line should end with a period (not ',')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `from_device`, **Line**: 67, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `from_device`, **Line**: 67, **Description**: First line should end with a period (not ',')
- **Error Code**: **D200**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `TrainingState`, **Line**: 147, **Description**: One-line docstring should fit on one line with quotes (found 3)
- **Error Code**: **D200**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `HandleTrainingState`, **Line**: 157, **Description**: One-line docstring should fit on one line with quotes (found 3)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_module_handles`, **Line**: 175, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_module_handles`, **Line**: 175, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_module_handles`, **Line**: 175, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_has_fsdp_params`, **Line**: 191, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_sharding_strategy`, **Line**: 196, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_sharding_strategy`, **Line**: 196, **Description**: First line should end with a period (not '`')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_sharding_strategy`, **Line**: 196, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `clean_tensor_name`, **Line**: 218, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `clean_tensor_name`, **Line**: 218, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `clean_tensor_name`, **Line**: 218, **Description**: First line should be in imperative mood (perhaps 'Clean', not 'Cleans')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_set_fsdp_flattened`, **Line**: 231, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_set_fsdp_flattened`, **Line**: 231, **Description**: First line should end with a period (not 'o')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_set_fsdp_flattened`, **Line**: 231, **Description**: First line should be in imperative mood (perhaps 'Set', not 'Sets')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_is_fsdp_flattened`, **Line**: 239, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_named_parameters_with_duplicates`, **Line**: 246, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_named_parameters_with_duplicates`, **Line**: 246, **Description**: First line should end with a period (not 't')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_named_parameters_with_duplicates`, **Line**: 246, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_param_to_fqns`, **Line**: 266, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_param_to_fqns`, **Line**: 266, **Description**: First line should end with a period (not 'l')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_param_to_fqns`, **Line**: 266, **Description**: First line should be in imperative mood (perhaps 'Construct', not 'Constructs')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_apply_to_modules`, **Line**: 340, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_apply_to_modules`, **Line**: 340, **Description**: First line should end with a period (not 't')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_apply_to_modules`, **Line**: 340, **Description**: First line should be in imperative mood (perhaps 'Perform', not 'Performs')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_assert_in_training_states`, **Line**: 400, **Description**: First line should be in imperative mood (perhaps 'Assert', not 'Asserts')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_root_modules`, **Line**: 418, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_root_modules`, **Line**: 418, **Description**: First line should end with a period (not '
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_common_utils.py`, **Entity**: `_get_root_modules`, **Line**: 418, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_fsdp_extensions.py`, **Entity**: `FSDPExtensions`, **Line**: 16, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_fsdp_extensions.py`, **Entity**: `FSDPExtensions`, **Line**: 16, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_fsdp_extensions.py`, **Entity**: `pre_load_state_dict_transform`, **Line**: 56, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_fsdp_extensions.py`, **Entity**: `pre_load_state_dict_transform`, **Line**: 56, **Description**: First line should end with a period (not 'd')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_fsdp_extensions.py`, **Entity**: `pre_load_state_dict_transform`, **Line**: 56, **Description**: First line should be in imperative mood; try rephrasing (found 'This')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_ConsolidatedOptimState`, **Line**: 62, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_ConsolidatedOptimState`, **Line**: 62, **Description**: First line should end with a period (not '-')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_PosDimTensorInfo`, **Line**: 87, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_PosDimTensorInfo`, **Line**: 87, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_OptimStateKey`, **Line**: 103, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_OptimStateKey`, **Line**: 103, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_unflatten_optim_state`, **Line**: 119, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_unflatten_optim_state`, **Line**: 119, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_communicate_optim_state`, **Line**: 172, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_communicate_optim_state`, **Line**: 172, **Description**: First line should end with a period (not 'l')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_unflatten_communicated_optim_state`, **Line**: 243, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_unflatten_communicated_optim_state`, **Line**: 243, **Description**: First line should end with a period (not ',')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_shard_orig_param_state`, **Line**: 357, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_optim_state_dict`, **Line**: 393, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_optim_state_dict`, **Line**: 393, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_optim_state`, **Line**: 533, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_optim_state`, **Line**: 533, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_tensor_optim_state`, **Line**: 665, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_tensor_optim_state`, **Line**: 665, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_zero_dim_tensor_optim_state`, **Line**: 748, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_zero_dim_tensor_optim_state`, **Line**: 748, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_non_tensor_optim_state`, **Line**: 802, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_flatten_non_tensor_optim_state`, **Line**: 802, **Description**: First line should end with a period (not '`')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_rekey_sharded_optim_state_dict`, **Line**: 849, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_rekey_sharded_optim_state_dict`, **Line**: 849, **Description**: First line should end with a period (not 't')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_id_to_param_from_optim_input`, **Line**: 925, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_id_to_param_from_optim_input`, **Line**: 925, **Description**: First line should end with a period (not 'd')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_id_to_param_from_optim_input`, **Line**: 925, **Description**: First line should be in imperative mood (perhaps 'Construct', not 'Constructs')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_key_to_param`, **Line**: 1022, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_key_to_param`, **Line**: 1022, **Description**: First line should end with a period (not 'r')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_key_to_param`, **Line**: 1022, **Description**: First line should be in imperative mood (perhaps 'Construct', not 'Constructs')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_to_param_key`, **Line**: 1073, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_to_param_key`, **Line**: 1073, **Description**: First line should end with a period (not 'I')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_to_param_key`, **Line**: 1073, **Description**: First line should be in imperative mood (perhaps 'Construct', not 'Constructs')
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_param_to_param_id_from_optim_input`, **Line**: 1093, **Description**: First line should be in imperative mood (perhaps 'Construct', not 'Constructs')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_map_param_key_to_optim_keys`, **Line**: 1147, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_map_param_key_to_optim_keys`, **Line**: 1147, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_optim_state_dict`, **Line**: 1257, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_optim_state_dict`, **Line**: 1257, **Description**: First line should end with a period (not '`')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_fqn_to_fsdp_param_info`, **Line**: 1422, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_get_fqn_to_fsdp_param_info`, **Line**: 1422, **Description**: First line should end with a period (not '`')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_all_gather_optim_state`, **Line**: 1485, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_all_gather_optim_state`, **Line**: 1485, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/_optim_utils.py`, **Entity**: `_gather_orig_param_state`, **Line**: 1586, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D401**, **File**: `torch/distributed/fsdp/_utils.py`, **Entity**: `_same_storage`, **Line**: 48, **Description**: First line should be in imperative mood (perhaps 'Return', not 'Returns')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: ``, **Line**: 1, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: ``, **Line**: 1, **Description**: First line should end with a period (not 'e')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `ShardingStrategy`, **Line**: 33, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `ShardingStrategy`, **Line**: 33, **Description**: First line should end with a period (not 'y')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `BackwardPrefetch`, **Line**: 73, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `BackwardPrefetch`, **Line**: 73, **Description**: First line should end with a period (not 't')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `StateDictType`, **Line**: 237, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `StateDictType`, **Line**: 237, **Description**: First line should end with a period (not 's')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `StateDictConfig`, **Line**: 268, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `FullStateDictConfig`, **Line**: 281, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `FullStateDictConfig`, **Line**: 281, **Description**: First line should end with a period (not 'h')
- **Error Code**: **D205**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `OptimStateDictConfig`, **Line**: 323, **Description**: 1 blank line required between summary line and description (found 0)
- **Error Code**: **D400**, **File**: `torch/distributed/fsdp/api.py`, **Entity**: `OptimStateDictConfig`, **Line**: 323, **Description**: First line should end with a period (not 't')

cc @carljparker