Browse Source

docs(mge/python): add doc for zero_grad

GitOrigin-RevId: bb5154c0e7
tags/v0.4.0
Megvii Engine Team Xinran Xu 5 years ago
parent
commit
e729006f8e
1 changed files with 8 additions and 0 deletions
  1. +8
    -0
      python_module/megengine/functional/utils.py

+ 8
- 0
python_module/megengine/functional/utils.py View File

@@ -69,4 +69,12 @@ def accuracy(logits: Tensor, target: Tensor, topk: Union[int, Iterable[int]] = 1


@wrap_io_tensor @wrap_io_tensor
def zero_grad(inp: Tensor) -> Tensor: def zero_grad(inp: Tensor) -> Tensor:
r"""
Returns a tensor which is treated as constant during backward gradient calcuation,
i.e. its gradient is zero.

:param inp: Input tensor.

See implementation of :func:`~.softmax` for example.
"""
return mgb.opr.zero_grad(inp) return mgb.opr.zero_grad(inp)

Loading…
Cancel
Save