Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

【Docathon】补充Overview文档相关API描述 #6427

Closed
Turingg opened this issue Dec 25, 2023 · 9 comments
Closed

【Docathon】补充Overview文档相关API描述 #6427

Turingg opened this issue Dec 25, 2023 · 9 comments
Assignees
@luotao1 @sunzhongkai588 @Turingg
Labels
HappyOpenSource 快乐开源活动issue与PR

Comments

@Turingg
Copy link
Contributor

Turingg commented Dec 25, 2023 •
edited by luotao1
Loading

一、背景

飞桨官网的 API 文档，有中文和英文两个版本，都存储于 GitHub 中，并通过技术手段转为 HTML 文件后呈现在官网。

  • 中文 API 文档存储于 docs 仓库下，具体路径为 PaddlePaddle/docs/docs/api/paddle。
  • 英文 API 文档存储于 Paddle 仓库下的对应的 API 源码中，具体路径为 PaddlePaddle/Paddle/python/paddle。

原则上每一个中文 API 文档，都需要在对应目录下的 Overview 页面有描述，并且是一一对应的关系，但目前部分 Overview 文档中的 API 描述存在缺失。

Note

以 paddle.amp.debugging.collect_operator_stats 为例，该 API 理应在 paddle.amp 文件夹下的 Overview 页面中的 Debug 相关辅助类有对应描述，但实际是缺失的。
image
因此，你需要在对应 amp 文件夹下的 Overview_cn.rst 文件中增加对应描述。

二、原因分析

中文文档中 Overview 是通过 :ref: 的格式进行映射的。一般会造成其描述缺失的就是其 Overview_cn.rst 缺乏相应的" :ref: 引用。

以 paddle.amp.debugging.DebugMod 为例，:ref: 引用写法如下：

docs/docs/api/paddle/amp/Overview_cn.rst

Line 75 in 9620784

" :ref:`DebugMode <cn_api_paddle_amp_debugging_DebugMode>` ", "精度调试模式"

三、解决方法

通过在相应位置添加 " :ref:`API<相关 API 路径>` " 补充 Overview 文档中缺失的 API 描述、以 paddle.add 为例：

  • 首先通过路径找到相应的 Overview 文档的 rst 文件，如下图
    J@I (YX$SAQ7%{TN$L0LXE7
    3J @WZ$H9WK9R0V6P24UE 8
  • 其次相关文档补齐，paddle.add 的功能是与 tensor 数学操作有关，则找到相应的位置如下
    FH$}%W)LH 0 V}}M9J1MWZ2
    按照 " :ref:`API<相关 API 路径>` "，"API 功能" 添加描述

四、任务描述

