diff --git a/doc/fluid/api_cn/api_guides/low_level/executor.rst b/doc/fluid/api_cn/api_guides/low_level/executor.rst index 8599a759828dc41db5aa3f6a6106e7d2542926f5..4801e8b25ca0a231722a626b1ec4c5dc9ea5c510 100644 --- a/doc/fluid/api_cn/api_guides/low_level/executor.rst +++ b/doc/fluid/api_cn/api_guides/low_level/executor.rst @@ -7,14 +7,14 @@ :code:`Executor` 即 :code:`执行器` 。PaddlePaddle Fluid中有两种执行器可以选择。 :code:`Executor` 实现了一个简易的执行器，所有Operator会被顺序执行。用户可以使用 Python脚本驱动 :code:`Executor` 执行。默认情况下 :code:`Executor` 是单线程的，如果 -想使用数据并行，请参考另一个执行器， :ref:`cn_api_guide_parallel_executor` 。 +想使用数据并行，请参考另一个执行器， :ref:`api_guide_parallel_executor` 。 :code:`Executor` 的代码逻辑非常简单。建议用户在调试过程中，先使用 :code:`Executor` 跑通模型，再切换到多设备计算，甚至多机计算。 :code:`Executor` 在构造的时候接受一个 :code:`Place`， 它们可以是 :ref:`cn_api_fluid_CPUPlace` 或 :ref:`cn_api_fluid_CUDAPlace` 。 :code:`Executor` 在执行的时候可以选择执行的 -:ref:`cn_api_guide_low_level_program` 。 +:ref:`api_guide_low_level_program` 。 简单的使用方法，请参考 `quick_start_fit_a_line `_ , API Reference 请参考 :ref:`cn_api_fluid_Executor` 。 diff --git a/doc/fluid/api_cn/api_guides/low_level/layers/loss_function.rst b/doc/fluid/api_cn/api_guides/low_level/layers/loss_function.rst index 453a6d559b2e825cd92e52de883e7ad481a9ef71..6b4d22e1bf4055d803b1cbdb59c3b654de48d496 100644 --- a/doc/fluid/api_cn/api_guides/low_level/layers/loss_function.rst +++ b/doc/fluid/api_cn/api_guides/low_level/layers/loss_function.rst @@ -57,4 +57,4 @@ API Reference 请参考 :ref:`cn_api_fluid_layers_sigmoid_cross_entropy_with_log 对于一些较为复杂的损失函数，可以尝试使用其他损失函数组合实现；Paddle Fluid 中提供的用于图像分割任务的 :ref:`cn_api_fluid_layers_dice_loss` 即是使用其他 OP 组合（计算各像素位置似然概率的均值）而成；多目标损失函数也可看作这样的情况，如 Faster RCNN 就使用 cross entropy 和 smooth_l1 loss 的加权和作为损失函数。 -**注意**，在定义损失函数之后为能够使用 :ref:`cn_api_guide_optimizer` 进行优化，通常需要使用 :ref:`cn_api_fluid_layers_mean` 或其他操作将损失函数返回的高维 Tensor 转换为 Scalar 值。 \ No newline at end of file +**注意**，在定义损失函数之后为能够使用 :ref:`api_guide_optimizer` 进行优化，通常需要使用 :ref:`cn_api_fluid_layers_mean` 或其他操作将损失函数返回的高维 Tensor 转换为 Scalar 值。 \ No newline at end of file diff --git a/doc/fluid/api_cn/api_guides/low_level/layers/math.rst b/doc/fluid/api_cn/api_guides/low_level/layers/math.rst index 7244b7228213b01e661a442b9f015b471ebca5c1..1379077d24d89d4dbce267ee5a864dae3deb6b97 100644 --- a/doc/fluid/api_cn/api_guides/low_level/layers/math.rst +++ b/doc/fluid/api_cn/api_guides/low_level/layers/math.rst @@ -147,12 +147,6 @@ equal API Reference 请参考 :ref:`cn_api_fluid_layers_equal` -not_equal ------------------- - -对两个 :code:`Tensor` 逐元素判断是否不等， 对应数学操作符 :code:`!=` - -API Reference 请参考 :ref:`cn_api_fluid_layers_elementwise_not_equal` less_than ------------------ @@ -161,26 +155,7 @@ less_than API Reference 请参考 :ref:`cn_api_fluid_layers_less_than` -less_equal ------------------- - -对两个 :code:`Tensor` 逐元素判断是否满足小于或等于关系， 对应数学操作符 :code:`<=` - -API Reference 请参考 :ref:`cn_api_fluid_layers_less_equal` - -greater_than ------------------- - -对两个 :code:`Tensor` 逐元素判断是否满足大于关系， 对应数学操作符 :code:`>` - -API Reference 请参考 :ref:`cn_api_fluid_layers_greater_than` - -greater_equal ------------------- - -对两个 :code:`Tensor` 逐元素判断是否满足大于或等于关系， 对应数学操作符 :code:`>=` -API Reference 请参考 :ref:`cn_api_fluid_layers_greater_equal` sum ------------------ @@ -189,19 +164,19 @@ sum API Reference 请参考 :ref:`cn_api_fluid_layers_sum` -min +elementwise_min ------------------ 对两个 :code:`Tensor` 逐元素进行 :code:`min(x, y)` 操作。 -API Reference 请参考 :ref:`cn_api_fluid_layers_min` +API Reference 请参考 :ref:`cn_api_fluid_layers_elementwise_min` -max +elementwise_max ------------------ 对两个 :code:`Tensor` 逐元素进行 :code:`max(x, y)` 操作。 -API Reference 请参考 :ref:`cn_api_fluid_layers_max` +API Reference 请参考 :ref:`cn_api_fluid_layers_elementwise_max` matmul ------------------ diff --git a/doc/fluid/api_cn/api_guides/low_level/layers/sparse_update.rst b/doc/fluid/api_cn/api_guides/low_level/layers/sparse_update.rst index a25e4beabb691f597fa3e7fc45e8ca07f1742c1e..138bfca4cb0c5c1a11ae5de93699dc9ffc294ecd 100644 --- a/doc/fluid/api_cn/api_guides/low_level/layers/sparse_update.rst +++ b/doc/fluid/api_cn/api_guides/low_level/layers/sparse_update.rst @@ -39,7 +39,7 @@ API详细使用方法参考 :ref:`cn_api_fluid_layers_embedding` ，以下是一 - :code:`is_sparse` ： 反向计算的时候梯度是否为sparse tensor。如果不设置，梯度是一个 `LodTensor `_ 。默认为False。 -- :code:`is_distributed` ： 标志是否是用在分布式的场景下。一般大规模稀疏更新（embedding的第0维维度很大，比如几百万以上）才需要设置。具体可以参考大规模稀疏的API guide :ref:`cn_api_guide_async_training` 。默认为False。 +- :code:`is_distributed` ： 标志是否是用在分布式的场景下。一般大规模稀疏更新（embedding的第0维维度很大，比如几百万以上）才需要设置。具体可以参考大规模稀疏的API guide :ref:`api_guide_async_training` 。默认为False。 - API汇总: - :ref:`cn_api_fluid_layers_embedding` diff --git a/doc/fluid/api_cn/api_guides/low_level/model_save_reader.rst b/doc/fluid/api_cn/api_guides/low_level/model_save_reader.rst index b0ed7ef10a8b580e6e685e539769d9113c0c8f41..d14e19b48e678faafd5c88bf108053dcd0ebb894 100644 --- a/doc/fluid/api_cn/api_guides/low_level/model_save_reader.rst +++ b/doc/fluid/api_cn/api_guides/low_level/model_save_reader.rst @@ -10,12 +10,12 @@ 变量、持久性变量和参数 ==================== -在 :code:`Paddle` 中，算子(:code:`Operator`)的每一个输入和输出都是一个变量（:code:`Variable`），而参数（:code:`Parameter`）是变量（:code:`Variable`）的子类。持久性变量（:code:`Persistables`）是一种在每次迭代结束后均不会被删除的变量。参数是一种持久性变量，其在每次迭代后都会被优化器（:ref:`cn_api_guide_optimizer`）更新。训练神经网络本质上就是在更新参数。 +在 :code:`Paddle` 中，算子(:code:`Operator`)的每一个输入和输出都是一个变量（:code:`Variable`），而参数（:code:`Parameter`）是变量（:code:`Variable`）的子类。持久性变量（:code:`Persistables`）是一种在每次迭代结束后均不会被删除的变量。参数是一种持久性变量，其在每次迭代后都会被优化器（:ref:`api_guide_optimizer`）更新。训练神经网络本质上就是在更新参数。 模型保存API介绍 ==================== -- :code:`fluid.io.save_vars`：通过执行器（:ref:`cn_api_guide_executor`）保存变量到指定的目录中。保存变量的方式有两种： +- :code:`fluid.io.save_vars`：通过执行器（:ref:`api_guide_executor`）保存变量到指定的目录中。保存变量的方式有两种： 1）通过接口中的 :code:`vars` 指定需要保存的变量列表。 @@ -33,7 +33,7 @@ API Reference 请参考 :ref:`cn_api_fluid_io_save_persistables`。 -- :code:`fluid.io.save_inference_model`：请参考 :ref:`cn_api_guide_inference`。 +- :code:`fluid.io.save_inference_model`：请参考 :ref:`api_guide_inference`。 模型加载API介绍 ==================== @@ -56,4 +56,4 @@ API Reference 请参考 :ref:`cn_api_fluid_io_load_persistables`。 -- :code:`fluid.io.load_inference_model`：请参考 :ref:`cn_api_guide_inference`。 +- :code:`fluid.io.load_inference_model`：请参考 :ref:`api_guide_inference`。