From 6722ca37b54935898d5aced16345c8aa4de33411 Mon Sep 17 00:00:00 2001 From: wangguanzhong Date: Thu, 12 May 2022 18:45:10 +0800 Subject: [PATCH] update issue template, test=document_fix (#5954) * update issue template, test=document_fix * update template, test=document_fix * add chinese label, test=document_fix --- .../-------------other-general-issues.md | 49 ------------- .../------------feature-request.md | 43 ----------- .../-----------documentation-improvement.md | 15 ---- .../ISSUE_TEMPLATE/------bug---bug-report.md | 50 ------------- .github/ISSUE_TEMPLATE/1_bug-report.yml | 73 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature-request.yml | 50 +++++++++++++ .../ISSUE_TEMPLATE/3_documentation-issue.yml | 38 ++++++++++ .github/ISSUE_TEMPLATE/4_ask-a-question.yml | 37 ++++++++++ .github/ISSUE_TEMPLATE/5_others.yml | 23 ++++++ README_cn.md | 21 +++--- README_en.md | 21 +++--- 11 files changed, 243 insertions(+), 177 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/-------------other-general-issues.md delete mode 100644 .github/ISSUE_TEMPLATE/------------feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/-----------documentation-improvement.md delete mode 100644 .github/ISSUE_TEMPLATE/------bug---bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/1_bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/3_documentation-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/4_ask-a-question.yml create mode 100644 .github/ISSUE_TEMPLATE/5_others.yml diff --git a/.github/ISSUE_TEMPLATE/-------------other-general-issues.md b/.github/ISSUE_TEMPLATE/-------------other-general-issues.md deleted file mode 100644 index f4e48541a..000000000 --- a/.github/ISSUE_TEMPLATE/-------------other-general-issues.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: "\U0001F516 其他通用问题 / Other General Issues" -about: 提出其他问题 / Suggest other general issues -title: "[Other General Issues]" -labels: '' -assignees: '' - ---- - -**PaddleDetection team appreciate any suggestion or problem you delivered~** - -## Checklist: - -1. 查找历史相关issue寻求解答/I have searched related issues but cannot get the expected help. -2. 翻阅[FAQ](https://paddledetection.readthedocs.io/FAQ.html) /I have read the [FAQ documentation](https://paddledetection.readthedocs.io/FAQ.html) but cannot get the expected help. - -## 描述问题/Describe the bug -A clear and concise description of what the bug is. - -## 复现/Reproduction - -1. 您使用的命令是？/What command or script did you run? - -```none -请填写命令/A placeholder for the command. -``` -2. 您是否更改过代码或配置文件？您是否理解您所更改的内容？还请您提供所更改的部分代码。/Did you make any modifications on the code or config? Did you understand what you have modified? Please provide the codes that you modified. - -3. 您使用的数据集是？/What dataset did you use? - -4. 请提供您出现的报错信息及相关log。/Please provide the error messages or relevant log information. - -## 环境/Environment -1. 请提供您使用的Paddle和PaddleDetection的版本号/Please provide the version of Paddle and PaddleDetection you use： - -2. 如您在使用PaddleDetection的同时还在使用其他产品，如PaddleServing、PaddleInference等，请您提供其版本号/ Please provide the version of any other related tools/products used, such as the version of PaddleServing and etc： - -3. 请提供您使用的操作系统信息，如Linux/Windows/MacOS /Please provide the OS information, e.g., Linux： - -4. 请问您使用的Python版本是？/ Please provide the version of Python you used. - -5. 请问您使用的CUDA/cuDNN的版本号是？/ Please provide the version of CUDA/cuDNN you used. - - -如果您的issue是关于安装或环境，您可以先查询[安装文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL_cn.md)尝试解决~ - -If your issue looks like an installation issue / environment issue, -please first try to solve it yourself with the instructions in -https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL.md diff --git a/.github/ISSUE_TEMPLATE/------------feature-request.md b/.github/ISSUE_TEMPLATE/------------feature-request.md deleted file mode 100644 index 7b23ce692..000000000 --- a/.github/ISSUE_TEMPLATE/------------feature-request.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: "\U0001F680 新功能需求 / Feature Request" -about: 提出一个新的功能需求或改进建议 / Suggest an improvement for PaddleDetection -title: "[Feature Request]" -labels: '' -assignees: '' - ---- - -## 🚀 新功能/Feature - -PaddleDetection欢迎大家以清晰简洁的语言提出新功能需求。 - -A clear and concise description of the feature proposal. - -## 需求原因&示例/Motivation & Examples - -请描述这个需求的必要性。 - -Tell us why the feature is useful. - -请描述这个需求可实现的具体功能，如果可以，辛苦您提供相关代码实现效果。 - -Describe what the feature would look like, if it is implemented. -Best demonstrated using **code examples** in addition to words. - -## 📣 注意/Note - -PaddleDetection仅添加通用性较高的新功能/特性。 - -We only consider adding new features if they are relevant to many users. - -如果您需要论文中的模型能力，PaddleDetection会优先考虑与目标检测强相关且意义较大的论文。 - -If you request implementation of research papers -- we only consider papers that have enough significance and prevalence in the object detection field. - -比如“让XX功能更快”类似的需求不能作为一个有效需求，需要更具体的描述，如“创建一个具体XX工具/功能，让XX更快”即是一个有效需求。 - -"Make X faster/accurate" is not a valid feature request. "Implement a concrete feature that can make X faster/accurate" can be a valid feature request. - -PaddleDetection感谢您的支持，我们期待您提出新功能需求！ - -Thanks for your suggestions! diff --git a/.github/ISSUE_TEMPLATE/-----------documentation-improvement.md b/.github/ISSUE_TEMPLATE/-----------documentation-improvement.md deleted file mode 100644 index 3969fd2e0..000000000 --- a/.github/ISSUE_TEMPLATE/-----------documentation-improvement.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: "\U0001F4D6 文档优化 / Documentation Improvement" -about: 对现有的文档教程提出修改建议 / Suggest an improvement about existing documentation or tutorials - in PaddleDetection. -title: "[Document Improvement]" -labels: '' -assignees: '' - ---- - -## 📖 文档优化/Documentation Improvement - -**请简单说明文档存在问题/Please provide a concise and brief description of the documentation problem:** - -**请提供有问题的文档部分截图及链接/Please provide the screen shoot and the link of the document:** diff --git a/.github/ISSUE_TEMPLATE/------bug---bug-report.md b/.github/ISSUE_TEMPLATE/------bug---bug-report.md deleted file mode 100644 index d778a0342..000000000 --- a/.github/ISSUE_TEMPLATE/------bug---bug-report.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: "\U0001F41B 提出Bug / Bug Report" -about: 提出PaddleDetection使用中存在的Bug / Report a bug in PaddleDetection -title: "[BUG]" -labels: '' -assignees: '' - ---- - -**PaddleDetection team appreciate any suggestion or problem you delivered~** - -## Checklist: - -1. 查找历史相关issue寻求解答/I have searched related issues but cannot get the expected help. -2. 翻阅[FAQ](https://paddledetection.readthedocs.io/FAQ.html) /I have read the [FAQ documentation](https://paddledetection.readthedocs.io/FAQ.html) but cannot get the expected help. -3. 确认bug是否在新版本里还未修复/The bug has not been fixed in the latest version. - -## 描述问题/Describe the bug -A clear and concise description of what the bug is. - -## 复现/Reproduction - -1. 您使用的命令是？/What command or script did you run? - -```none -请填写命令/A placeholder for the command. -``` -2. 您是否更改过代码或配置文件？您是否理解您所更改的内容？还请您提供所更改的部分代码。/Did you make any modifications on the code or config? Did you understand what you have modified? Please provide the codes that you modified. - -3. 您使用的数据集是？/What dataset did you use? - -4. 请提供您出现的报错信息及相关log。/Please provide the error messages or relevant log information. - -## 环境/Environment -1. 请提供您使用的Paddle和PaddleDetection的版本号/Please provide the version of Paddle and PaddleDetection you use： - -2. 如您在使用PaddleDetection的同时还在使用其他产品，如PaddleServing、PaddleInference等，请您提供其版本号/ Please provide the version of any other related tools/products used, such as the version of PaddleServing and etc： - -3. 请提供您使用的操作系统信息，如Linux/Windows/MacOS /Please provide the OS information, e.g., Linux： - -4. 请问您使用的Python版本是？/ Please provide the version of Python you used. - -5. 请问您使用的CUDA/cuDNN的版本号是？/ Please provide the version of CUDA/cuDNN you used. - - -如果您的issue是关于安装或环境，您可以先查询[安装文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL_cn.md)尝试解决~ - -If your issue looks like an installation issue / environment issue, -please first try to solve it yourself with the instructions in -https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL.md diff --git a/.github/ISSUE_TEMPLATE/1_bug-report.yml b/.github/ISSUE_TEMPLATE/1_bug-report.yml new file mode 100644 index 000000000..41e32cfe9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug-report.yml @@ -0,0 +1,73 @@ +name: 🐛 报BUG Bug Report +description: 报告一个可复现的BUG帮助我们修复PaddleDetection。 Report a bug to help us reproduce and fix it. +labels: [type/bug-report, status/new-issue] + +body: +- type: markdown + attributes: + value: | + Thank you for submitting a PaddleDetection Bug Report! + +- type: checkboxes + attributes: + label: 问题确认 Search before asking + description: > + 在向PaddleDetection报bug之前，请先查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)是否报过同样的bug。 + + Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/PaddlePaddle/PaddleDetection/issues). + + options: + - label: > + 我已经查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)，没有报过同样bug。I have searched the [issues](https://github.com/PaddlePaddle/PaddleDetection/issues) and found no similar bug report. + required: true + +- type: textarea + id: code + attributes: + label: bug描述 Describe the Bug + description: | + 请清晰简洁的描述这个bug，最好附上bug复现步骤及最小代码集，以便我们可以通过运行代码来重现错误。代码片段需要尽可能简洁，请花些时间去掉不相关的代码以帮助我们有效地调试。我们希望通过复制代码并运行得到与你相同的结果，请避免任何外部数据或包含相关的导入等。如果代码太长，请将可执行代码放到[AIStudio](https://aistudio.baidu.com/aistudio/index)中并将项目设置为公开（或者放到github gist上），请在项目中描述清楚bug复现步骤，在issue中描述期望结果与实际结果。 + + 如果你报告的是一个报错信息，请将完整回溯的报错贴在这里，并使用 ` ```三引号块``` `展示错误信息。 + + + placeholder: | + 请清晰简洁的描述这个bug。A clear and concise description of what the bug is. + + ```python + # 最小可复现代码。 Sample code to reproduce the problem. + ``` + + ```shell + 带有完整回溯的报错信息。 The error message you got, with the full traceback. + ``` + validations: + required: true + +- type: textarea + attributes: + label: 复现环境 Environment + description: 请具体说明复现bug的环境信息，Please specify the software and hardware you used to produce the bug. + placeholder: | + - PaddlePaddle: 2.2.2 + - PaddleDetection: release/2.4 + - Python: 3.8.0 + - CUDA: 10.2 + - CUDNN: 7.6 + validations: + required: false + +- type: checkboxes + attributes: + label: 是否愿意提交PR Are you willing to submit a PR? + description: > + (可选)如果你对修复bug有自己的想法，十分鼓励提交[Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls)，共同提升PaddleDetection + + (Optional) We encourage you to submit a [Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls) (PR) to help improve PaddleDetection for everyone, especially if you have a good understanding of how to implement a fix or feature. + options: + - label: Yes I'd like to help by submitting a PR! + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/2_feature-request.yml b/.github/ISSUE_TEMPLATE/2_feature-request.yml new file mode 100644 index 000000000..dcf9ec446 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature-request.yml @@ -0,0 +1,50 @@ +name: 🚀 新需求 Feature Request +description: 提交一个你对PaddleDetection的新需求。 Submit a request for a new Paddle feature. +labels: [type/feature-request, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 你可以在这里提出你对PaddleDetection的新需求，包括但不限于：功能或模型缺失、功能不全或无法使用、精度/性能不符合预期等。 + + #### You could submit a request for a new feature here, including but not limited to: new features or models, incomplete or unusable features, accuracy/performance not as expected, etc. + +- type: checkboxes + attributes: + label: 问题确认 Search before asking + description: > + 在向PaddleDetection提新需求之前，请先查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)是否报过同样的需求。 + + Before submitting a feature request, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/PaddlePaddle/PaddleDetection/issues). + + options: + - label: > + 我已经查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)，没有类似需求。I have searched the [issues](https://github.com/PaddlePaddle/PaddleDetection/issues) and found no similar feature requests. + required: true + +- type: textarea + id: description + attributes: + label: 需求描述 Feature Description + description: | + 请尽可能包含任务目标、需求场景、功能描述等信息，全面的信息有利于我们准确评估你的需求。 + Please include as much information as possible, such as mission objectives, requirement scenarios, functional descriptions, etc. Comprehensive information will help us accurately assess your feature request. + value: "1. 任务目标（请描述你正在做的项目是什么，如模型、论文、项目是什么？）; 2. 需求场景（请描述你的项目中为什么需要用此功能）; 3. 功能描述（请简单描述或设计这个功能）" + validations: + required: true + +- type: checkboxes + attributes: + label: 是否愿意提交PR Are you willing to submit a PR? + description: > + (可选)如果你对新feature有自己的想法，十分鼓励提交[Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls)，共同提升PaddleDetection + + (Optional) We encourage you to submit a [Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls) (PR) to help improve PaddleDetection for everyone, especially if you have a good understanding of how to implement a fix or feature. + options: + - label: Yes I'd like to help by submitting a PR! + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/3_documentation-issue.yml b/.github/ISSUE_TEMPLATE/3_documentation-issue.yml new file mode 100644 index 000000000..4ea08cd5f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_documentation-issue.yml @@ -0,0 +1,38 @@ +name: 📚 文档 Documentation Issue +description: 反馈一个官网文档错误。 Report an issue related to https://github.com/PaddlePaddle/PaddleDetection. +labels: [type/docs, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 请确认反馈的问题来自PaddlePaddle官网文档：https://github.com/PaddlePaddle/PaddleDetection 。 + + #### Before submitting a Documentation Issue, Please make sure that issue is related to https://github.com/PaddlePaddle/PaddleDetection. + +- 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: 请提出你的建议 Please give your suggestion + description: | + 请告诉我们，你希望如何改进这个文档。或者你可以提个PR修复这个问题。 + Please tell us how you would like to improve this document. Or you can submit a PR to fix this problem. + + validations: + required: false + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉！Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/4_ask-a-question.yml b/.github/ISSUE_TEMPLATE/4_ask-a-question.yml new file mode 100644 index 000000000..af237f516 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_ask-a-question.yml @@ -0,0 +1,37 @@ +name: 🙋🏼‍♀️🙋🏻‍♂️提问 Ask a Question +description: 提出一个使用/咨询问题。 Ask a usage or consultation question. +labels: [type/question, status/new-issue] + +body: +- type: checkboxes + attributes: + label: 问题确认 Search before asking + description: > + #### 你可以在这里提出一个使用/咨询问题，提问之前请确保： + + - 1）已经百度/谷歌搜索过你的问题，但是没有找到解答； + + - 2）已经在官网查询过[教程文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.4/docs/tutorials/GETTING_STARTED_cn.md)与[FAQ](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.4/docs/tutorials/FAQ)，但是没有找到解答； + + - 3）已经在[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)中搜索过，没有找到同类issue或issue未被解答。 + + + #### You could ask a usage or consultation question here, before your start, please make sure: + + - 1) You have searched your question on Baidu/Google, but found no answer; + + - 2) You have checked the [tutorials](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.4/docs/tutorials/GETTING_STARTED.md), but found no answer; + + - 3) You have searched [the existing and past issues](https://github.com/PaddlePaddle/PaddleDetection/issues), but found no similar issue or the issue has not been answered. + + options: + - label: > + 我已经搜索过问题，但是没有找到解答。I have searched the question and found no related answer. + required: true + +- type: textarea + id: question + attributes: + label: 请提出你的问题 Please ask your question + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/5_others.yml b/.github/ISSUE_TEMPLATE/5_others.yml new file mode 100644 index 000000000..ec2f08ae1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_others.yml @@ -0,0 +1,23 @@ +name: 🧩 其他 Others +description: 提出其他问题。 Report any other non-support related issues. +labels: [type/others, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 你可以在这里提出任何前面几类模板不适用的问题，包括但不限于：优化性建议、框架使用体验反馈、版本兼容性问题、报错信息不清楚等。 + + #### You can report any issues that are not applicable to the previous types of templates, including but not limited to: enhancement suggestions, feedback on the use of the framework, version compatibility issues, unclear error information, etc. + +- type: textarea + id: others + attributes: + label: 问题描述 Please describe your issue + validations: + required: true + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉！ Thanks for your contribution 🎉! diff --git a/README_cn.md b/README_cn.md index f29b9f82f..1273e46e1 100644 --- a/README_cn.md +++ b/README_cn.md @@ -15,18 +15,18 @@

- + ## 产品动态 - 🔥 **2022.3.24：PaddleDetection发布[release/2.4版本](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.4)** - + - 发布高精度云边一体SOTA目标检测模型[PP-YOLOE](configs/ppyoloe)，发布s/m/l/x版本，l版本COCO test2017数据集精度51.4%，V100预测速度78.1 FPS，支持混合精度训练，训练较PP-YOLOv2加速33%，全系列多尺度模型，满足不同硬件算力需求，可适配服务器、边缘端GPU及其他服务器端AI加速卡。 - 发布边缘端和CPU端超轻量SOTA目标检测模型[PP-PicoDet增强版](configs/picodet)，精度提升2%左右，CPU预测速度提升63%，新增参数量0.7M的PicoDet-XS模型，提供模型稀疏化和量化功能，便于模型加速，各类硬件无需单独开发后处理模块，降低部署门槛。 - 发布实时行人分析工具[PP-Human](deploy/pphuman)，支持行人跟踪、人流量统计、人体属性识别与摔倒检测四大能力，基于真实场景数据特殊优化，精准识别各类摔倒姿势，适应不同环境背景、光线及摄像角度。 - 新增[YOLOX](configs/yolox)目标检测模型，支持nano/tiny/s/m/l/x版本，x版本COCO val2017数据集精度51.8%。 - 2021.11.03: PaddleDetection发布[release/2.3版本](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.3) - + - 发布轻量级检测特色模型⚡[PP-PicoDet](configs/picodet)，0.99m的参数量可实现精度30+mAP、速度150FPS。 - 发布轻量级关键点特色模型⚡[PP-TinyPose](configs/keypoint/tiny_pose)，单人场景FP16推理可达122FPS、51.8AP，具有精度高速度快、检测人数无限制、微小目标效果好的优势。 - 发布实时跟踪系统[PP-Tracking](deploy/pptracking)，覆盖单、多镜头下行人、车辆、多类别跟踪，对小目标、密集型特殊优化，提供人、车流量技术解决方案。 @@ -35,13 +35,13 @@ - 新增轻量化关键点模型[Lite HRNet](configs/keypoint)关键点模型并支持Paddle Lite部署。 - 2021.08.10: PaddleDetection发布[release/2.2版本](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.2) - + - 发布Transformer检测系列模型，包括[DETR](configs/detr), [Deformable DETR](configs/deformable_detr), [Sparse RCNN](configs/sparse_rcnn)。 - 新增Dark HRNet关键点模型和MPII数据集[关键点模型](configs/keypoint) - 新增[人头](configs/mot/headtracking21)、[车辆](configs/mot/vehicle)跟踪垂类模型。 - 2021.05.20: PaddleDetection发布[release/2.1版本](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.1) - + - 新增[关键点检测](configs/keypoint)，模型包括HigherHRNet，HRNet。 - 新增[多目标跟踪](configs/mot)能力，模型包括DeepSORT，JDE，FairMOT。 - 发布PPYOLO系列模型压缩模型，新增[ONNX模型导出教程](deploy/EXPORT_ONNX_MODEL.md)。 @@ -74,7 +74,7 @@ - 如果你发现任何PaddleDetection存在的问题或者是建议, 欢迎通过[GitHub Issues](https://github.com/PaddlePaddle/PaddleDetection/issues)给我们提issues。 - 欢迎加入PaddleDetection QQ、微信用户群（添加并回复小助手“检测”） - +
@@ -276,16 +276,16 @@ ### 进阶教程 - 参数配置 - + - [RCNN参数说明](docs/tutorials/config_annotation/faster_rcnn_r50_fpn_1x_coco_annotation.md) - [PP-YOLO参数说明](docs/tutorials/config_annotation/ppyolo_r50vd_dcn_1x_coco_annotation.md) - 模型压缩(基于[PaddleSlim](https://github.com/PaddlePaddle/PaddleSlim)) - + - [剪裁/量化/蒸馏教程](configs/slim) - [推理部署](deploy/README.md) - + - [模型导出教程](deploy/EXPORT_MODEL.md) - [Paddle Inference部署](deploy/README.md) - [Python端推理部署](deploy/python) @@ -296,7 +296,7 @@ - [推理benchmark](deploy/BENCHMARK_INFER.md) - 进阶开发 - + - [数据处理模块](docs/advanced_tutorials/READER.md) - [新增检测模型](docs/advanced_tutorials/MODEL_TECHNICAL.md) @@ -385,6 +385,7 @@ - 感谢[Chen-Song](https://github.com/Chen-Song)贡献`Swin Faster-RCNN`模型。 - 感谢[yangyudong](https://github.com/yangyudong2020), [hchhtc123](https://github.com/hchhtc123) 开发PP-Tracking GUI界面 - 感谢[Shigure19](https://github.com/Shigure19) 开发PP-TinyPose健身APP +- 感谢[manangoel99](https://github.com/manangoel99)贡献Wandb可视化方式 ## 引用 diff --git a/README_en.md b/README_en.md index 2028cfc5e..55660f6a4 100644 --- a/README_en.md +++ b/README_en.md @@ -19,7 +19,7 @@ English | [简体中文](README_cn.md) ## Latest News - 🔥 **2022.3.24：PaddleDetection [release 2.4 version](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.4)** - + - Release GPU SOTA object detection series models (s/m/l/x) [PP-YOLOE](configs/ppyoloe), supporting s/m/l/x version, achieving mAP as 51.4% on COCO test dataset and 78.1 FPS on Nvidia V100 by PP-YOLOE-l, supporting AMP training and its training speed is 33% faster than PP-YOLOv2. - Release enhanced models of [PP-PicoDet](configs/picodet), including PP-PicoDet-XS model with 0.7M parameters, its mAP promoted ~2% on COCO, inference speed accelerated 63% on CPU, and post-processing integrated into the network to optimize deployment pipeline. - Release real-time human analysis tool [PP-Human](deploy/pphuman), which is based on data from real-life situations, supporting pedestrian detection, attribute recognition, human tracking, multi-camera tracking, human statistics and action recognition. @@ -50,19 +50,19 @@ PaddleDetection is an end-to-end object detection development kit based on Paddl ## Features - **Rich Models** - + PaddleDetection provides rich of models, including **250+ pre-trained models** such as **object detection**, **instance segmentation**, **face detection**, **keypoint detection**, **multi-object tracking** and etc, covering a variety of **global competition champion** schemes. - **Highly Flexible** - + Components are designed to be modular. Model architectures, as well as data preprocess pipelines and optimization strategies, can be easily customized with simple configuration changes. - **Production Ready** - + From data augmentation, constructing models, training, compression, depolyment, get through end to end, and complete support for multi-architecture, multi-device deployment for **cloud and edge device**. - **High Performance** - + Based on the high performance core of PaddlePaddle, advantages of training speed and memory occupation are obvious. FP16 training and multi-machine training are supported as well. ## Community @@ -70,7 +70,7 @@ PaddleDetection is an end-to-end object detection development kit based on Paddl - If you have any problem or suggestion on PaddleDetection, please send us issues through [GitHub Issues](https://github.com/PaddlePaddle/PaddleDetection/issues). - Welcome to Join PaddleDetection QQ Group and Wechat Group (reply "Det"). - +
@@ -276,18 +276,18 @@ The relationship between COCO mAP and FPS on Qualcomm Snapdragon 865 of represen ### Advanced Tutorials - Parameter Configuration - + - [Parameter configuration for RCNN model](docs/tutorials/config_annotation/faster_rcnn_r50_fpn_1x_coco_annotation_en.md) - [Parameter configuration for PP-YOLO model](docs/tutorials/config_annotation/ppyolo_r50vd_dcn_1x_coco_annotation_en.md) - Model Compression(Based on [PaddleSlim](https://github.com/PaddlePaddle/PaddleSlim)) - + - [Prune/Quant/Distill](configs/slim) - [Metric Logging during Model Training](docs/tutorials/logging_en.md) - Inference and Deployment - + - [Export model for inference](deploy/EXPORT_MODEL_en.md) - [Paddle Inference](deploy/README_en.md) - [Python inference](deploy/python) @@ -299,7 +299,7 @@ The relationship between COCO mAP and FPS on Qualcomm Snapdragon 865 of represen - [Exporting to ONNX and using OpenVINO for inference](docs/advanced_tutorials/openvino_inference/README.md) - Advanced Development - + - [New data augmentations](docs/advanced_tutorials/READER_en.md) - [New detection algorithms](docs/advanced_tutorials/MODEL_TECHNICAL.md) @@ -362,6 +362,7 @@ Contributions are highly welcomed and we would really appreciate your feedback!! - Thanks [Chen-Song](https://github.com/Chen-Song) for contributing the code of `Swin Faster-RCNN` model. - Thanks [yangyudong](https://github.com/yangyudong2020), [hchhtc123](https://github.com/hchhtc123) for contributing PP-Tracking GUI interface. - Thanks [Shigure19](https://github.com/Shigure19) for contributing PP-TinyPose fitness APP. +- Thanks [manangoel99](https://github.com/manangoel99) for contributing Wandblogger for visualization of the training and evaluation metrics ## Citation -- GitLab