序号 中文文档链接 缺失数量 认领人/状态/PR
1 paddle.amp.debugging.collect_operator_stats、paddle.amp.debugging.check_numerics、paddle.amp.debugging.check_layer_numerics 3个 @Turingg #6523
2 paddle.amp.is_float16_supported、paddle.amp.is_bfloat16_supported 2个 @Turingg #6571
3 paddle.autograd.backward、paddle.autograd.jacobian、paddle.autograd.hessian、paddle.autograd.saved_tensors_hooks 4个 @Turingg
@hu-qi #6593
4 paddle.autograd.PyLayerContext、paddle.autograd.PyLayer 2个 @hu-qi #6593
5 paddle.device.set_device、paddle.device.get_device 2个 @hu-qi #6620
6 paddle.device.is_compiled_with_xpu、paddle.device.is_compiled_with_rocm、paddle.device.is_compiled_with_cinn、paddle.device.is_compiled_with_ipu、paddle.device.is_compiled_with_custom_device 5个 @hu-qi #6620
7 paddle.device.get_device_name、paddle.device.get_device_properties、paddle.device.get_device_capability、paddle.device.get_device_capability 4个 @hu-qi #6620
8 paddle.device.get_cudnn_version 1个 @hu-qi #6620
9 paddle.device.XPUPlace、paddle.device.Stream、paddle.device.Event、paddle.device.synchronize、paddle.device.device_count 5个 @hu-qi #6620
10 paddle.device.Stream、paddle.device.current_stream、paddle.device.stream_guard、paddle.device.set_stream 4个 @hu-qi #6620
11 paddle.device.empty_cache、paddle.device.IPUPlace、paddle.device.synchronize、paddle.device.Event 4个 @hu-qi #6620
12 paddle.device.get_available_device、paddle.device.get_all_custom_device_type、paddle.device.get_available_custom_device、paddle.device.get_all_device_type 4个 @hu-qi #6620
13 paddle.device.memory_allocated、paddle.device.max_memory_reserved、paddle.device.memory_reserved、paddle.device.max_memory_allocated 4个 @LouisCanBe
@hu-qi #6620
14 paddle.distributed.ParallelEnv、paddle.distributed.split、paddle.distributed.wait、paddle.distributed.recompute 4个 @Wang-ZengWei #6599
15 paddle.distributed.get_group、paddle.distributed.group_sharded_parallel、paddle.distributed.save_group_sharded_model 3个 @StellaZYing #6595
16 paddle.distributed.gloo_init_parallel_env、paddle.distributed.gloo_barrier、paddle.distributed.gloo_release 3个 @StellaZYing #6595
17 paddle.distributed.is_initialized、paddle.distributed.is_initialized、paddle.distributed.DistAttr、paddle.distributed.dtensor_from_fn_cn、paddle.distributed.shard_optimizer 5个 @StellaZYing #6595
18 paddle.nn.utils.spectral_norm、paddle.nn.utils.parameters_to_vector、paddle.nn.utils.vector_to_parameters、paddle.nn.utils.clip_grad_norm_、paddle.nn.utils.clip_grad_value_、remove_weight_norm、weight_norm 7个 @gsq7474741 #6497
19 paddle.nn.functional.tanh_、paddle.nn.functional.sparse_attention、paddle.nn.functional.hinge_embedding_loss、paddle.nn.functional.channel_shuffle、paddle.nn.functional.rnnt_loss 5个 @gsq7474741 #6504
@austin-00 #6655
20 paddle.nn.HingeEmbeddingLoss、paddle.nn.RNNTLoss 2个 @gsq7474741 #6504
@austin-00 #6655
21 paddle.nn.initializer.lazy_init.LazyGuard 1个 @gsq7474741 #6504
@austin-00 #6655
22 paddle.onnx.export 1个 @dajiang0085 #6585
23 paddle.optimizer.lr.LinearLR、paddle.optimizer.lr.CosineAnnealingWarmRestarts 2个 @dajiang0085 #6585
24 paddle.regularizer.L1Decay、paddle.regularizer.L2Decay 2个 @dajiang0085 #6585
25 paddle.sparse.sum 1个 @dajiang0085 #6585
26 paddle.sysconfig.get_include、paddle.sysconfig.get_lib 2个 @dajiang0085 #6585
27 paddle.vision.datasets.DatasetFolder、paddle.vision.datasets.ImageFolder 2个 @Harryoung #6501
28 paddle.vision.ops.read_file、paddle.vision.ops.decode_jpeg 2个 @Harryoung #6501
29 paddle.vision.ops.PSRoIPool、paddle.vision.ops.RoIPool、paddle.vision.ops.roi_pool、paddle.vision.ops.psroi_pool、 4个 @Harryoung #6501
30 paddle.vision.ops.roi_align、paddle.vision.ops.RoIAlign、paddle.vision.ops.nms 3个 @Harryoung #6501
31 paddle.vision.transforms.RandomPerspective、paddle.vision.transforms.RandomErasing、paddle.vision.transforms.perspective、paddle.vision.transforms.erase、paddle.vision.transforms.RandomAffine、paddle.vision.transforms.affine 6个 @Harryoung #6501
32 paddle.vision.ops.generate_proposals、paddle.vision.ops.distribute_fpn_proposals、paddle.vision.ops.box_coder、paddle.vision.ops.prior_box 4个 @Harryoung #6501
33 paddle.set_flags、paddle.get_flags、paddle.fmax、paddle.fmin 4个 @hu-qi #6593
34 paddle.fmin、paddle.nansum、paddle.quantile、paddle.kthvalue 4个 @hu-qi #6593
35 paddle.nanmean、paddle.logspace、paddle.tril_indices、paddle.LazyGuard 4个 @hu-qi #6593
36 paddle.index_add_、paddle.enable_grad、paddle.index_put_、paddle.logaddexp、paddle.diag_embed 5个 @hu-qi #6593

