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

documentation update (#98782)

Browse Source 
change` parameters_and_buffers` to `parameter_and_buffer_dicts` in function docstring

Fixes #98766

Pull Request resolved: https://github.com/pytorch/pytorch/pull/98782
Approved by: https://github.com/ngimel, https://github.com/kit1980
This commit is contained in:
Das, Barun
2023-04-12 20:34:30 +00:00
committed by PyTorch MergeBot
parent 4828585019
commit a38ff4cfd1
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
torch/_functorch/functional_call.py
View File

@ -21,13 +21,13 @@ def functional_call(
and buffers with the provided ones.
.. note:: If the module has active parametrizations, passing a value in the
:attr:`parameters_and_buffers` argument with the name set to the regular parameter
:attr:`parameter_and_buffer_dicts` argument with the name set to the regular parameter
name will completely disable the parametrization.
If you want to apply the parametrization function to the value passed
please set the key as ``{submodule_name}.parametrizations.{parameter_name}.original``.
.. note:: If the module performs in-place operations on parameters/buffers, these will be reflected
in the ``parameters_and_buffers`` input.
in the ``parameter_and_buffer_dicts`` input.
Example::
@ -102,7 +102,7 @@ def functional_call(
Args:
module (torch.nn.Module): the module to call
parameters_and_buffers (Dict[str, Tensor] or tuple of Dict[str, Tensor]): the parameters that will be used in
parameters_and_buffer_dicts (Dict[str, Tensor] or tuple of Dict[str, Tensor]): the parameters that will be used in
the module call. If given a tuple of dictionaries, they must have distinct keys so that all dictionaries can
be used together
args (Any or tuple): arguments to be passed to the module call. If not a tuple, considered a single argument.