forked from mindspore-Ecosystem/mindspore
!3487 Modify comment of register_backward_hook
Merge pull request !3487 from Simson/push-to-opensource
This commit is contained in:
commit
57c00a77f1
|
@ -862,7 +862,7 @@ class Cell:
|
||||||
|
|
||||||
def register_backward_hook(self, fn):
|
def register_backward_hook(self, fn):
|
||||||
"""
|
"""
|
||||||
Set the cell backward hook function.
|
Set the cell backward hook function. Note that this function is only supported in Pynative Mode.
|
||||||
|
|
||||||
Note:
|
Note:
|
||||||
fn should be defined as following code shows, `cell_name` is the name of registered cell,
|
fn should be defined as following code shows, `cell_name` is the name of registered cell,
|
||||||
|
|
|
@ -251,7 +251,8 @@ class InsertGradientOf(PrimitiveWithInfer):
|
||||||
|
|
||||||
class HookBackward(PrimitiveWithInfer):
|
class HookBackward(PrimitiveWithInfer):
|
||||||
"""
|
"""
|
||||||
Used as tag to hook gradient in intermediate variables.
|
Used as tag to hook gradient in intermediate variables. Note that this function
|
||||||
|
is only supported in Pynative Mode.
|
||||||
|
|
||||||
Note:
|
Note:
|
||||||
The hook function should be defined like `hook_fn(grad) -> Tensor or None`,
|
The hook function should be defined like `hook_fn(grad) -> Tensor or None`,
|
||||||
|
|
Loading…
Reference in New Issue