任务认领

Important

请务必严格按照格式填写，否则无法快乐开源小助手无法自动更新信息

1. Issue 回复格式：

为了自动填写报名信息，需要在 issue 下回复报名信息，如果报名格式不正确，则会在 comment 区提示报名不正确，格式如下：

【报名】: 2、3、6-10

其中【报名】: 后直接是报名的赛题序号，多个赛题之间需要用中文顿号、分隔，多个连续赛题可以用横线表示

2. PR 标题格式：

[Docathon][Add Overview Doc No.2、3、6-10]+相关描述

PR 的标题中以 [Docathon][Add Overview Doc No.xxxx] 开头即可，程序会自动提取赛题编号并更新榜单。
一个 PR 也可以提交多个赛题，多个赛题间以顿号或横线分隔，比如 No.24、26-28、30 赛题。

3. PR 内容：

描述新增了哪些 Overview 的 API 描述、附上中文文档链接、并 @Turingg 和 @sunzhongkai588

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
Docathon 36 36 / 36 100.0% 31 86.11%

统计信息

排名不分先后 @Turingg (2) @hu-qi (15) @Wang-ZengWei (1) @StellaZYing (3) @gsq7474741 (4) @Harryoung (6)
@Turingg Turingg changed the title 【Docathon】补充Overview页面相关API描述 【Docathon】补充Overview文档相关API描述 Dec 25, 2023
@Turingg Turingg changed the title 【Docathon】补充Overview文档相关API描述 【Docs】补充Overview文档相关API描述 Dec 25, 2023
@Turingg Turingg changed the title 【Docs】补充Overview文档相关API描述 【Docathon】补充Overview文档相关API描述 Jan 31, 2024
@luotao1 luotao1 moved this to In Progress in Call for Contributions Feb 1, 2024
@gsq7474741
Copy link
Contributor

【报名】: 18-21

@sunzhongkai588 sunzhongkai588 mentioned this issue Feb 4, 2024
Open
@Harryoung
Copy link
Contributor

【报名】: 27-32

@gsq7474741 gsq7474741 mentioned this issue Feb 4, 2024
Merged
@gsq7474741 gsq7474741 mentioned this issue Feb 20, 2024
Merged
@Turingg
Copy link
Contributor Author

Turingg commented Feb 26, 2024

【报名】: 1-3

@Turingg Turingg mentioned this issue Mar 16, 2024
Merged
@Turingg Turingg mentioned this issue Apr 1, 2024
Merged
@dajiang0085
Copy link

【报名】: 22-26

This was referenced Apr 2, 2024
Merged
Closed
@dajiang0085 dajiang0085 mentioned this issue Apr 3, 2024
Closed
@hu-qi
Copy link
Contributor

hu-qi commented Apr 5, 2024 •
edited
Loading

【报名】: 3、4、33-36

@StellaZYing
Copy link
Contributor

【报名】: 15-17

@StellaZYing StellaZYing mentioned this issue Apr 6, 2024
Merged
@hu-qi hu-qi mentioned this issue Apr 6, 2024
Merged
@Wang-ZengWei
Copy link
Contributor

【报名】: 14

@Wang-ZengWei Wang-ZengWei mentioned this issue Apr 7, 2024
Merged
@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Apr 9, 2024
@hu-qi
Copy link
Contributor

hu-qi commented Apr 17, 2024 •
edited
Loading

【报名】: 5-13

@LouisCanBe
Copy link
Contributor

【报名】: 13

@LouisCanBe LouisCanBe mentioned this issue May 6, 2024
Closed
21 tasks
@Turingg Turingg closed this as completed Jul 17, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Call for Contributions Jul 17, 2024
@DrRyanHuang DrRyanHuang mentioned this issue Feb 20, 2025
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@luotao1 luotao1

@sunzhongkai588 sunzhongkai588

@Turingg Turingg

Labels
HappyOpenSource 快乐开源活动issue与PR
Projects
Call for Contributions
Status: Done
Milestone
No milestone
Development

No branches or pull requests
10 participants
@luotao1 @hu-qi @Harryoung @gsq7474741 @sunzhongkai588 @Wang-ZengWei @LouisCanBe @Turingg @dajiang0085 @StellaZYing