Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docathon][Add Overview Doc No.22-26]fix docs bugs #6585

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
2 changes: 2 additions & 0 deletions docs/api/paddle/optimizer/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@ paddle.optimizer 目录下包含飞桨框架支持的优化器算法相关的 AP
:widths: 10, 30

" :ref:`CosineAnnealingDecay <cn_api_paddle_optimizer_lr_CosineAnnealingDecay>` ", "Cosine Annealing 学习率衰减"
" :ref:`CosineAnnealingWarmRestarts <cn_api_paddle_optimizer_lr_CosineAnnealingWarmRestarts>` ", "CosineAnnealingWarmRestarts 学习率衰减"
" :ref:`ExponentialDecay <cn_api_paddle_optimizer_lr_ExponentialDecay>` ", "Exponential 学习率衰减"
" :ref:`InverseTimeDecay <cn_api_paddle_optimizer_lr_InverseTimeDecay>` ", "Inverse Time 学习率衰减"
" :ref:`LRScheduler <cn_api_paddle_optimizer_lr_LRScheduler>` ", "学习率衰减的基类"
" :ref:`LambdaDecay <cn_api_paddle_optimizer_lr_LambdaDecay>` ", "Lambda 学习率衰减"
" :ref:`LinearLR <cn_api_paddle_optimizer_lr_LinearLR>` ", "LinearLR 学习率衰减"
" :ref:`LinearWarmup <cn_api_paddle_optimizer_lr_LinearWarmup>` ", "Linear Warmup 学习率衰减"
" :ref:`MultiStepDecay <cn_api_paddle_optimizer_lr_MultiStepDecay>` ", "MultiStep 学习率衰减"
" :ref:`NaturalExpDecay <cn_api_paddle_optimizer_lr_NaturalExpDecay>` ", "NatualExp 学习率衰减"
Expand Down
20 changes: 20 additions & 0 deletions docs/api/paddle/regularizer/Overview_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _cn_overview_regularizer:

paddle.regularizer
---------------------

paddle.regularizer 目录下包含飞桨框架正则化相关的 API。具体如下:

- :ref:`正则化相关 API <about_regularizer>`

.. _about_regularizer:

正则化相关 API
::::::::::::::::::::

.. csv-table::
:header: "API 名称", "API 功能"
:widths: 10, 30

" :ref:`L1Decay <cn_api_paddle_regularizer_L1Decay>` ", "L1 正则化"
" :ref:`L2Decay <cn_api_paddle_regularizer_L2Decay>` ", "L2 正则化"
1 change: 1 addition & 0 deletions docs/api/paddle/sparse/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ paddle.sparse 目录包含飞桨框架支持稀疏数据存储和计算相关的
" :ref:`paddle.sparse.subtract <cn_api_paddle_sparse_subtract>` ", "对稀疏 Tensor 逐元素相减"
" :ref:`paddle.sparse.multiply <cn_api_paddle_sparse_multiply>` ", "对稀疏 Tensor 逐元素相乘"
" :ref:`paddle.sparse.divide <cn_api_paddle_sparse_divide>` ", "对稀疏 Tensor 逐元素相除"
" :ref:`paddle.sparse.sum <cn_api_paddle_sparse_sum>` ", "给定维度 axis 上稀疏张量 x 元素的和"
" :ref:`paddle.sparse.is_same_shape <cn_api_paddle_sparse_is_same_shape>` ", "判断两个稀疏 Tensor 或稠密 Tensor 的 shape 是否一致"
" :ref:`paddle.sparse.reshape <cn_api_paddle_sparse_reshape>` ", "改变一个 SparseTensor 的形状"
" :ref:`paddle.sparse.coalesce<cn_api_paddle_sparse_coalesce>` ", "对 SparseCooTensor 进行排序并合并"
Expand Down
20 changes: 20 additions & 0 deletions docs/api/paddle/sysconfig/Overview_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _cn_overview_sysconfig:

paddle.sysconfig
---------------------

paddle.sysconfig 目录下包含飞桨框架系统配置信息的相关 API。具体如下:

- :ref:`系统配置信息的相关 API <about_sysconfig>`

.. _about_sysconfig:

系统配置信息的相关 API
::::::::::::::::::::

.. csv-table::
:header: "API 名称", "API 功能"
:widths: 10, 30

" :ref:`get_include <cn_api_paddle_sysconfig_get_include>` ", "获取包含飞桨 C++头文件的目录"
" :ref:`get_lib <cn_api_paddle_sysconfig_get_lib>` ", "获取包含飞桨 lib 框架的目录"