Skip to content

【快乐开源】PaddlePaddle 文档链接修复任务  #7735

Description

@HZ1ovo

一、任务背景

PaddlePaddle 文档仓库中存在大量失效链接,包括 API 文档、设计文档、指南文档等。这些失效链接影响了文档的可读性和用户体验,需要逐一排查并修复。本次任务旨在修复所有已发现的文档链接错误,提升文档质量。

文档链接失效的主要原因包括:

  • 外部网站结构调整(如 NumPy、PyTorch、torchvision 等官方文档)
  • PaddlePaddle 代码仓库重构导致源码路径变更
  • 历史图片和资源迁移或删除

这是成为开源贡献者的绝佳机会,许多优秀开源贡献者的第一步都是从文档贡献开始的,欢迎大家积极参与! 🎉 如有任何问题,欢迎在 issue 中讨论。

二、任务清单

⚠️ 赛道一(任务1-74) 赛道二(任务75-126),共126条任务

Important

本期仅有文档修改任务,"任务描述"用于理解上下文,便于判断对*错误链接的操作(修改 or 删除)
⚠️ 修文档
必用**错误链接:见comment
⚠️ 如果错误链接可点击,核实无需修改,请联系我

赛道一(任务 1-74)

序号 文档路径 链接数 任务描述 认领人/状态/PR号
1 CONTRIBUTING_cn.md 1 更新贡献指南相关链接 @HZ1ovo #7767
2 docs/api/paddle/slice_cn.rst 1 更新 NumPy 索引文档链接 @HZ1ovo #7726 #77771
3 docs/api/paddle/strided_slice_cn.rst 1 更新 NumPy 索引文档链接 @HZ1ovo #7754
4 docs/api/paddle/text/Conll05st_cn.rst 1 更新 Conll05st 数据集链接 @HZ1ovo #7767 #78024
5 docs/api/paddle/text/Overview_cn.rst 1 更新 PaddleNLP embeddings 文档链接 @HZ1ovo #7767 #78024
6 docs/api/paddle/text/UCIHousing_cn.rst 1 更新 UCI Housing 数据集链接 @lywlyw2004 #7820
7 docs/api_guides/low_level/optimizer_en.rst 1 更新反向传播算法维基百科链接 @MerlinSMQWQ #7769
8 docs/design/algorithm/parameter_average.md 4 更新 rmsprop_op 源码链接(2处)、ASGD 和 theta_star 图片链接(2处) @Aidenwu0209 #7750
9 docs/design/concurrent/concurrent_programming.md 3 更新并发编程相关链接(Golang CSP、Go runtime、Goroutine) @Aidenwu0209 #7748
10 docs/design/concurrent/csp.md 5 更新 CSP 理论链接(Tony Hoare 论文、Golang、Channel、Goroutine 等) @Aidenwu0209 #7749
11 docs/design/data_type/float16.md 4 更新 float16 相关链接(CUDA、ARM、Eigen、Numpy 文档) @Aidenwu0209 #7751
12 docs/design/dist_train/distributed_architecture.md 6 更新分布式架构图片链接(6处架构图) @Aidenwu0209 #7752
13 docs/design/dist_train/mpi_enabled_design.md 2 更新 MPI 相关链接(设计文档、架构图) @ShigureNyako #7800
14 docs/design/dist_train/multi_cpu.md 2 更新多 CPU 训练相关链接 @ShigureNyako #7803
15 docs/design/dist_train/parameter_server.md 3 更新参数服务器设计链接(架构图、相关文档) @ShigureNyako #7807
16 docs/design/dynamic_rnn/rnn.md 3 更新 RNN 相关链接(TensorFlow、PaddlePaddle 设计文档) @chengchen512 #7789
17 docs/design/dynamic_rnn/rnn_design.md 2 更新 RNN 设计文档链接 @chengchen512 #7819
18 docs/design/memory/memory_optimization.md 3 更新内存优化相关链接(论文、设计图) @ShigureNyako #7838
19 docs/design/mkldnn/int8/PTQ/README.md 3 更新 PTQ(训练后量化)相关链接 @ShigureNyako #7839
20 docs/design/mkldnn/int8/QAT/README.md 2 更新 QAT(量化感知训练)相关链接 @ShigureNyako #7843
21 docs/design/mkldnn/int8/README.md 1 更新 INT8 量化概述链接 @ClaireJunc #7747
22 docs/design/modules/batch_norm_op.md 2 更新 Batch Normalization 论文和源码链接 @ShigureNyako #7844
23 docs/design/modules/optimizer.md 1 更新优化器设计文档链接 @xcq-code #7755
24 docs/design/modules/regularization.md 8 更新正则化相关链接(论文、API 文档、源码等 8 处)
25 docs/design/motivation/fluid.md 1 更新 Fluid 设计动机文档链接 @SidusAntares
@Letin147 #7880
26 docs/design/motivation/refactorization.md 2 更新重构设计相关链接 @ShigureNyako #7845
27 docs/design/multi_devices/operator_kernel_type.md 1 更新算子内核类型设计链接 @2560925365-ux #7804
@Chloris-001 #7804
28 docs/design/network/deep_speech_2.md 2 更新 DeepSpeech2 论文和设计链接 @akgamerz790 #7902
29 docs/design/network/sequence_decoder.md 1 更新序列解码器设计链接 @Khoray #7768
30 docs/design/others/gan_api.md 2 更新 GAN API 设计链接 @akgamerz790 #7903
31 docs/design/others/graph_survey.md 1 更新图计算调研文档链接 @maodiesama #7757
32 docs/design/others/parameters_in_cpp.md 1 更新 C++ 参数设计链接 @maodiesama #7758
33 docs/design/quantization/training_quantization_model_format.md 1 更新训练量化模型格式文档链接 @maodiesama #7760
34 docs/dev_guides/Overview_cn.md 1 更新开发指南概述链接 @maodiesama #7763
35 docs/dev_guides/amp_precision/amp_op_dev_guide_cn.md 1 更新 AMP 算子开发指南链接 @maodiesama #7762
36 docs/dev_guides/api_contributing_guides/api_docs_guidelines_cn.md 1 更新 API 文档规范链接 @OctoberPrayRain #7771
37 docs/dev_guides/api_contributing_guides/new_cpp_op_cn.md 14 更新新增 C++ 算子指南链接(源码、文档、示例等 14 处) @inaniloquentee #7850
38 docs/dev_guides/api_contributing_guides/new_python_api_cn.md 12 更新新增 Python API 指南链接(源码、文档、示例等 12 处)
39 docs/dev_guides/api_contributing_guides/read_before_contributing_cn.md 8 更新贡献前必读链接(指南、文档、工具等 8 处)
40 docs/dev_guides/code_contributing_path_cn.md 11 更新代码贡献路径指南链接(文档、工具、规范等 11 处)
41 docs/dev_guides/custom_device_docs/custom_device_example_cn.md 1 更新自定义设备示例(中文)链接 @inaniloquentee
42 docs/dev_guides/custom_device_docs/custom_device_example_en.md 1 更新自定义设备示例(英文)链接 @inaniloquentee
43 docs/dev_guides/custom_device_docs/custom_device_overview_cn.md 5 更新自定义设备概述链接(5处文档和示例) @inaniloquentee
44 docs/dev_guides/custom_device_docs/custom_kernel_docs/kernel_declare_en.md 1 更新自定义内核声明文档链接 @2560925365-ux #7805
@Chloris-001 #7805
45 docs/dev_guides/custom_device_docs/new_device_backend_overview_cn.md 4 更新新设备后端概述链接(4处文档)
46 docs/dev_guides/docs_contributing_guides_cn.md 2 更新文档贡献指南链接 @cvbret #7779
47 docs/dev_guides/git_guides/codestyle_check_guide_cn.md 1 更新代码风格检查指南链接 @ShigureNyako #7821
48 docs/dev_guides/git_guides/local_dev_guide_cn.md 5 更新本地开发指南(中文)链接(5处文档和工具) @ShigureNyako #7822
49 docs/dev_guides/git_guides/local_dev_guide_en.md 3 更新本地开发指南(英文)链接(3处文档) @ShigureNyako #7828
50 docs/dev_guides/git_guides/submit_pr_guide_cn.md 1 更新提交 PR 指南(中文)链接 @ShigureNyako
51 docs/dev_guides/git_guides/submit_pr_guide_en.md 2 更新提交 PR 指南(英文)链接 @ShigureNyako #7833
52 docs/dev_guides/sugon/compile_and_test_cn.md 1 更新曙光平台编译测试指南链接 @ShigureNyako #7835
53 docs/dev_guides/sugon/paddle_c86_fix_guides_cn.md 5 更新 Paddle C86 修复指南链接(5处文档和工具) @ShigureNyako #7837
54 docs/eval/evaluation_of_docs_system.md 1 更新文档系统评估链接 @ShigureNyako #7846
55 docs/faq/index_cn.rst 1 更新 FAQ 索引链接 @Letin147 #7880
56 docs/faq/install_cn.md 3 更新安装 FAQ 链接(3处文档) @Kay123-bot
57 docs/guides/06_distributed_training/group_sharded_parallel_cn.rst 2 更新分组分片并行训练链接
58 docs/guides/10_contribution/community_contribution_cn.md 1 更新社区贡献指南链接 @SidusAntares #7772
59 docs/guides/advanced/model_to_onnx_cn.md 1 更新模型转 ONNX 指南链接 @Ling-WeiCheng #7882
60 docs/guides/advanced/visualdl_usage_en.md 9 更新 VisualDL 使用指南链接(9处文档和示例)
61 docs/guides/beginner/tensor_cn.md 37 更新张量教程(中文)链接37处API文档和示例)
62 docs/guides/beginner/tensor_en.md 1 更新张量教程(英文)链接
63 docs/guides/cinn/paddle2cinn_intro_cn.md 5 更新 Paddle2CINN 介绍链接(5处文档) @EricHC666 #7894
64 docs/guides/custom_op/new_cpp_op_cn.md 2 更新自定义 C++ 算子指南链接 @ShigureNyako #7888
65 docs/guides/flags/executor_cn.rst 1 更新执行器环境变量(中文)链接 @darkerkiller #7759
66 docs/guides/flags/executor_en.rst 1 更新执行器环境变量(英文)链接 @wwaawwaaee
67 docs/guides/infer/mobile/mobile_index_cn.md 1 更新移动端推理索引链接 @hlj2169159381 #7881
68 docs/guides/infer/paddleslim/paddle_slim_cn.md 1 更新 PaddleSlim 压缩工具(中文)链接 @Lishengnan519 #7883
69 docs/guides/infer/paddleslim/paddle_slim_en.rst 5 更新 PaddleSlim 压缩工具(英文)链接(5处文档)
70 docs/guides/jit/basic_usage_en.md 2 更新 JIT 基础用法(英文)链接 @ShigureNyako #7832
71 docs/guides/jit/case_analysis_cn.md 4 更新 JIT 案例分析(中文)链接(4处文档)
72 docs/guides/jit/debugging_cn.md 6 更新 JIT 调试指南(中文)链接(6处文档) @ShigureNyako #7832
73 docs/guides/jit/debugging_en.md 6 更新 JIT 调试指南(英文)链接(6处文档) @ShigureNyako #7832
74 docs/guides/jit/grammar_list_cn.md 2 更新 JIT 语法列表(中文)链接

