diff --git a/docs/api/paddle/assign_cn.rst b/docs/api/paddle/assign_cn.rst index f0429f38eee..4bc9ba1665d 100644 --- a/docs/api/paddle/assign_cn.rst +++ b/docs/api/paddle/assign_cn.rst @@ -1,9 +1,9 @@ -.. _cn_api_fluid_layers_assign: +.. _cn_api_paddle_tensor_creation_assign: assign ------------------------------- -.. py:function:: paddle.assign(input,output=None) +.. py:function:: paddle.assign(x,output=None) @@ -11,10 +11,10 @@ assign 该OP将输入Tensor或numpy数组拷贝至输出Tensor。 参数： - - **input** (Tensor|np.ndarray) - 输入Tensor，或numpy数组，或由基本数据组成的list/tuple，或基本数据，支持数据类型为float32, float64, int32, int64和bool。注意：由于当前框架的protobuf传输数据限制，float64数据会被转化为float32数据。 + - **x** (Tensor|np.ndarray|list|tuple|scalar) - 输入Tensor，或numpy数组，或由基本数据组成的list/tuple，或基本数据，支持数据类型为float32, float64, int32, int64和bool。注意：由于当前框架的protobuf传输数据限制，float64数据会被转化为float32数据。 - **output** (Tensor，可选) - 输出Tensor。如果为None，则创建一个新的Tensor作为输出Tensor，默认值为None。 -返回：输出Tensor，形状、数据类型、数据值和 ``input`` 一致。 +返回：输出Tensor，形状、数据类型、数据值和 ``x`` 一致。 **代码示例**： @@ -25,8 +25,8 @@ assign import numpy as np data = paddle.full(shape=[3, 2], fill_value=2.5, dtype='float64') # [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]] array = np.array([[1, 1], - [3, 4], - [1, 3]]).astype(np.int64) + [3, 4], + [1, 3]]).astype(np.int64) result1 = paddle.zeros(shape=[3, 3], dtype='float32') paddle.assign(array, result1) # result1 = [[1, 1], [3 4], [1, 3]] result2 = paddle.assign(data) # result2 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]] diff --git a/docs/api/paddle/increment_cn.rst b/docs/api/paddle/increment_cn.rst index 8c54864f9eb..f2c87326d41 100644 --- a/docs/api/paddle/increment_cn.rst +++ b/docs/api/paddle/increment_cn.rst @@ -1,4 +1,4 @@ -.. _cn_api_fluid_layers_increment: +.. _cn_api_tensor_increment: increment ------------------------------- @@ -6,18 +6,21 @@ increment .. py:function:: paddle.increment(x, value=1.0, name=None) -使输入Tensor ``x`` 的数据累加 ``value`` , 该OP通常用于循环次数的计数。 -参数: - - **x** (Tensor) – 元素个数为1的Tensor，数据类型必须为float32，float64，int32，int64。 - - **value** (float，可选) – 需要增加的值，默认为1.0。 - - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 -返回：Tensor，累加结果，形状、数据类型和 ``x`` 一致。 +该OP在控制流程中用来让 ``x`` 的数值增加 ``value`` 。 -**代码示例** +**参数**: + - **x** (Tensor) – 输入张量，必须始终只有一个元素。支持的数据类型：float32，float64，int32，int64。 + - **value** (float，可选) – ``x`` 的数值增量。默认值为1.0。 + - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，默认值为None。 -.. code-block:: python +**返回**: Tensor，形状和数据类型同输入 ``x`` 。 + + +**代码示例**: + +.. code-block:: python import paddle diff --git a/docs/api/paddle/nn/loss/CTCLoss_cn.rst b/docs/api/paddle/nn/CTCLoss_cn.rst similarity index 98% rename from docs/api/paddle/nn/loss/CTCLoss_cn.rst rename to docs/api/paddle/nn/CTCLoss_cn.rst index eb15f6cacf9..ab4820df6c7 100644 --- a/docs/api/paddle/nn/loss/CTCLoss_cn.rst +++ b/docs/api/paddle/nn/CTCLoss_cn.rst @@ -3,7 +3,7 @@ CTCLoss ------------------------------- -.. py:class:: paddle.nn.loss.CTCLoss(blank=0, reduction='mean') +.. py:class:: paddle.nn.CTCLoss(blank=0, reduction='mean') 该接口用于计算 CTC loss。该接口的底层调用了第三方 baidu-research::warp-ctc 的实现。 也可以叫做 softmax with CTC，因为 Warp-CTC 库中插入了 softmax 激活函数来对输入的值进行归一化。 diff --git a/docs/api/paddle/nn/loss/L1Loss_cn.rst b/docs/api/paddle/nn/L1Loss_cn.rst similarity index 97% rename from docs/api/paddle/nn/loss/L1Loss_cn.rst rename to docs/api/paddle/nn/L1Loss_cn.rst index 946f0fc396c..f2d62fb7c77 100644 --- a/docs/api/paddle/nn/loss/L1Loss_cn.rst +++ b/docs/api/paddle/nn/L1Loss_cn.rst @@ -3,7 +3,7 @@ L1Loss ------------------------------- -.. py:class:: paddle.nn.loss.L1Loss(reduction='mean', name=None) +.. py:class:: paddle.nn.L1Loss(reduction='mean', name=None) 该接口用于创建一个L1Loss的可调用类，L1Loss计算输入input和标签label间的 `L1 loss` 损失。 diff --git a/docs/api/paddle/nn/clip_by_norm_cn.rst b/docs/api/paddle/nn/clip_by_norm_cn.rst deleted file mode 100644 index 9acae00b3c7..00000000000 --- a/docs/api/paddle/nn/clip_by_norm_cn.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _cn_api_fluid_layers_clip_by_norm: - -clip_by_norm -------------------------------- - -.. py:function:: paddle.nn.clip_by_norm(x, max_norm, name=None) - - -此算子将输入 ``X`` 的L2范数限制在 ``max_norm`` 内。如果 ``X`` 的L2范数小于或等于 ``max_norm`` ，则输出（Out）将与 ``X`` 相同。如果X的L2范数大于 ``max_norm`` ，则 ``X`` 将被线性缩放，使得输出（Out）的L2范数等于 ``max_norm`` ，如下面的公式所示： - -.. math:: - Out = \frac{max\_norm * X}{norm(X)} - -其中， :math:`norm（X）` 代表 ``x`` 的L2范数。 - - -参数： - - **x** (Variable)- 多维Tensor或LoDTensor，数据类型为float32。clip_by_norm运算的输入，维数必须在[1,9]之间。 - - **max_norm** (float32)- 最大范数值。 - - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 -返回：Tensor，表示为输出Tensor，数据类型为float32。和输入(X)具有相同的形状. - - -**代码示例：** - -.. code-block:: python - - import paddle - import numpy as np - - input = paddle.to_tensor(data=np.array([[0.1, 0.2], [0.3, 0.4]]), dtype="float32") - reward = paddle.nn.clip_by_norm(x=input, max_norm=1.0) - - diff --git a/docs/api/paddle/nn/clip_cn.rst b/docs/api/paddle/nn/clip_cn.rst deleted file mode 100644 index cb9c9922377..00000000000 --- a/docs/api/paddle/nn/clip_cn.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _cn_api_fluid_layers_clip: - -clip -------------------------------- - -.. py:function:: paddle.nn.clip(x, min, max, name=None) - - - - -该OP对输入Tensor每个元素的数值进行裁剪，使得输出Tensor元素的数值被限制在区间[min, max]内。具体的计算公式为如下。 - -.. math:: - - Out = MIN(MAX(x,min),max) - - - -参数： - - **x** (Tensor)- 多维Tensor，数据类型为float32 - - **min** (float)- 最小值，输入Tensor中小于该值的元素由min代替。 - - **max** (float)- 最大值，输入Tensor中大于该值的元素由max替换。 - - **name** (None|str) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，默认值为None。 - -返回： 对元素的数值进行裁剪之后的Tesnor，与输入x具有相同的shape和数据类型 - -返回类型：Tensor - -**代码示例：** - -.. code-block:: python - - import paddle - - x = paddle.uniform(shape=[4]) - y = paddle.nn.clip(x=x, min=0.3, max=0.6) - print(x) - print(y) diff --git a/docs/api/paddle/nn/cond_cn.rst b/docs/api/paddle/nn/cond_cn.rst deleted file mode 100644 index babfcc108c2..00000000000 --- a/docs/api/paddle/nn/cond_cn.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. _cn_api_fluid_layers_cond: - -cond -------------------------------- - - -.. py:function:: paddle.nn.cond(pred, true_fn=None, false_fn=None, name=None) - - - - -如果 ``pred`` 是 ``True`` ，该API返回 ``true_fn()`` ，否则返回 ``false_fn()`` 。 -用户如果不想在 ``callable`` 中做任何事，可以把 ``true_fn`` 或 ``false_fn`` 设为 ``None`` ，此时本API会把该 ``callable`` 视为简单返回 ``None`` 。 - -``true_fn`` 和 ``false_fn`` 需要返回同样嵌套结构（nest structure）的Tensor，如果不想返回任何值也可都返回 ``None`` 。 -PaddlePaddle里Tensor的嵌套结构是指一个Tensor，或者Tensor的元组（tuple），或者Tensor的列表（list）。 - -.. note:: - 1. 因为PaddlePaddle的静态图数据流， ``true_fn`` 和 ``false_fn`` 返回的元组必须形状相同，但是里面的Tensor形状可以不同。 - 2. 不论运行哪个分支，在 ``true_fn`` 和 ``false_fn`` 外创建的Tensor和Op都会被运行，即PaddlePaddle并不是惰性语法（lazy semantics）。例如 - - .. code-block:: python - - import paddle - - a = paddle.zeros((1, 1)) - b = paddle.zeros((1, 1)) - c = a * b - out = paddle.nn.cond(a < b, lambda: a + c, lambda: b * b) - - 不管 ``a < b`` 是否成立， ``c = a * b`` 都会被运行。 - -参数： - - **pred** (Tensor) - 一个形状为[1]的布尔型（boolean）的Tensor，该布尔值决定要返回 ``true_fn`` 还是 ``false_fn`` 的运行结果。 - - **true_fn** (callable) - 一个当 ``pred`` 是 ``True`` 时被调用的callable，默认值： ``None`` 。 - - **false_fn** (callable) - 一个当 ``pred`` 是 ``False`` 时被调用的callable，默认值： ``None`` 。 - - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值： ``None`` 。 - -返回： - 如果 ``pred`` 是 ``True`` ，该API返回 ``true_fn()`` ，否则返回 ``false_fn()`` 。 - -返回类型：Tensor|list(Tensor)|tuple(Tensor) - -抛出异常： - - ``TypeError`` - 如果 ``true_fn`` 或 ``false_fn`` 不是callable。 - - ``ValueError`` - 如果 ``true_fn`` 和 ``false_fn`` 没有返回同样的嵌套结构（nest structure），对嵌套结构的解释见上文。 - -**代码示例**： - -.. code-block:: python - - import paddle - - # - # pseudocode: - # if 0.1 < 0.23: - # return 1, True - # else: - # return 3, 2 - # - - def true_func(): - return paddle.fill_constant(shape=[1, 2], dtype='int32', - value=1), paddle.fill_constant(shape=[2, 3], - dtype='bool', - value=True) - - - def false_func(): - return paddle.fill_constant(shape=[3, 4], dtype='float32', - value=3), paddle.fill_constant(shape=[4, 5], - dtype='int64', - value=2) - - x = paddle.fill_constant(shape=[1], dtype='float32', value=0.1) - y = paddle.fill_constant(shape=[1], dtype='float32', value=0.23) - pred = paddle.less_than(x=x, y=y, name=None) - ret = paddle.nn.cond(pred, true_func, false_func) - # ret is a tuple containing 2 tensors - # ret[0] = [[1 1]] - # ret[1] = [[ True True True] - # [ True True True]] - diff --git a/docs/api/paddle/nn/function/grid_sample_cn.rst b/docs/api/paddle/nn/functional/grid_sample_cn.rst similarity index 97% rename from docs/api/paddle/nn/function/grid_sample_cn.rst rename to docs/api/paddle/nn/functional/grid_sample_cn.rst index f42f590d818..f31bbc6f7ea 100644 --- a/docs/api/paddle/nn/function/grid_sample_cn.rst +++ b/docs/api/paddle/nn/functional/grid_sample_cn.rst @@ -3,7 +3,7 @@ grid_sample ------------------------------- -.. py:function:: paddle.nn.function.grid_sample(x, grid, mode='bilinear', padding_mode='zeros', align_corners=True, name=None): +.. py:function:: paddle.nn.functional.grid_sample(x, grid, mode='bilinear', padding_mode='zeros', align_corners=True, name=None): diff --git a/docs/api/paddle/nn/functinoal/max_pool3d_cn.rst b/docs/api/paddle/nn/functional/max_pool3d_cn.rst similarity index 98% rename from docs/api/paddle/nn/functinoal/max_pool3d_cn.rst rename to docs/api/paddle/nn/functional/max_pool3d_cn.rst index 0a62c27253f..fc3321f5030 100644 --- a/docs/api/paddle/nn/functinoal/max_pool3d_cn.rst +++ b/docs/api/paddle/nn/functional/max_pool3d_cn.rst @@ -4,7 +4,7 @@ max_pool3d ------------------------------- -.. py:function:: paddle.nn.functinoal.max_pool3d(x, kernel_size, stride=None, padding=0, ceil_mode=False, return_mask=False, data_format="NCDHW", name=None)) +.. py:function:: paddle.nn.functional.max_pool3d(x, kernel_size, stride=None, padding=0, ceil_mode=False, return_mask=False, data_format="NCDHW", name=None)) 该函数是一个三维最大池化函数，根据输入参数 `kernel_size`, `stride`, `padding` 等参数对输入 `x` 做最大池化操作。 diff --git a/docs/api/paddle/optimizer/lr_scheduler/LinearLrWarmup_cn.rst b/docs/api/paddle/optimizer/lr_scheduler/LinearLrWarmup_cn.rst deleted file mode 100644 index a9985670586..00000000000 --- a/docs/api/paddle/optimizer/lr_scheduler/LinearLrWarmup_cn.rst +++ /dev/null @@ -1,105 +0,0 @@ -.. _cn_api_paddle_optimizer_LinearLrWarmup: - -LinearLrWarmup ------------------------------------ - -.. py:class:: paddle.optimizer.lr_scheduler.LinearLrWarmup(learing_rate, warmup_steps, start_lr, end_lr, last_epoch=-1, verbose=False) - -该接口提供一种学习率优化策略-线性学习率热身(warm up)对学习率进行初步调整。在正常调整学习率之前，先逐步增大学习率。 - -当训练步数小于热身步数（warmup_steps）时，学习率lr按如下方式更新： - -.. code-block:: text - - linear_step = end_lr - start_lr - lr = start_lr + linear_step * (epoch / warmup_steps) - -当训练步数大于等于热身步数（warmup_steps）时，学习率lr为： - -.. code-block:: text - - lr = learning_rate - -其中learning_rate为热身之后的学习率。 - -参数 -::::::::: - - **learning rate** （float|_LRScheduler）：热启训练之后的学习率，可以是Python的float或_LRScheduler子类。 - - **warmup_steps** （int）：进行warm up过程的步数。 - - **start_lr** （float）：warm up的起始学习率。 - - **end_lr** （float）：warm up的最终学习率。 - - **last_epoch** （int，可选）: 上一轮的轮数，重启训练时设置为上一轮的epoch数。默认值为 -1，则为初始学习率 。 - - **verbose** （bool，可选）：如果是 `True` ，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 - - -返回 -::::::::: -返回计算LinearLrWarmup的可调用对象。 - -代码示例 -::::::::: - -.. code-block:: python - - import paddle - import numpy as np - - # train on default dygraph mode - paddle.disable_static() - x = np.random.uniform(-1, 1, [10, 10]).astype("float32") - linear = paddle.nn.Linear(10, 10) - scheduler = paddle.optimizer.LinearLrWarmup( - learning_rate=0.5, warmup_steps=20, start_lr=0, end_lr=0.5, verbose=True) - sgd = paddle.optimizer.SGD(learning_rate=scheduler, parameter_list=linear.parameters()) - for epoch in range(20): - for batch_id in range(2): - x = paddle.to_tensor(x) - out = linear(x) - loss = paddle.reduce_mean(out) - loss.backward() - sgd.minimize(loss) - linear.clear_gradients() - scheduler.step() - - # train on static mode - paddle.enable_static() - main_prog = paddle.static.Program() - start_prog = paddle.static.Program() - with paddle.static.program_guard(main_prog, start_prog): - x = paddle.static.data(name='x', shape=[None, 4, 5]) - y = paddle.static.data(name='y', shape=[None, 4, 5]) - z = paddle.static.nn.fc(x, 100) - loss = paddle.mean(z) - scheduler = paddle.optimizer.lr_scheduler.LinearLrWarmup( - learning_rate=0.5, warmup_steps=20, start_lr=0, end_lr=0.5, verbose=True) - sgd = paddle.optimizer.SGD(learning_rate=scheduler) - sgd.minimize(loss) - - exe = paddle.static.Executor() - exe.run(start_prog) - for epoch in range(20): - for batch_id in range(2): - out = exe.run( - main_prog, - feed={ - 'x': np.random.randn(3, 4, 5).astype('float32'), - 'y': np.random.randn(3, 4, 5).astype('float32') - }, - fetch_list=loss.name) - scheduler.step() - -.. py:method:: step(epoch=None) - -step函数需要在优化器的 `step()` 函数之后调用，调用之后将会根据epoch数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 - -参数： - - **epoch** （int，可选）- 指定具体的epoch数。默认值None，此时将会从-1自动累加 ``epoch`` 数。 - -返回： - 无。 - -**代码示例** ： - - 参照上述示例代码。 - - diff --git a/docs/api/paddle/pow_cn.rst b/docs/api/paddle/pow_cn.rst index 40eaf542138..216b049ae50 100644 --- a/docs/api/paddle/pow_cn.rst +++ b/docs/api/paddle/pow_cn.rst @@ -1,55 +1,51 @@ -.. _cn_api_fluid_layers_pow: +.. _cn_api_paddle_tensor_math_pow: pow ------------------------------- -.. py:function:: paddle.pow(x, exponent, name=None) +.. py:function:: paddle.pow(x, y, name=None) - -该OP是指数激活算子： +该OP是指数算子，逐元素计算 ``x`` 的 ``y`` 次幂。 .. math:: - out = x^{exponent} - -**注意：如果需要对输入进行 elementwise_pow 操作，请查使用** :ref:`cn_api_fluid_layers_elementwise_pow` 。 - -参数： - - **x** （Variable）- 多维 ``Variable``，数据类型为 ``float32`` 或 ``float64`` 。 - - **exponent** （float32|Variable）- ``float32`` 或形状为[1]的 ``Variable``，数据类型为 ``float32``。 - - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置。默认值： ``None``。 + out = x^{y} -返回：维度与输入 `x` 相同的 ``Variable``，数据类型与 ``x`` 相同。 +参数 +::::::::: + - **x** （Tensor）- 多维 ``Tensor``，数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。 + - **y** （float|int|Tensor）- 如果类型是多维 ``Tensor``，其数据类型应该和 ``x`` 相同。 + - **name** （str, 可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 -返回类型：Variable。 +返回 +::::::::: +Tensor, 维度和数据类型都和 ``x`` 相同。 -**代码示例：** +代码示例 +::::::::: .. code-block:: python import paddle - import numpy as np - x = fluid.data(name="x", shape=[32,32], dtype="float32") - paddle.enable_imperative() - - # example 1: exponent is a float - x_data = np.array([1, 2, 3]) - exponent = 2 - x = paddle.imperative.to_variable(x_data) - res = paddle.pow(x, exponent) - print(res.numpy()) # [1 4 9] - - # example 2: exponent is a Variable - exponent = paddle.fill_constant(shape=[1], value=2, dtype='float32') - res = paddle.pow(x, exponent) - print(res.numpy()) # [1 4 9] - - - - - - + x = paddle.to_tensor([1, 2, 3], dtype='float32') + + # example 1: y is a float or int + res = paddle.pow(x, 2) + print(res) + # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, + # [1., 4., 9.]) + res = paddle.pow(x, 2.5) + print(res) + # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, + # [1. , 5.65685415 , 15.58845711]) + + # example 2: y is a Tensor + y = paddle.to_tensor([2], dtype='float32') + res = paddle.pow(x, y) + print(res) + # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, + # [1., 4., 9.]) diff --git a/docs/api/paddle/tensor/creation/assign_cn.rst b/docs/api/paddle/tensor/creation/assign_cn.rst deleted file mode 100644 index b2ea9482902..00000000000 --- a/docs/api/paddle/tensor/creation/assign_cn.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. _cn_api_paddle_tensor_creation_assign: - -assign -------------------------------- - -.. py:function:: paddle.assign(x,output=None) - - - - -该OP将输入Tensor或numpy数组拷贝至输出Tensor。 - -参数： - - **input** (Tensor|np.ndarray|list|tuple|scalar) - 输入Tensor，或numpy数组，或由基本数据组成的list/tuple，或基本数据，支持数据类型为float32, float64, int32, int64和bool。注意：由于当前框架的protobuf传输数据限制，float64数据会被转化为float32数据。 - - **output** (Tensor，可选) - 输出Tensor。如果为None，则创建一个新的Tensor作为输出Tensor，默认值为None。 - -返回：输出Tensor，形状、数据类型、数据值和 ``input`` 一致。 - - -**代码示例**： - -.. code-block:: python - - import paddle - import numpy as np - data = paddle.full(shape=[3, 2], fill_value=2.5, dtype='float64') # [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]] - array = np.array([[1, 1], - [3, 4], - [1, 3]]).astype(np.int64) - result1 = paddle.zeros(shape=[3, 3], dtype='float32') - paddle.assign(array, result1) # result1 = [[1, 1], [3 4], [1, 3]] - result2 = paddle.assign(data) # result2 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]] - result3 = paddle.assign(np.array([[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]], dtype='float32')) # result3 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]] diff --git a/docs/api/paddle/tensor/math/floor_mod_cn.rst b/docs/api/paddle/tensor/math/floor_mod_cn.rst deleted file mode 100644 index e9b9773c09d..00000000000 --- a/docs/api/paddle/tensor/math/floor_mod_cn.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _cn_api_tensor_cn_floor_mod: - -floor_mod -------------------------------- -:doc_source: paddle.tensor.remainder - - diff --git a/docs/api/paddle/tensor/math/increment_cn.rst b/docs/api/paddle/tensor/math/increment_cn.rst deleted file mode 100644 index f2c87326d41..00000000000 --- a/docs/api/paddle/tensor/math/increment_cn.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _cn_api_tensor_increment: - -increment -------------------------------- - -.. py:function:: paddle.increment(x, value=1.0, name=None) - - - - -该OP在控制流程中用来让 ``x`` 的数值增加 ``value`` 。 - -**参数**: - - **x** (Tensor) – 输入张量，必须始终只有一个元素。支持的数据类型：float32，float64，int32，int64。 - - **value** (float，可选) – ``x`` 的数值增量。默认值为1.0。 - - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，默认值为None。 - -**返回**: Tensor，形状和数据类型同输入 ``x`` 。 - - -**代码示例**: - -.. code-block:: python - - import paddle - - data = paddle.zeros(shape=[1], dtype='float32') - counter = paddle.increment(data) - # [1.] diff --git a/docs/api/paddle/tensor/math/mod_cn.rst b/docs/api/paddle/tensor/math/mod_cn.rst deleted file mode 100644 index b7f34c81e59..00000000000 --- a/docs/api/paddle/tensor/math/mod_cn.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _cn_api_tensor_cn_mod: - -mod -------------------------------- -:doc_source: paddle.tensor.remainder - - diff --git a/docs/api/paddle/tensor/math/pow_cn.rst b/docs/api/paddle/tensor/math/pow_cn.rst deleted file mode 100644 index 216b049ae50..00000000000 --- a/docs/api/paddle/tensor/math/pow_cn.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _cn_api_paddle_tensor_math_pow: - -pow -------------------------------- - -.. py:function:: paddle.pow(x, y, name=None) - - - -该OP是指数算子，逐元素计算 ``x`` 的 ``y`` 次幂。 - -.. math:: - - out = x^{y} - -参数 -::::::::: - - **x** （Tensor）- 多维 ``Tensor``，数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。 - - **y** （float|int|Tensor）- 如果类型是多维 ``Tensor``，其数据类型应该和 ``x`` 相同。 - - **name** （str, 可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 - -返回 -::::::::: -Tensor, 维度和数据类型都和 ``x`` 相同。 - - -代码示例 -::::::::: - -.. code-block:: python - - import paddle - - x = paddle.to_tensor([1, 2, 3], dtype='float32') - - # example 1: y is a float or int - res = paddle.pow(x, 2) - print(res) - # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, - # [1., 4., 9.]) - res = paddle.pow(x, 2.5) - print(res) - # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, - # [1. , 5.65685415 , 15.58845711]) - - # example 2: y is a Tensor - y = paddle.to_tensor([2], dtype='float32') - res = paddle.pow(x, y) - print(res) - # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True, - # [1., 4., 9.]) diff --git a/docs/api/paddle/tensor/math/sqrt_cn.rst b/docs/api/paddle/tensor/math/sqrt_cn.rst deleted file mode 100644 index f5d5b82915b..00000000000 --- a/docs/api/paddle/tensor/math/sqrt_cn.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _cn_api_fluid_layers_sqrt: - -sqrt -------------------------------- - -.. py:function:: paddle.sqrt(x, name=None) - - - - -计算输入的算数平方根。 - -.. math:: - out=\sqrt x=x^{1/2} - -.. note:: - 请确保输入中的数值是非负数。 - -参数: - - - **x** (Tensor) - 支持任意维度的Tensor。数据类型为float32，float64或float16。 - - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 - -返回：返回类型为Tensor， 数据类型同输入一致。 - -**代码示例**： - -.. code-block:: python - - import paddle - - x = paddle.to_tensor([0., 9., 36.]) - y = paddle.sqrt(x) - print(y) # y=[0., 3., 6.] - - - - - - - - - - diff --git a/docs/api/paddle/tensor/unbind_cn.rst b/docs/api/paddle/tensor/unbind_cn.rst deleted file mode 100644 index f05aa5f0660..00000000000 --- a/docs/api/paddle/tensor/unbind_cn.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _cn_api_paddle_tensor_unbind -unbind -------------------------------- - -.. py:function:: paddle.tensor.unbind(input, axis=0) - - - - -该OP将输入Tensor按照指定的维度分割成多个子Tensor。 - -**参数**： - - **input** (Variable) - 输入变量，数据类型为float32，float64，int32，int64的多维Tensor。 - - **axis** (int32|int64，可选) - 数据类型为int32或int64,表示需要分割的维度。如果axis < 0，则划分的维度为rank(input) + axis。默认值为0。 - -**返回**：分割后的Tensor列表。 - -**返回类型**：列表(Variable)，数据类型为int32，int64，float32，float64。 - -**代码示例**： - -.. code-block:: python - - import paddle - # input is a variable which shape is [3, 4, 5] - input = paddle.fluid.data( - name="input", shape=[3, 4, 5], dtype="float32") - [x0, x1, x2] = paddle.tensor.unbind(input, axis=0) - # x0.shape [4, 5] - # x1.shape [4, 5] - # x2.shape [4, 5] - [x0, x1, x2, x3] = paddle.tensor.unbind(input, axis=1) - # x0.shape [3, 5] - # x1.shape [3, 5] - # x2.shape [3, 5] - # x3.shape [3, 5] diff --git a/docs/guides/01_paddle2.0_introduction/index_cn.rst b/docs/guides/01_paddle2.0_introduction/index_cn.rst index 5692d71d89a..43a2d5c4a9a 100644 --- a/docs/guides/01_paddle2.0_introduction/index_cn.rst +++ b/docs/guides/01_paddle2.0_introduction/index_cn.rst @@ -5,7 +5,7 @@ 您可以通过下面的内容，了解更多飞桨框架2.0的内容: - `基本概念 <./basic_concept/index_cn.html>`_ : 飞桨框架2.0 基本概念的介绍。 -- `升级指南 <./update_cn.html>`_: 介绍飞桨框架2.0 的主要变化和如何升级。 +- `升级指南 <./update_cn.html>`_: 介绍飞桨框架2.0 的主要变化和如何升级到最新版飞桨。 - `版本迁移工具 <./migration_cn.html>`_: 介绍飞桨框架版本转换工具的使用。 .. toctree:: diff --git a/docs/guides/01_paddle2.0_introduction/index_en.rst b/docs/guides/01_paddle2.0_introduction/index_en.rst index 4480a98d908..3dfa2e172ef 100644 --- a/docs/guides/01_paddle2.0_introduction/index_en.rst +++ b/docs/guides/01_paddle2.0_introduction/index_en.rst @@ -6,7 +6,7 @@ Introduction of Paddle 2. For more information, you can view these pages: -- `basic concept <./basic_concept/index_en.html>`_ : introduction of Paddle 2 basic concept. +- `basic concept <./basic_concept/index_en.html>`_ : introduction of PaddlePaddle 2.0 basic concept. .. toctree:: :hidden: diff --git a/docs/guides/02_paddle2.0_develop/01_quick_start_cn.rst b/docs/guides/02_paddle2.0_develop/01_quick_start_cn.rst index 309e1d1d6f1..909e3c42171 100644 --- a/docs/guides/02_paddle2.0_develop/01_quick_start_cn.rst +++ b/docs/guides/02_paddle2.0_develop/01_quick_start_cn.rst @@ -22,7 +22,7 @@ .. parsed-literal:: - 2.0.1 + 2.1.0 三、实践：手写数字识别任务 diff --git a/docs/guides/02_paddle2.0_develop/02_data_load_cn.rst b/docs/guides/02_paddle2.0_develop/02_data_load_cn.rst index ced8ed0fdec..dcf970e84be 100644 --- a/docs/guides/02_paddle2.0_develop/02_data_load_cn.rst +++ b/docs/guides/02_paddle2.0_develop/02_data_load_cn.rst @@ -8,13 +8,13 @@ 一、框架自带数据集 --------------------- -飞桨框架将深度学习任务中常用到的数据集作为领域API开放，对应API所在目录为\ ``paddle.vision.datasets``\ 与\ ``paddle.text.datasets``\，你可以通过以下代码飞桨框架中提供了哪些数据集。 +飞桨框架将深度学习任务中常用到的数据集作为领域API开放，对应API所在目录为\ ``paddle.vision.datasets``\ 与\ ``paddle.text``\，你可以通过以下代码飞桨框架中提供了哪些数据集。 .. code:: ipython3 import paddle print('视觉相关数据集：', paddle.vision.datasets.__all__) - print('自然语言相关数据集：', paddle.text.datasets.__all__) + print('自然语言相关数据集：', paddle.text.__all__) .. parsed-literal:: @@ -23,7 +23,7 @@ 自然语言相关数据集： ['Conll05st', 'Imdb', 'Imikolov', 'Movielens', 'UCIHousing', 'WMT14', 'WMT16'] .. warning:: - 除\ ``paddle.vision.dataset``\ 与\ ``paddle.text.dataset``\ 外，飞桨框架还内置了另一套数据集，路径为\ ``paddle.dataset.*``\ ，但是该数据集的使用方式较老，会在未来的版本废弃，请尽量不要使用该目录下数据集的API。 + 除\ ``paddle.vision.dataset``\ 与\ ``paddle.text``\ 外，飞桨框架还内置了另一套数据集，路径为\ ``paddle.dataset.*``\ ，但是该数据集的使用方式较老，会在未来的版本废弃，请尽量不要使用该目录下数据集的API。 这里你可以定义手写数字体的数据集，其他数据集的使用方式也都类似。用\ ``mode``\ 来标识训练集与测试集。数据集接口会自动从远端下载数据集到本机缓存目录\ ``~/.cache/paddle/dataset``\ 。 diff --git a/docs/guides/02_paddle2.0_develop/06_device_cn.rst b/docs/guides/02_paddle2.0_develop/06_device_cn.rst index efb9a706516..e08a1b5d220 100644 --- a/docs/guides/02_paddle2.0_develop/06_device_cn.rst +++ b/docs/guides/02_paddle2.0_develop/06_device_cn.rst @@ -66,7 +66,7 @@ epochs = 5 # 设置优化器 - optim = paddle.optimizer.Adam(parameters=model.parameters()) + optim = paddle.optimizer.Adam(parameters=mnist.parameters()) for epoch in range(epochs): for batch_id, data in enumerate(train_loader()): diff --git a/docs/guides/index_cn.rst b/docs/guides/index_cn.rst index 22a29d50fb6..176efc7eef2 100644 --- a/docs/guides/index_cn.rst +++ b/docs/guides/index_cn.rst @@ -4,7 +4,7 @@ 飞桨开源框架(PaddlePaddle)是一个易用、高效、灵活、可扩展的深度学习框架。 -你可参考飞桨框架的 `Github `_ 了解详情，也可阅读 `版本说明 <../release_note_cn.html>`_ 了解2.0版本的特性。 +你可参考飞桨框架的 `Github `_ 了解详情，也可阅读 `版本说明 <../release_note_cn.html>`_ 了解最新版本的特性。 使用教程分为如下的模块： diff --git a/docs/guides/index_en.rst b/docs/guides/index_en.rst index 17ed12a00ca..a43e94b1dbf 100644 --- a/docs/guides/index_en.rst +++ b/docs/guides/index_en.rst @@ -15,7 +15,7 @@ Let's start with studying basic concept of PaddlePaddle: - `Inference and Deployment <./05_inference_deployment/index_en.html>`_ : Introduce the method of using the trained model to inference. - `Distributed Training <./06_distributed_training/index_en.html>`_ : Introduce how the PaddlePaddle uses distributed training - `Customize OP <./07_new_op/index_en.html>`_ : Introduce how to customize OP for PaddlePaddle. -- `Contribution <./08_Contribution/index_en.html>`_: Introduce how to contribute for PaddlePaddle. +- `Contribution <./10_contribution/index_en.html>`_: Introduce how to contribute for PaddlePaddle. .. toctree:: :hidden: @@ -26,4 +26,4 @@ Let's start with studying basic concept of PaddlePaddle: 05_inference_deployment/index_en.rst 06_distributed_training/index_en.rst 07_new_op/index_en.rst - 08_contribution/index_en.rst + 10_contribution/index_en.rst