未验证 提交 d2c01dfa 编写于 作者: Y Yang Zhang 提交者: GitHub

Update `paddle.clamp` doc (#2327)

* Update `paddle.clamp` doc

rename to `paddle.clip`
`input` -> `x`
remove `out`
update samples
wording: `Variable` - > `Tensor`

* Apply template

* Update `enable_imperative` -> `disable_static`

* Update sample: `to_tensor`
上级 c26d9084
......@@ -21,7 +21,7 @@ paddle
paddle_cn/cast_cn.rst
paddle_cn/ceil_cn.rst
paddle_cn/cholesky_cn.rst
paddle_cn/clamp_cn.rst
paddle_cn/clip_cn.rst
paddle_cn/CompiledProgram_cn.rst
paddle_cn/concat_cn.rst
paddle_cn/cond_cn.rst
......
.. _cn_api_paddle_cn_clamp:
.. _cn_api_paddle_cn_clip:
clamp
clip
-------------------------------
:doc_source: paddle.tensor.clamp
:doc_source: paddle.tensor.clip
......@@ -23,7 +23,7 @@ paddle.tensor
tensor_cn/cast_cn.rst
tensor_cn/ceil_cn.rst
tensor_cn/cholesky_cn.rst
tensor_cn/clamp_cn.rst
tensor_cn/clip_cn.rst
tensor_cn/concat_cn.rst
tensor_cn/cond_cn.rst
tensor_cn/cos_cn.rst
......
.. _cn_api_tensor_clamp:
clamp
-------------------------------
.. py:function:: paddle.clamp(input, min=None, max=None, output=None, name=None)
:alias_main: paddle.clamp
:alias: paddle.clamp,paddle.tensor.clamp,paddle.tensor.math.clamp
该OP将输入的所有元素进行剪裁,使得输出元素限制在[min, max]内,具体公式如下:
.. math::
Out = MIN(MAX(x, min), max)
参数:
- **input** (Variable) – 指定输入为一个多维的Tensor,数据类型可以是float32,float64。
- **min** (float32|Variable, 可选) - 裁剪的最小值,输入中小于该值的元素将由该元素代替,若参数为空,则不对输入的最小值做限制。数据类型可以是float32或形状为[1]的Tensor,类型可以为int32,float32,float64,默认值为None。
- **max** (float32|Variable, 可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替,若参数为空,则不对输入的最大值做限制。数据类型可以是float32或形状为[1]的Tensor,类型可以为int32,float32,float64,默认值为None。
- **output** (Variable, 可选)- 输出Tensor或LoDTensor。如果为None,则创建一个新的Tensor作为输出Tensor,默认值为None。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:返回一个和输入形状相同的Tensor。
返回类型:Variable
**代码示例**:
.. code-block:: python
import paddle
import paddle.fluid as fluid
import numpy as np
in1 = np.array([[1.2,3.5],
[4.5,6.4]]).astype('float32')
with fluid.dygraph.guard():
x1 = fluid.dygraph.to_variable(in1)
out1 = paddle.tensor.clamp(x1, min=3.5, max=5.0)
out2 = paddle.tensor.clamp(x1, min=2.5)
print(out1.numpy())
# [[3.5, 3.5]
# [4.5, 5.0]]
print(out2.numpy())
# [[2.5, 3.5]
# [[4.5, 6.4]
.. _cn_api_tensor_clip:
clip
-------------------------------
.. py:function:: paddle.clip(x, min=None, max=None, name=None)
:alias_main: paddle.clip
:alias: paddle.clip,paddle.tensor.clip,paddle.tensor.math.clip
该OP将输入的所有元素进行剪裁,使得输出元素限制在[min, max]内,具体公式如下:
.. math::
Out = MIN(MAX(x, min), max)
参数:
- x (Tensor) - 输入的Tensor,数据类型为:float32、float64、int32、int64。
- min (float32|Tensor, 可选) - 裁剪的最小值,输入中小于该值的元素将由该元素代替,若参数为空,则不对输入的最小值做限制。数据类型可以是float32或形状为[1]的Tensor,类型可以为int32,float32,float64,默认值为None。
- max (float32|Tensor, 可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替,若参数为空,则不对输入的最大值做限制。数据类型可以是float32或形状为[1]的Tensor,类型可以为int32,float32,float64,默认值为None。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。
返回:输出Tensor,与 ``x`` 维度相同、数据类型相同。
返回类型:Tensor
**代码示例**:
.. code-block:: python
import paddle
import numpy as np
paddle.disable_static()
x = np.array([[1.2,3.5], [4.5,6.4]]).astype('float32')
x1 = paddle.to_tensor(x)
out1 = paddle.clip(x1, min=3.5, max=5.0)
out2 = paddle.clip(x1, min=2.5)
print(out1.numpy())
# [[3.5, 3.5]
# [4.5, 5.0]]
print(out2.numpy())
# [[2.5, 3.5]
# [[4.5, 6.4]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册