赛道二(任务 75-126)

序号 文档路径 链接数 任务描述 认领人/状态/PR号
75 docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.nn.Flatten.md 1 更新 torch.nn.Flatten 参数名差异文档链接 @lllijinggg1110-rgb #7746
76 docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.nn.Unflatten.md 1 更新 torch.nn.Unflatten 参数名差异文档链接 @BayesianAura #7756
@wuhaostudio #7756
77 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 组合实现文档链接 @BayesianAura #7756
@wuhaostudio #7756
78 docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.inference_mode.md 1 更新 torch.inference_mode 组合实现文档链接 @wwaawwaaee
@Echo-Nie #7829
79 docs/guides/model_convert/convert_from_pytorch/api_difference/input_args_type_diff/torch.Tensor.ge_.md 1 更新 torch.Tensor.ge_ 参数类型差异文档链接 @2560925365-ux
@Chloris-001
80 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.Function.forward.md 1 更新 torch.autograd.Function.forward 调用差异文档链接 @aotenjou #7761
81 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.enable_grad.md 1 更新 torch.autograd.enable_grad 调用差异文档链接 @aotenjou #7761
82 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 调用差异文档链接 @aotenjou #7761
83 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.md 1 更新 FunctionCtx 调用差异文档链接 @aotenjou #7761
84 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 调用差异文档链接 @aotenjou #7761
85 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.function.FunctionCtx.saved_tensors.md 1 更新 FunctionCtx.saved_tensors 调用差异文档链接 @ShigureNyako #7774
86 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 调用差异文档链接 @ShigureNyako #7783
87 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.grad_mode.set_grad_enabled.md 1 更新 set_grad_enabled 调用差异文档链接 @ShigureNyako #7793
88 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.autograd.graph.saved_tensors_hooks.md 1 更新 saved_tensors_hooks 调用差异文档链接
89 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.backends.cuda.is_built.md 1 更新 torch.backends.cuda.is_built 调用差异文档链接
90 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.backends.cudnn.version.md 1 更新 torch.backends.cudnn.version 调用差异文档链接
91 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.cpu.current_device.md 1 更新 torch.cpu.current_device 调用差异文档链接 @ShigureNyako #7801
92 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 调用差异文档链接 @Echo-Nie #7829
93 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 调用差异文档链接 @Echo-Nie #7829
94 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.constraints.Constraint.md 1 更新 Constraint 调用差异文档链接 @Echo-Nie #7829
95 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.distribution.Distribution.log_prob.md 1 更新 Distribution.log_prob 调用差异文档链接 @Echo-Nie #7829
96 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.distributions.kl.kl_divergence.md 1 更新 kl_divergence 调用差异文档链接 @Echo-Nie #7829
97 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.is_inference.md 1 更新 torch.is_inference 调用差异文档链接 @ShigureNyako #7777
98 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.add_param_group.md 1 更新 Optimizer.add_param_group 调用差异文档链接 @ShigureNyako #7778
99 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.load_state_dict.md 1 更新 Optimizer.load_state_dict 调用差异文档链接 @ShigureNyako #7782
100 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.state_dict.md 1 更新 Optimizer.state_dict 调用差异文档链接 @ShigureNyako #7780
101 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.ChainDataset.md 1 更新 ChainDataset 调用差异文档链接
102 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.ConcatDataset.md 1 更新 ConcatDataset 调用差异文档链接
103 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Dataset.md 1 更新 Dataset 调用差异文档链接
104 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.IterableDataset.md 1 更新 IterableDataset 调用差异文档链接
105 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Sampler.md 1 更新 Sampler 调用差异文档链接
106 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.SequentialSampler.md 1 更新 SequentialSampler 调用差异文档链接
107 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.utils.data.Subset.md 1 更新 Subset 调用差异文档链接
108 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.AlexNet_Weights.DEFAULT.md 1 更新 AlexNet_Weights.DEFAULT 调用差异文档链接 @gravel-01 #7764
109 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.AlexNet_Weights.IMAGENET1K_V1.md 1 更新 AlexNet_Weights.IMAGENET1K_V1 调用差异文档链接 @gravel-01 #7764
110 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet121_Weights.DEFAULT.md 1 更新 DenseNet121_Weights.DEFAULT 调用差异文档链接 @gravel-01 #7764
111 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet121_Weights.IMAGENET1K_V1.md 1 更新 DenseNet121_Weights.IMAGENET1K_V1 调用差异文档链接 @gravel-01 #7764
112 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet161_Weights.DEFAULT.md 1 更新 DenseNet161_Weights.DEFAULT 调用差异文档链接 @gravel-01 #7764
113 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet161_Weights.IMAGENET1K_V1.md 1 更新 DenseNet161_Weights.IMAGENET1K_V1 调用差异文档链接 @Echo-Nie #7829
114 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet169_Weights.DEFAULT.md 1 更新 DenseNet169_Weights.DEFAULT 调用差异文档链接 @Echo-Nie #7829
115 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet169_Weights.IMAGENET1K_V1.md 1 更新 DenseNet169_Weights.IMAGENET1K_V1 调用差异文档链接 @Echo-Nie #7829
116 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet201_Weights.DEFAULT.md 1 更新 DenseNet201_Weights.DEFAULT 调用差异文档链接 @Echo-Nie #7829
117 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.DenseNet201_Weights.IMAGENET1K_V1.md 1 更新 DenseNet201_Weights.IMAGENET1K_V1 调用差异文档链接 @Carousel126 #7776
118 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.GoogLeNet_Weights.DEFAULT.md 1 更新 GoogLeNet_Weights.DEFAULT 调用差异文档链接 @Carousel126 #7776
119 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.GoogLeNet_Weights.IMAGENET1K_V1.md 1 更新 GoogLeNet_Weights.IMAGENET1K_V1 调用差异文档链接 @Carousel126 #7776
120 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.Inception_V3_Weights.DEFAULT.md 1 更新 Inception_V3_Weights.DEFAULT 调用差异文档链接 @Carousel126 #7776
121 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 调用差异文档链接 @Carousel126 #7776
122 docs/guides/model_convert/convert_from_pytorch/api_difference/invok_only_diff/torchvision.models.MobileNet_V2_Weights.DEFAULT.md 1 更新 MobileNet_V2_Weights.DEFAULT 调用差异文档链接 @seasameye #7765
123 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 调用差异文档链接 @seasameye #7765
124 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 调用差异文档链接 @seasameye #7765
125 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 调用差异文档链接 @seasameye #7765
126 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 调用差异文档链接 @seasameye #7765

三、如何开始

见:#7735 (comment)

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
赛道一 74 56 / 62 75.68% 52 70.27%
赛道二 52 41 / 42 78.85% 40 76.92%

统计信息

排名不分先后 @HZ1ovo (4) @lywlyw2004 (1) @MerlinSMQWQ (1) @Aidenwu0209 (5) @ShigureNyako (26) @chengchen512 (2) @xcq-code (1) @2560925365-ux (2) @akgamerz790 (2) @Khoray (1) @maodiesama (5) @OctoberPrayRain (1) @inaniloquentee (1) @cvbret (1) @SidusAntares (1) @Ling-WeiCheng (1) @EricHC666 (1) @darkerkiller (1) @hlj2169159381 (1) @Lishengnan519 (1) @lllijinggg1110-rgb (1) @BayesianAura (2) @Echo-Nie (10) @aotenjou (5) @gravel-01 (5) @Carousel126 (5) @seasameye (5)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions