diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000000..7ee8eac9d0a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +# EditorConfig is a cross-editor configuration file +# that helps to unify code styles for multiple +# developers collaborative projects. +# See more at https://editorconfig.org/ + +root = true + +[*] +indent_style = space +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.{yml,yaml}] +indent_size = 2 + +[*.{py,pyi,toml}] +indent_size = 4 diff --git a/.github/ISSUE_TEMPLATE/1_documentation-issue.yml b/.github/ISSUE_TEMPLATE/1_documentation-issue.yml index 35a37d5f8ff..c236ccc95ec 100644 --- a/.github/ISSUE_TEMPLATE/1_documentation-issue.yml +++ b/.github/ISSUE_TEMPLATE/1_documentation-issue.yml @@ -3,36 +3,36 @@ description: 反馈一个官网文档错误。 Report an issue related to https: labels: [] body: -- type: markdown - attributes: - value: > - #### 请确认反馈的问题来自PaddlePaddle官网文档：https://www.paddlepaddle.org.cn/ 。 + - type: markdown + attributes: + value: > + #### 请确认反馈的问题来自PaddlePaddle官网文档：https://www.paddlepaddle.org.cn/ 。 - #### Before submitting a Documentation Issue, Please make sure that issue is related to https://www.paddlepaddle.org.cn/. + #### Before submitting a Documentation Issue, Please make sure that issue is related to https://www.paddlepaddle.org.cn/. -- type: textarea - id: link - attributes: - label: 文档链接&描述 Document Links & Description - description: | - 请说明有问题的文档链接以及该文档存在的问题。 - Please fill in the link to the document and describe the question. - validations: - required: true + - type: textarea + id: link + attributes: + label: 文档链接&描述 Document Links & Description + description: | + 请说明有问题的文档链接以及该文档存在的问题。 + Please fill in the link to the document and describe the question. + validations: + required: true -- type: textarea - id: error - attributes: - label: 请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it - description: | - 请告诉我们，你希望如何改进这个文档。 - Please tell us how you would like to improve this document. + - type: textarea + id: error + attributes: + label: 请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it + description: | + 请告诉我们，你希望如何改进这个文档。 + Please tell us how you would like to improve this document. - validations: - required: false + validations: + required: false -- type: markdown - attributes: - value: > - 感谢你的贡献 🎉！Thanks for your contribution 🎉! + - type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/2_eval-issue.yml b/.github/ISSUE_TEMPLATE/2_eval-issue.yml index 2cb07dfd957..89d9010355a 100644 --- a/.github/ISSUE_TEMPLATE/2_eval-issue.yml +++ b/.github/ISSUE_TEMPLATE/2_eval-issue.yml @@ -3,84 +3,84 @@ description: 文档评估工作小组。 Document evaluation working group. labels: [eval] body: -- type: markdown - attributes: - value: > - #### 此模板用于文档评估工作小组成员向飞桨团队反馈文档问题，如非工作小组成员，请使用「📚 文档」模板，感谢配合~ + - type: markdown + attributes: + value: > + #### 此模板用于文档评估工作小组成员向飞桨团队反馈文档问题，如非工作小组成员，请使用「📚 文档」模板，感谢配合~ - #### This template is used by members of the document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ + #### This template is used by members of the document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ -- type: textarea - id: link - attributes: - label: 文档中英文链接 - description: | - 请输入你评估的文档链接（需含中英文两个链接）。请注意评估文档要是develop版本。 - validations: - required: true + - type: textarea + id: link + attributes: + label: 文档中英文链接 + description: | + 请输入你评估的文档链接（需含中英文两个链接）。请注意评估文档要是develop版本。 + validations: + required: true -- type: textarea - id: eval1 - attributes: - label: 红线问题 - description: | - 请按照如下维度评估本篇文档，如有红线问题，请在以下文本框中说明。 - - API文档对该API的描述，是否与API的行为保持一致？ - - API文档提供的示例代码能否跑通？ - - 中英文API文档的内容是否严格一致？ - validations: - required: false + - type: textarea + id: eval1 + attributes: + label: 红线问题 + description: | + 请按照如下维度评估本篇文档，如有红线问题，请在以下文本框中说明。 + - API文档对该API的描述，是否与API的行为保持一致？ + - API文档提供的示例代码能否跑通？ + - 中英文API文档的内容是否严格一致？ + validations: + required: false -- type: textarea - id: eval2 - attributes: - label: 结构问题 - description: | - 请评估本篇文档，是否按API文档推荐的结构书写，并且没有遗漏（无需写的部分可以省略）？ - 如有结构问题，请在以下文本框中说明。 + - type: textarea + id: eval2 + attributes: + label: 结构问题 + description: | + 请评估本篇文档，是否按API文档推荐的结构书写，并且没有遗漏（无需写的部分可以省略）？ + 如有结构问题，请在以下文本框中说明。 - API文档推荐的书写结构：API名称、API功能描述、API参数、API返回、API代码示例、API属性(class)、API方法(methods) - validations: - required: false + API文档推荐的书写结构：API名称、API功能描述、API参数、API返回、API代码示例、API属性(class)、API方法(methods) + validations: + required: false -- type: textarea - id: eval3 - attributes: - label: 内容问题 - description: | - 请按照如下维度评估本篇文档，如有内容问题，请在以下文本框中说明。 - - 全文语句通畅、准确、易理解。 - - API描述部分是否描述清楚，在什么场景下使用该API？ - - API参数，是否描述清楚不同参数下，API的行为区别？ - - 示例代码是否以注释给出了运行结果? - - 没有死链、错字、错误标点等低级错误。 - validations: - required: false + - type: textarea + id: eval3 + attributes: + label: 内容问题 + description: | + 请按照如下维度评估本篇文档，如有内容问题，请在以下文本框中说明。 + - 全文语句通畅、准确、易理解。 + - API描述部分是否描述清楚，在什么场景下使用该API？ + - API参数，是否描述清楚不同参数下，API的行为区别？ + - 示例代码是否以注释给出了运行结果? + - 没有死链、错字、错误标点等低级错误。 + validations: + required: false -- type: textarea - id: eval4 - attributes: - label: 格式问题 - description: | - 请按照如下维度评估本篇文档，如有格式问题，请在以下文本框中说明。 - - 是否使用深度学习领域通用的词汇和说法？ - - API文档格式是否满足格式规范？ - - 示例代码是否仅使用Paddle API，没有使用numpy等创建输入？ - validations: - required: false + - type: textarea + id: eval4 + attributes: + label: 格式问题 + description: | + 请按照如下维度评估本篇文档，如有格式问题，请在以下文本框中说明。 + - 是否使用深度学习领域通用的词汇和说法？ + - API文档格式是否满足格式规范？ + - 示例代码是否仅使用Paddle API，没有使用numpy等创建输入？ + validations: + required: false -- type: textarea - id: eval_fix - attributes: - label: 主观评价 - description: | - 请在此给出你对本篇文档的主观评价，API文档是否足够好，能够有效的帮助自己了解并使用这个API？ - 加分项：是否有图来协助说明，让本篇API文档更加易于理解？ - 如你已经发现了文档的错误并且判断其容易被修复，欢迎你为[Paddle](https://github.com/PaddlePaddle/Paddle/pulls)与[docs](https://github.com/PaddlePaddle/docs/pulls)提PR，直接修复此文档，并将PR链接贴在以下文本框中~ - validations: - required: true + - type: textarea + id: eval_fix + attributes: + label: 主观评价 + description: | + 请在此给出你对本篇文档的主观评价，API文档是否足够好，能够有效的帮助自己了解并使用这个API？ + 加分项：是否有图来协助说明，让本篇API文档更加易于理解？ + 如你已经发现了文档的错误并且判断其容易被修复，欢迎你为[Paddle](https://github.com/PaddlePaddle/Paddle/pulls)与[docs](https://github.com/PaddlePaddle/docs/pulls)提PR，直接修复此文档，并将PR链接贴在以下文本框中~ + validations: + required: true -- type: markdown - attributes: - value: > - 感谢你的贡献 🎉！Thanks for your contribution 🎉! + - type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/3_eval_distributed_DataParallel_docs-issue.yml b/.github/ISSUE_TEMPLATE/3_eval_distributed_DataParallel_docs-issue.yml index f28e2199392..f0d7bd8532d 100644 --- a/.github/ISSUE_TEMPLATE/3_eval_distributed_DataParallel_docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/3_eval_distributed_DataParallel_docs-issue.yml @@ -1,316 +1,316 @@ -name: 📝 分布式文档——数据并行快速开始体验评估 Eval Issue +name: 📝 分布式文档——数据并行快速开始体验评估 Eval Issue description: 第三期分布式文档——数据并行快速开始体验评估报告。 labels: [distributed_dp_eval] body: -- type: markdown - attributes: - value: > - #### 此模板用于第三期分布式文档（数据并行快速开始）评估工作小组成员，向飞桨团队反馈文档问题。如非工作小组成员，请使用 「📚文档」模板，感谢配合~ - - #### This template is used by members of the distributed document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ - -- type: dropdown - id: distributed_dp_task_type - attributes: - label: 任务类型 - description: 请选择您的任务类型 - options: - - 单机多卡 - - 多机多卡 - validations: - required: true - -- type: dropdown - id: distributed_dp_environment - attributes: - label: 项目环境 - description: 请选择您的项目运行环境 - options: - - 云平台 - - 自己的硬件（如集群） - - AI Studio - - 其他 - validations: - required: true - -- type: markdown - attributes: - value: > - # 数据并行任务一 体验评估报告 - - -- type: textarea - id: distributed_dp_task1 - attributes: - label: 认领任务 - description: | - 请输入您认领的任务名称，并附上链接（如果有）。 - 例：【CV】使用卷积神经网络进行图像分类：https://www.paddlepaddle.org.cn/documentation/docs/zh/practices/cv/convnet_image_classification.html - validations: - required: true - -- type: markdown - attributes: - value: > - ## 任务一体验评测 - -- type: textarea - id: distributed_dp_eval1 - attributes: - label: 1.导入分布式训练需要的依赖包 - description: | - 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval2 - attributes: - label: 2.初始化分布式训练环境 - description: | - 针对「初始化分布式训练环境」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval3 - attributes: - label: 3.设置分布式训练需要的优化器 - description: | - 针对「设置分布式训练需要的优化器」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - - -- type: textarea - id: distributed_dp_eval4 - attributes: - label: 4.数据集拆分 - description: | - 针对「数据集拆分」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval5 - attributes: - label: 5.构建训练代码 - description: | - 针对「构建训练代码」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval6 - attributes: - label: 6.单机多卡分布式训练 - description: | - 针对「单机多卡分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval7 - attributes: - label: 7.多机多卡分布式训练 - description: | - 针对「多机多卡分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: false - -- type: textarea - id: distributed_dp_eval8 - attributes: - label: 其他问题或建议 - description: | - 如果有其他问题或建议，请您详细描述。 - validations: - required: false - -- type: textarea - id: distributed_dp_code1 - attributes: - label: 相关代码 - description: | - 请附上aistudio项目地址 或 直接贴示例代码 - validations: - required: true - -- type: markdown - attributes: - value: > - # 数据并行任务二 体验评估报告 - - -- type: textarea - id: distributed_dp_task2 - attributes: - label: 认领任务名称 - description: | - 请输入您认领的任务名称，并附上链接（如果有） - validations: - required: true - -- type: markdown - attributes: - value: > - ## 任务二体验评测 - -- type: textarea - id: distributed_dp_eval11 - attributes: - label: 1.导入分布式训练需要的依赖包 - description: | - 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval12 - attributes: - label: 2.初始化分布式训练环境 - description: | - 针对「初始化分布式训练环境」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval13 - attributes: - label: 3.设置分布式训练需要的优化器 - description: | - 针对「设置分布式训练需要的优化器」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - - -- type: textarea - id: distributed_dp_eval14 - attributes: - label: 4.数据集拆分 - description: | - 针对「数据集拆分」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval15 - attributes: - label: 5.构建训练代码 - description: | - 针对「构建训练代码」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval16 - attributes: - label: 6.单机多卡分布式训练 - description: | - 针对「单机多卡分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true - -- type: textarea - id: distributed_dp_eval17 - attributes: - label: 7.多机多卡分布式训练 - description: | - 针对「多机多卡分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: false - -- type: textarea - id: distributed_dp_eval18 - attributes: - label: 其他问题或建议 - description: | - 如果有其他问题或建议，请您详细描述。 - validations: - required: false - -- type: textarea - id: distributed_dp_code2 - attributes: - label: 相关代码 - description: | - 请附上aistudio项目地址 或 直接贴示例代码 - validations: - required: true - - -- type: markdown - attributes: - value: > - 感谢你的贡献 🎉！Thanks for your contribution 🎉! + - type: markdown + attributes: + value: > + #### 此模板用于第三期分布式文档（数据并行快速开始）评估工作小组成员，向飞桨团队反馈文档问题。如非工作小组成员，请使用 「📚文档」模板，感谢配合~ + + #### This template is used by members of the distributed document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ + + - type: dropdown + id: distributed_dp_task_type + attributes: + label: 任务类型 + description: 请选择您的任务类型 + options: + - 单机多卡 + - 多机多卡 + validations: + required: true + + - type: dropdown + id: distributed_dp_environment + attributes: + label: 项目环境 + description: 请选择您的项目运行环境 + options: + - 云平台 + - 自己的硬件（如集群） + - AI Studio + - 其他 + validations: + required: true + + - type: markdown + attributes: + value: > + # 数据并行任务一 体验评估报告 + + + - type: textarea + id: distributed_dp_task1 + attributes: + label: 认领任务 + description: | + 请输入您认领的任务名称，并附上链接（如果有）。 + 例：【CV】使用卷积神经网络进行图像分类：https://www.paddlepaddle.org.cn/documentation/docs/zh/practices/cv/convnet_image_classification.html + validations: + required: true + + - type: markdown + attributes: + value: > + ## 任务一体验评测 + + - type: textarea + id: distributed_dp_eval1 + attributes: + label: 1.导入分布式训练需要的依赖包 + description: | + 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval2 + attributes: + label: 2.初始化分布式训练环境 + description: | + 针对「初始化分布式训练环境」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval3 + attributes: + label: 3.设置分布式训练需要的优化器 + description: | + 针对「设置分布式训练需要的优化器」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + + - type: textarea + id: distributed_dp_eval4 + attributes: + label: 4.数据集拆分 + description: | + 针对「数据集拆分」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval5 + attributes: + label: 5.构建训练代码 + description: | + 针对「构建训练代码」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval6 + attributes: + label: 6.单机多卡分布式训练 + description: | + 针对「单机多卡分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval7 + attributes: + label: 7.多机多卡分布式训练 + description: | + 针对「多机多卡分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: false + + - type: textarea + id: distributed_dp_eval8 + attributes: + label: 其他问题或建议 + description: | + 如果有其他问题或建议，请您详细描述。 + validations: + required: false + + - type: textarea + id: distributed_dp_code1 + attributes: + label: 相关代码 + description: | + 请附上aistudio项目地址 或 直接贴示例代码 + validations: + required: true + + - type: markdown + attributes: + value: > + # 数据并行任务二 体验评估报告 + + + - type: textarea + id: distributed_dp_task2 + attributes: + label: 认领任务名称 + description: | + 请输入您认领的任务名称，并附上链接（如果有） + validations: + required: true + + - type: markdown + attributes: + value: > + ## 任务二体验评测 + + - type: textarea + id: distributed_dp_eval11 + attributes: + label: 1.导入分布式训练需要的依赖包 + description: | + 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval12 + attributes: + label: 2.初始化分布式训练环境 + description: | + 针对「初始化分布式训练环境」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval13 + attributes: + label: 3.设置分布式训练需要的优化器 + description: | + 针对「设置分布式训练需要的优化器」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + + - type: textarea + id: distributed_dp_eval14 + attributes: + label: 4.数据集拆分 + description: | + 针对「数据集拆分」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval15 + attributes: + label: 5.构建训练代码 + description: | + 针对「构建训练代码」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval16 + attributes: + label: 6.单机多卡分布式训练 + description: | + 针对「单机多卡分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true + + - type: textarea + id: distributed_dp_eval17 + attributes: + label: 7.多机多卡分布式训练 + description: | + 针对「多机多卡分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: false + + - type: textarea + id: distributed_dp_eval18 + attributes: + label: 其他问题或建议 + description: | + 如果有其他问题或建议，请您详细描述。 + validations: + required: false + + - type: textarea + id: distributed_dp_code2 + attributes: + label: 相关代码 + description: | + 请附上aistudio项目地址 或 直接贴示例代码 + validations: + required: true + + + - type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/4_eval_distributed_PS_docs-issue.yml b/.github/ISSUE_TEMPLATE/4_eval_distributed_PS_docs-issue.yml index bbfed3e7d46..ce549ab20c9 100644 --- a/.github/ISSUE_TEMPLATE/4_eval_distributed_PS_docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/4_eval_distributed_PS_docs-issue.yml @@ -1,278 +1,278 @@ -name: 📝 分布式文档——参数服务器(Parameter Sever)快速开始体验评估 Eval Issue +name: 📝 分布式文档——参数服务器(Parameter Sever)快速开始体验评估 Eval Issue description: 第六期分布式文档——参数服务器(Parameter Sever)快速开始体验评估报告。 labels: [distributed_ps_eval] body: -- type: markdown - attributes: - value: > - #### 此模板用于第六期分布式文档-参数服务器(Parameter Sever)快速开始评估工作小组成员，向飞桨团队反馈文档问题。如非工作小组成员，请使用 「📚文档」模板，感谢配合~ + - type: markdown + attributes: + value: > + #### 此模板用于第六期分布式文档-参数服务器(Parameter Sever)快速开始评估工作小组成员，向飞桨团队反馈文档问题。如非工作小组成员，请使用 「📚文档」模板，感谢配合~ - #### This template is used by members of the distributed document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ + #### This template is used by members of the distributed document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~ -- type: dropdown - id: distributed_ps_environment - attributes: - label: 项目环境 - description: 请选择您的项目运行环境 - options: - - 云平台 - - 自己的硬件（如集群） - - AI Studio - - 其他 - validations: - required: true + - type: dropdown + id: distributed_ps_environment + attributes: + label: 项目环境 + description: 请选择您的项目运行环境 + options: + - 云平台 + - 自己的硬件（如集群） + - AI Studio + - 其他 + validations: + required: true -- type: markdown - attributes: - value: > - # 参数服务器(Parameter Sever)任务一 体验评估报告 + - type: markdown + attributes: + value: > + # 参数服务器(Parameter Sever)任务一 体验评估报告 -- type: textarea - id: distributed_ps_task1 - attributes: - label: 认领任务 - description: | - 请输入您认领的任务名称，并附上链接（如果有）。 - 例：CTR-DNN - validations: - required: true + - type: textarea + id: distributed_ps_task1 + attributes: + label: 认领任务 + description: | + 请输入您认领的任务名称，并附上链接（如果有）。 + 例：CTR-DNN + validations: + required: true -- type: markdown - attributes: - value: > - ## 任务一体验评测 + - type: markdown + attributes: + value: > + ## 任务一体验评测 -- type: textarea - id: distributed_ps_eval1 - attributes: - label: 1.导入分布式训练需要的依赖包 - description: | - 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval1 + attributes: + label: 1.导入分布式训练需要的依赖包 + description: | + 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval2 - attributes: - label: 2.定义分布式模式并初始化分布式训练环境 - description: | - 针对「定义分布式模式并初始化分布式训练环境」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval2 + attributes: + label: 2.定义分布式模式并初始化分布式训练环境 + description: | + 针对「定义分布式模式并初始化分布式训练环境」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval3 - attributes: - label: 3.加载模型 - description: | - 针对「加载模型」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval3 + attributes: + label: 3.加载模型 + description: | + 针对「加载模型」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval4 - attributes: - label: 4.构建 dataset 加载数据 - description: | - 针对「构建 dataset 加载数据」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval4 + attributes: + label: 4.构建 dataset 加载数据 + description: | + 针对「构建 dataset 加载数据」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval5 - attributes: - label: 5.定义参数更新策略及优化器 - description: | - 针对「定义参数更新策略及优化器」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval5 + attributes: + label: 5.定义参数更新策略及优化器 + description: | + 针对「定义参数更新策略及优化器」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval6 - attributes: - label: 6.开始多机分布式训练 - description: | - 针对「开始多机分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval6 + attributes: + label: 6.开始多机分布式训练 + description: | + 针对「开始多机分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval7 - attributes: - label: 其他问题或建议 - description: | - 如果有其他问题或建议，请您详细描述。 - validations: - required: false + - type: textarea + id: distributed_ps_eval7 + attributes: + label: 其他问题或建议 + description: | + 如果有其他问题或建议，请您详细描述。 + validations: + required: false -- type: textarea - id: distributed_ps_code1 - attributes: - label: 相关代码 - description: | - 请附上aistudio项目地址 或 直接贴示例代码 - validations: - required: true + - type: textarea + id: distributed_ps_code1 + attributes: + label: 相关代码 + description: | + 请附上aistudio项目地址 或 直接贴示例代码 + validations: + required: true -- type: markdown - attributes: - value: > - # 参数服务器(Parameter Sever)任务二 体验评估报告 + - type: markdown + attributes: + value: > + # 参数服务器(Parameter Sever)任务二 体验评估报告 -- type: textarea - id: distributed_ps_task2 - attributes: - label: 认领任务名称 - description: | - 请输入您认领的任务名称，并附上链接（如果有）。 - 例：DSSM文本匹配模型 - validations: - required: true + - type: textarea + id: distributed_ps_task2 + attributes: + label: 认领任务名称 + description: | + 请输入您认领的任务名称，并附上链接（如果有）。 + 例：DSSM文本匹配模型 + validations: + required: true -- type: markdown - attributes: - value: > - ## 任务二体验评测 + - type: markdown + attributes: + value: > + ## 任务二体验评测 -- type: textarea - id: distributed_ps_eval11 - attributes: - label: 1.导入分布式训练需要的依赖包 - description: | - 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval11 + attributes: + label: 1.导入分布式训练需要的依赖包 + description: | + 针对「导入分布式训练需要的依赖」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval12 - attributes: - label: 2.定义分布式模式并初始化分布式训练环境 - description: | - 针对「定义分布式模式并初始化分布式训练环境」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval12 + attributes: + label: 2.定义分布式模式并初始化分布式训练环境 + description: | + 针对「定义分布式模式并初始化分布式训练环境」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval13 - attributes: - label: 3.加载模型 - description: | - 针对「加载模型」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval13 + attributes: + label: 3.加载模型 + description: | + 针对「加载模型」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval14 - attributes: - label: 4.构建 dataset 加载数据 - description: | - 针对「构建 dataset 加载数据」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval14 + attributes: + label: 4.构建 dataset 加载数据 + description: | + 针对「构建 dataset 加载数据」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval15 - attributes: - label: 5.定义参数更新策略及优化器 - description: | - 针对「定义参数更新策略及优化器」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval15 + attributes: + label: 5.定义参数更新策略及优化器 + description: | + 针对「定义参数更新策略及优化器」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval16 - attributes: - label: 6.开始多机分布式训练 - description: | - 针对「开始多机分布式训练」这一环节，请回答以下内容 - value: | - - 完成情况（成功/不成功) ： - - 遇到问题： - - 解决方法（无法解决需注明)： - - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： - validations: - required: true + - type: textarea + id: distributed_ps_eval16 + attributes: + label: 6.开始多机分布式训练 + description: | + 针对「开始多机分布式训练」这一环节，请回答以下内容 + value: | + - 完成情况（成功/不成功) ： + - 遇到问题： + - 解决方法（无法解决需注明)： + - 对应文档是否描述清晰（如不清晰，需注明问题并提供文档链接）： + validations: + required: true -- type: textarea - id: distributed_ps_eval17 - attributes: - label: 其他问题或建议 - description: | - 如果有其他问题或建议，请您详细描述。 - validations: - required: false + - type: textarea + id: distributed_ps_eval17 + attributes: + label: 其他问题或建议 + description: | + 如果有其他问题或建议，请您详细描述。 + validations: + required: false -- type: textarea - id: distributed_ps_code2 - attributes: - label: 相关代码 - description: | - 请附上aistudio项目地址 或 直接贴示例代码 - validations: - required: true + - type: textarea + id: distributed_ps_code2 + attributes: + label: 相关代码 + description: | + 请附上aistudio项目地址 或 直接贴示例代码 + validations: + required: true -- type: markdown - attributes: - value: > - 感谢你的贡献 🎉！Thanks for your contribution 🎉! + - type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml index 1d865856b41..9646ab586b8 100644 --- a/.github/workflows/link-check.yml +++ b/.github/workflows/link-check.yml @@ -18,10 +18,10 @@ jobs: env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} with: - args: --verbose --no-progress --max-redirects 8 './**/*.md' './**/*.rst' - format: markdown - fail: false - output: lychee/results.md + args: --verbose --no-progress --max-redirects 8 './**/*.md' './**/*.rst' + format: markdown + fail: false + output: lychee/results.md - name: Create Issue From File if: steps.lychee.outputs.exit_code != 0 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a2d4dfda930..dd0c408fd05 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,35 +1,41 @@ repos: -# Common hooks -- repo: https://github.com/pre-commit/pre-commit-hooks + # Common hooks + - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: - - id: check-merge-conflict - - id: check-symlinks - - id: detect-private-key + - id: check-merge-conflict + - id: check-symlinks + - id: detect-private-key files: (?!.*paddle)^.*$ - - id: end-of-file-fixer + - id: end-of-file-fixer types: [text] - - id: trailing-whitespace + - id: trailing-whitespace types: [text] -- repo: https://github.com/Lucas-C/pre-commit-hooks + - repo: https://github.com/Lucas-C/pre-commit-hooks rev: v1.5.1 hooks: - - id: remove-crlf + - id: remove-crlf types: [text] - - id: remove-tabs + - id: remove-tabs types: [text] -# Document hooks -- repo: https://github.com/PFCCLab/dochooks - rev: v0.5.0 + # Document hooks + - repo: https://github.com/PFCCLab/dochooks + rev: v0.6.0 hooks: - - id: insert-whitespace-between-cn-and-en-char + - id: insert-whitespace-between-cn-and-en-char files: \.md$|\.rst$ -# For Python files -- repo: https://github.com/astral-sh/ruff-pre-commit + - id: check-case-conflict + # For Python files + - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.13.0 hooks: - - id: ruff-check + - id: ruff-check args: [--fix, --exit-non-zero-on-fix, --no-cache] - types_or: [ python, pyi ] - - id: ruff-format - types_or: [ python, pyi, jupyter ] + types_or: [python, pyi] + - id: ruff-format + types_or: [python, pyi, jupyter] + # For YAML files + - repo: https://github.com/PFCCLab/yamlfmt-pre-commit-mirror.git + rev: v0.16.0 + hooks: + - id: yamlfmt diff --git a/.yamlfmt b/.yamlfmt new file mode 100644 index 00000000000..01761f61f33 --- /dev/null +++ b/.yamlfmt @@ -0,0 +1,5 @@ +formatter: + indent: 2 + type: basic + retain_line_breaks: true + scan_folded_as_literal: true