【快乐开源】PaddlePaddle 文档链接修复任务 -- 第二期 #7736
Description
一、任务背景
PaddlePaddle 文档仓库中存在大量失效链接,包括 API 文档、设计文档、指南文档等。这些失效链接影响了文档的可读性和用户体验,需要逐一排查并修复。本次任务旨在修复所有已发现的文档链接错误,提升文档质量。
文档链接失效的主要原因包括:
- 外部网站结构调整(如 NumPy、PyTorch、torchvision 等官方文档)
- PaddlePaddle 代码仓库重构导致源码路径变更
- 历史图片和资源迁移或删除
这是成为开源贡献者的绝佳机会,许多优秀开源贡献者的第一步都是从文档贡献开始的,欢迎大家积极参与! 🎉 如有任何问题,欢迎在 issue 中讨论。
二、任务清单
赛道二(任务 1-52)
| 序号 | 文档路径 | 链接数 | 任务描述 | 认领人/状态/PR号 |
|---|---|---|---|---|
| ⬇️ 使用指南-PyTorch API 差异(1-52) | ||||
| 1 | docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.nn.Flatten.md |
1 | 更新 torch.nn.Flatten 参数名差异文档链接 | |
| 2 | docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.nn.Unflatten.md |
1 | 更新 torch.nn.Unflatten 参数名差异文档链接 | |
| 3 | docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.cuda.set_per_process_memory_fraction.md |
1 | 更新 torch.cuda.set_per_process_memory_fraction 组合实现文档链接 | |
| 4 | docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.inference_mode.md |
1 | 更新 torch.inference_mode 组合实现文档链接 | |
| 5 | docs/guides/model_convert/convert_from_pytorch/api_difference/input_args_type_diff/torch.Tensor.ge_.md |
1 | 更新 torch.Tensor.ge_ 参数类型差异文档链接 | |
| 6 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.Function.forward.md |
1 | 更新 torch.autograd.Function.forward 调用差异文档链接 | |
| 7 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.enable_grad.md |
1 | 更新 torch.autograd.enable_grad 调用差异文档链接 | |
| 8 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.mark_non_differentiable.md |
1 | 更新 FunctionCtx.mark_non_differentiable 调用差异文档链接 | |
| 9 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.md |
1 | 更新 FunctionCtx 调用差异文档链接 | |
| 10 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.save_for_backward.md |
1 | 更新 FunctionCtx.save_for_backward 调用差异文档链接 | |
| 11 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.saved_tensors.md |
1 | 更新 FunctionCtx.saved_tensors 调用差异文档链接 | |
| 12 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.set_materialize_grads.md |
1 | 更新 FunctionCtx.set_materialize_grads 调用差异文档链接 | |
| 13 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.grad_mode.set_grad_enabled.md |
1 | 更新 set_grad_enabled 调用差异文档链接 | |
| 14 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.graph.saved_tensors_hooks.md |
1 | 更新 saved_tensors_hooks 调用差异文档链接 | |
| 15 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.backends.cuda.is_built.md |
1 | 更新 torch.backends.cuda.is_built 调用差异文档链接 | |
| 16 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.backends.cudnn.version.md |
1 | 更新 torch.backends.cudnn.version 调用差异文档链接 | |
| 17 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.cpu.current_device.md |
1 | 更新 torch.cpu.current_device 调用差异文档链接 | |
| 18 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.cuda.reset_max_memory_allocated.md |
1 | 更新 torch.cuda.reset_max_memory_allocated 调用差异文档链接 | |
| 19 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.cuda.reset_max_memory_cached.md |
1 | 更新 torch.cuda.reset_max_memory_cached 调用差异文档链接 | |
| 20 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.constraints.Constraint.md |
1 | 更新 Constraint 调用差异文档链接 | |
| 21 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.distribution.Distribution.log_prob.md |
1 | 更新 Distribution.log_prob 调用差异文档链接 | |
| 22 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.kl.kl_divergence.md |
1 | 更新 kl_divergence 调用差异文档链接 | |
| 23 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.is_inference.md |
1 | 更新 torch.is_inference 调用差异文档链接 | |
| 24 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.add_param_group.md |
1 | 更新 Optimizer.add_param_group 调用差异文档链接 | |
| 25 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.load_state_dict.md |
1 | 更新 Optimizer.load_state_dict 调用差异文档链接 | |
| 26 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.state_dict.md |
1 | 更新 Optimizer.state_dict 调用差异文档链接 | |
| 27 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.ChainDataset.md |
1 | 更新 ChainDataset 调用差异文档链接 | |
| 28 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.ConcatDataset.md |
1 | 更新 ConcatDataset 调用差异文档链接 | |
| 29 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Dataset.md |
1 | 更新 Dataset 调用差异文档链接 | |
| 30 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.IterableDataset.md |
1 | 更新 IterableDataset 调用差异文档链接 | |
| 31 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Sampler.md |
1 | 更新 Sampler 调用差异文档链接 | |
| 32 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.SequentialSampler.md |
1 | 更新 SequentialSampler 调用差异文档链接 | |
| 33 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Subset.md |
1 | 更新 Subset 调用差异文档链接 | |
| 34 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.AlexNet_Weights.DEFAULT.md |
1 | 更新 AlexNet_Weights.DEFAULT 调用差异文档链接 | |
| 35 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.AlexNet_Weights.IMAGENET1K_V1.md |
1 | 更新 AlexNet_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 36 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet121_Weights.DEFAULT.md |
1 | 更新 DenseNet121_Weights.DEFAULT 调用差异文档链接 | |
| 37 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet121_Weights.IMAGENET1K_V1.md |
1 | 更新 DenseNet121_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 38 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet161_Weights.DEFAULT.md |
1 | 更新 DenseNet161_Weights.DEFAULT 调用差异文档链接 | |
| 39 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet161_Weights.IMAGENET1K_V1.md |
1 | 更新 DenseNet161_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 40 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet169_Weights.DEFAULT.md |
1 | 更新 DenseNet169_Weights.DEFAULT 调用差异文档链接 | |
| 41 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet169_Weights.IMAGENET1K_V1.md |
1 | 更新 DenseNet169_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 42 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet201_Weights.DEFAULT.md |
1 | 更新 DenseNet201_Weights.DEFAULT 调用差异文档链接 | |
| 43 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet201_Weights.IMAGENET1K_V1.md |
1 | 更新 DenseNet201_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 44 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.GoogLeNet_Weights.DEFAULT.md |
1 | 更新 GoogLeNet_Weights.DEFAULT 调用差异文档链接 | |
| 45 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.GoogLeNet_Weights.IMAGENET1K_V1.md |
1 | 更新 GoogLeNet_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 46 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.Inception_V3_Weights.DEFAULT.md |
1 | 更新 Inception_V3_Weights.DEFAULT 调用差异文档链接 | |
| 47 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.Inception_V3_Weights.IMAGENET1K_V1.md |
1 | 更新 Inception_V3_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 48 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V2_Weights.DEFAULT.md |
1 | 更新 MobileNet_V2_Weights.DEFAULT 调用差异文档链接 | |
| 49 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V2_Weights.IMAGENET1K_V1.md |
1 | 更新 MobileNet_V2_Weights.IMAGENET1K_V1 调用差异文档链接 | |
| 50 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V2_Weights.IMAGENET1K_V2.md |
1 | 更新 MobileNet_V2_Weights.IMAGENET1K_V2 调用差异文档链接 | |
| 51 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V3_Large_Weights.DEFAULT.md |
1 | 更新 MobileNet_V3_Large_Weights.DEFAULT 调用差异文档链接 | |
| 52 | docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V3_Large_Weights.IMAGENET1K_V1.md |
1 | 更新 MobileNet_V3_Large_Weights.IMAGENET1K_V1 调用差异文档链接 |
三、如何开始
⚠️ 全流程梳理 ⚠️
1.任务认领 （附要求）-->2.克隆仓库 -->3.配置环境 -->4.进行修复（附修复方法） --> 5.提交PR（附PR提交模板） -->6.等待跑通反馈
1. 任务认领
Important
请务必严格按照格式填写,否则快乐开源小助手无法自动更新信息
请大家在 issue 下以 comment 的形式认领任务,格式如下:
【报名】: 1、2、3-5
多个任务之间使用中文顿号分隔,多个连续任务可用横线表示
2. 克隆仓库
git clone https://github.com/PaddlePaddle/docs.git
cd docs3. 配置环境
本任务无需特殊环境配置,使用文本编辑器(如 VS Code)即可完成。
4. 进行修复
4.1 外部文档链接修复
对于 NumPy、PyTorch、torchvision 等外部文档:
- 访问官方最新文档网站
- 搜索对应的 API 或功能
- 复制正确的 URL 地址
- 替换文档中的失效链接
4.2 源码链接修复
对于 PaddlePaddle 源码链接:
- 在 Paddle 代码仓库中搜索对应的文件名或函数名
- 确认文件当前的正确路径
- 更新文档中的链接为新路径
Tip
源码修复需要向 Paddle 主库提交 PR,请参考贡献指南
4.3 图片链接修复
对于失效的图片链接:
- 在文档仓库历史版本中查找图片
- 使用 Web Archive 查找历史快照
- 如找不到原图,可考虑重新绘制或寻找替代图片
- 将图片上传到合适的位置并更新链接
四. 提交 PR
PR 标题格式
[Doc Link Fix No.xxx] 文档链接修复
示例: [Doc Link Fix No.1-5] paddle API 文档链接修复
PR 内容模板
## 修复内容
### 任务 1: docs/api/paddle/slice_cn.rst
- 原链接: https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
- 新链接: https://numpy.org/doc/stable/user/basics.indexing.html
- 修复原因: NumPy 官方文档结构调整
## 验证结果
已手动访问所有更新后的链接,确认所有链接可正常访问
- https://github.com/PaddlePaddle/docs/issues/7736
@Echo-Nie
五、PR 示例
- [Doc Link Fix No.2] Fix slice_cn.rst
(以第一期其中之一为例)
看板信息
统计信息
Metadata
Metadata
Labels
Type
Projects
Status