diff --git a/docs/api/paddle/incubate/identity_loss_cn.rst b/docs/api/paddle/incubate/identity_loss_cn.rst new file mode 100644 index 00000000000..562acdb8120 --- /dev/null +++ b/docs/api/paddle/incubate/identity_loss_cn.rst @@ -0,0 +1,36 @@ +.. _cn_api_incubate_identity_loss: + +identity_loss +------------------------------- + +.. py:function:: paddle.incubate.identity_loss(x, reduction='none') + + +用于在IPU动态图转静态图功能中标记网络的损失值,从而能够在IPU上为网络添加反向计算过程。算子以网络的损失值作为输入,并对输入做reduction: + +当 `reduction` 为 `none` 时,直接返回最原始的 `Out` 结果。 + +当 `reduction` 为 `mean` 时,最终的输出结果为: + +.. math:: + Out = MEAN(Out) + +当 `reduction` 为 `sum` 时,最终的输出结果为: + +.. math:: + Out = SUM(Out) + +参数 +:::::::::::: + + - **x** (Variable) - 输入张量。维度为[N, \*]的多维Tensor,其中N是批大小,\*表示任何数量的附加维度。数据类型在CPU上为float32或float64,在IPU上为float16或float32。 + - **reduction** (str|int,可选) - 指定应用于输出结果的计算方式,可选的string值有: ``'sum'``, ``'mean'``, ``'none'`` ,对应的int值分别为0,1,2 。默认为 ``'none'``,直接返回输入loss的值。 + +返回 +:::::::::::: +Variable,根据 `reduction` 返回网络损失值的计算结果。 + +代码示例 +:::::::::::: + +COPY-FROM: paddle.incubate.identity_loss diff --git a/docs/api/paddle/static/IpuStrategy_cn.rst b/docs/api/paddle/static/IpuStrategy_cn.rst index 71bdb679ce1..0c1671ec404 100644 --- a/docs/api/paddle/static/IpuStrategy_cn.rst +++ b/docs/api/paddle/static/IpuStrategy_cn.rst @@ -134,6 +134,50 @@ disable_pattern(self, pattern) COPY-FROM: paddle.static.IpuStrategy.disable_pattern +register_patch(self) +''''''''' + +注册patch function以支持IPU上的动转静功能。该函数仅应在IPU动转静时使用,注册的函数会影响原动转静的逻辑,可通过``release_patch``释放注册的函数。 + +**代码示例** + +COPY-FROM: paddle.static.IpuStrategy.register_patch + +release_patch(self) +''''''''' + +释放IPU动转静所注册的函数。 + +**代码示例** + +COPY-FROM: paddle.static.IpuStrategy.release_patch + +set_optimizer(self, optimizer) +''''''''' + +该接口用于在IPU动转静时向IpuStrategy实例设置optimizer。 + +**参数** + + - **optimizer** (Optimizer)- 需要设置的Optimizer实例。 + +**代码示例** + +COPY-FROM: paddle.static.IpuStrategy.set_optimizer + +parse_optimizer(self, optimizer) +''''''''' + +该接口用于解析IPU动转静所需要的优化器参数,接收优化器实例并返回动转静所需要的优化器属性,当前仅支持解析学习率。 + +**参数** + + - **optimizer** (Optimizer)- 需要解析的Optimizer实例。 + +**代码示例** + +COPY-FROM: paddle.static.IpuStrategy.parse_optimizer + 属性 :::::::::::: num_ipus