From de2589ea425e037312ac16c7a4695235c1acc2fb Mon Sep 17 00:00:00 2001 From: Guanghua Yu <742925032@qq.com> Date: Mon, 24 Feb 2020 12:48:20 +0800 Subject: [PATCH] Fix softlink (#256) --- README.md | 4 ++-- README_en.md | 11 ++++++----- docs/advanced_tutorials/slim/DISTILLATION.md | 1 - docs/advanced_tutorials/slim/MODEL_ZOO.md | 2 +- docs/advanced_tutorials/slim/NAS.md | 1 - docs/advanced_tutorials/slim/QUANTIZATION.md | 1 - .../slim/distillation/DISTILLATION.md | 1 + docs/advanced_tutorials/slim/distillation/index.rst | 7 +++++++ docs/advanced_tutorials/slim/index.rst | 8 ++++---- docs/advanced_tutorials/slim/nas/NAS.md | 1 + docs/advanced_tutorials/slim/nas/index.rst | 7 +++++++ docs/advanced_tutorials/slim/prune/index.rst | 2 +- .../slim/quantization/QUANTIZATION.md | 1 + docs/advanced_tutorials/slim/quantization/index.rst | 7 +++++++ slim/README.md | 10 ++++------ 15 files changed, 42 insertions(+), 22 deletions(-) delete mode 120000 docs/advanced_tutorials/slim/DISTILLATION.md delete mode 120000 docs/advanced_tutorials/slim/NAS.md delete mode 120000 docs/advanced_tutorials/slim/QUANTIZATION.md create mode 120000 docs/advanced_tutorials/slim/distillation/DISTILLATION.md create mode 100644 docs/advanced_tutorials/slim/distillation/index.rst create mode 120000 docs/advanced_tutorials/slim/nas/NAS.md create mode 100644 docs/advanced_tutorials/slim/nas/index.rst create mode 120000 docs/advanced_tutorials/slim/quantization/QUANTIZATION.md create mode 100644 docs/advanced_tutorials/slim/quantization/index.rst diff --git a/README.md b/README.md index 3daf6d9af..7351e2772 100644 --- a/README.md +++ b/README.md @@ -80,11 +80,11 @@ PaddleDetection的目的是为工业界和学术界提供丰富、易用的目 - [IPython Notebook demo](demo/mask_rcnn_demo.ipynb) - [迁移学习教程](docs/advanced_tutorials/TRANSFER_LEARNING_cn.md) - [模型压缩](slim) + - [压缩benchmark](slim) - [量化](slim/quantization) - [剪枝](slim/prune) - [蒸馏](slim/distillation) - [神经网络搜索](slim/nas) - - [压缩benchmark](slim) - [推理部署](inference) - [模型导出教程](docs/advanced_tutorials/inference/EXPORT_MODEL.md) - [预测引擎Python API使用示例](docs/advanced_tutorials/inference/INFERENCE.md) @@ -105,7 +105,7 @@ PaddleDetection的目的是为工业界和学术界提供丰富、易用的目 本项目的发布受[Apache 2.0 license](LICENSE)许可认证。 ## 版本更新 -v0.2.0版本已经在`01/2020`发布，增加多个模型，升级数据处理模块，拆分YOLOv3的loss，修复已知诸多bug等， +v0.2.0版本已经在`02/2020`发布，增加多个模型，升级数据处理模块，拆分YOLOv3的loss，修复已知诸多bug等， 详细内容请参考[版本更新文档](docs/CHANGELOG.md)。 ## 如何贡献代码 diff --git a/README_en.md b/README_en.md index 5371e3e8a..290ae0107 100644 --- a/README_en.md +++ b/README_en.md @@ -91,10 +91,11 @@ Advanced Features: - [IPython Notebook demo](demo/mask_rcnn_demo.ipynb) - [Transfer learning document](docs/advanced_tutorials/TRANSFER_LEARNING.md) - [Model compression](slim) - - [Quantization-aware training example](slim/quantization) - - [Model pruning example](slim/prune) - - [Model distillation example](slim/distillation) - - [Neural Architecture Search example](slim/nas) + - [Model compression benchmark](slim) + - [Quantization](slim/quantization) + - [Model pruning](slim/prune) + - [Model distillation](slim/distillation) + - [Neural Architecture Search](slim/nas) - [Deployment](inference) - [Export model for inference](docs/advanced_tutorials/inference/EXPORT_MODEL.md) - [Model inference](docs/advanced_tutorials/inference/INFERENCE.md) @@ -115,7 +116,7 @@ Advanced Features: PaddleDetection is released under the [Apache 2.0 license](LICENSE). ## Updates -v0.2.0 was released at `01/2020`, add some models，Upgrade data processing module, Split YOLOv3's loss, fix many known bugs, etc. +v0.2.0 was released at `02/2020`, add some models，Upgrade data processing module, Split YOLOv3's loss, fix many known bugs, etc. Please refer to [版本更新文档](docs/CHANGELOG.md) for details. ## Contributing diff --git a/docs/advanced_tutorials/slim/DISTILLATION.md b/docs/advanced_tutorials/slim/DISTILLATION.md deleted file mode 120000 index f728fe62e..000000000 --- a/docs/advanced_tutorials/slim/DISTILLATION.md +++ /dev/null @@ -1 +0,0 @@ -../../../slim/distillation/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/MODEL_ZOO.md b/docs/advanced_tutorials/slim/MODEL_ZOO.md index 7917472b6..5e2728515 120000 --- a/docs/advanced_tutorials/slim/MODEL_ZOO.md +++ b/docs/advanced_tutorials/slim/MODEL_ZOO.md @@ -1 +1 @@ -slim/README.md \ No newline at end of file +../../../slim/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/NAS.md b/docs/advanced_tutorials/slim/NAS.md deleted file mode 120000 index 9515d6312..000000000 --- a/docs/advanced_tutorials/slim/NAS.md +++ /dev/null @@ -1 +0,0 @@ -../../../slim/nas/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/QUANTIZATION.md b/docs/advanced_tutorials/slim/QUANTIZATION.md deleted file mode 120000 index e4e95a4aa..000000000 --- a/docs/advanced_tutorials/slim/QUANTIZATION.md +++ /dev/null @@ -1 +0,0 @@ -../../../slim/quantization/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/distillation/DISTILLATION.md b/docs/advanced_tutorials/slim/distillation/DISTILLATION.md new file mode 120000 index 000000000..21f601f55 --- /dev/null +++ b/docs/advanced_tutorials/slim/distillation/DISTILLATION.md @@ -0,0 +1 @@ +../../../../slim/distillation/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/distillation/index.rst b/docs/advanced_tutorials/slim/distillation/index.rst new file mode 100644 index 000000000..5d1a2326a --- /dev/null +++ b/docs/advanced_tutorials/slim/distillation/index.rst @@ -0,0 +1,7 @@ +模型蒸馏 +=========================================== + +.. toctree:: + :maxdepth: 2 + + DISTILLATION.md diff --git a/docs/advanced_tutorials/slim/index.rst b/docs/advanced_tutorials/slim/index.rst index 592313990..a8af21d6f 100644 --- a/docs/advanced_tutorials/slim/index.rst +++ b/docs/advanced_tutorials/slim/index.rst @@ -4,8 +4,8 @@ .. toctree:: :maxdepth: 2 - DISTILLATION.md - QUANTIZATION.md - NAS.md - prune/index MODEL_ZOO.md + distillation/index + quantization/index + nas/index + prune/index diff --git a/docs/advanced_tutorials/slim/nas/NAS.md b/docs/advanced_tutorials/slim/nas/NAS.md new file mode 120000 index 000000000..0d75ab343 --- /dev/null +++ b/docs/advanced_tutorials/slim/nas/NAS.md @@ -0,0 +1 @@ +../../../../slim/nas/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/nas/index.rst b/docs/advanced_tutorials/slim/nas/index.rst new file mode 100644 index 000000000..fd181e55f --- /dev/null +++ b/docs/advanced_tutorials/slim/nas/index.rst @@ -0,0 +1,7 @@ +神经网络搜索 +=========================================== + +.. toctree:: + :maxdepth: 2 + + NAS.md diff --git a/docs/advanced_tutorials/slim/prune/index.rst b/docs/advanced_tutorials/slim/prune/index.rst index 68d00e509..88a783f08 100644 --- a/docs/advanced_tutorials/slim/prune/index.rst +++ b/docs/advanced_tutorials/slim/prune/index.rst @@ -1,4 +1,4 @@ -模型剪枝教程 +模型剪枝 =========================================== .. toctree:: diff --git a/docs/advanced_tutorials/slim/quantization/QUANTIZATION.md b/docs/advanced_tutorials/slim/quantization/QUANTIZATION.md new file mode 120000 index 000000000..ef66629b4 --- /dev/null +++ b/docs/advanced_tutorials/slim/quantization/QUANTIZATION.md @@ -0,0 +1 @@ +../../../../slim/quantization/README.md \ No newline at end of file diff --git a/docs/advanced_tutorials/slim/quantization/index.rst b/docs/advanced_tutorials/slim/quantization/index.rst new file mode 100644 index 000000000..38899a450 --- /dev/null +++ b/docs/advanced_tutorials/slim/quantization/index.rst @@ -0,0 +1,7 @@ +模型量化 +=========================================== + +.. toctree:: + :maxdepth: 2 + + QUANTIZATION.md diff --git a/slim/README.md b/slim/README.md index 19fbbe3bf..237b11a6b 100644 --- a/slim/README.md +++ b/slim/README.md @@ -1,4 +1,4 @@ -# 简介 +# 压缩benchmark 在PaddleDetection, 提供了基于PaddleSlim进行模型压缩的完整教程和实验结果。详细教程请参考： @@ -9,8 +9,6 @@ 下面给出压缩的benchmark实验结果。 -# 压缩模型库 - ## 测试环境 - Python 2.7.1 @@ -23,7 +21,7 @@ ### 训练策略 -- 剪裁模型训练时使用[PaddleDetection模型库](../docs/MODEL_ZOO_cn.md)发布的模型权重作为预训练权重。 +- 剪裁模型训练时使用[PaddleDetection模型库](https://paddledetection.readthedocs.io/zh/latest/MODEL_ZOO_cn.html)发布的模型权重作为预训练权重。 - 剪裁训练使用模型默认配置，即除`pretrained_weights`外配置不变。 - 剪裁模型全部为基于敏感度的卷积通道剪裁。 - YOLOv3模型主要剪裁`yolo_head`部分，即剪裁参数如下。 @@ -69,7 +67,7 @@ ### 蒸馏通道剪裁模型 -可通过高精度模型蒸馏通道剪裁后模型的方式，训练方法及相关示例见[蒸馏通道剪裁模型](./extensions/distill_pruned_model/distill_pruned_model_demo.ipynb)。 +可通过高精度模型蒸馏通道剪裁后模型的方式，训练方法及相关示例见[蒸馏通道剪裁模型](https://github.com/PaddlePaddle/PaddleDetection/blob/master/slim/extensions/distill_pruned_model/distill_pruned_model_demo.ipynb)。 COCO数据集上蒸馏通道剪裁模型库如下。 @@ -93,7 +91,7 @@ Pascal VOC数据集上蒸馏通道剪裁模型库如下。 ### 训练策略 -- 蒸馏模型训练时teacher模型使用[PaddleDetection模型库](../docs/MODEL_ZOO_cn.md)发布的模型权重作为预训练权重。 +- 蒸馏模型训练时teacher模型使用[PaddleDetection模型库](https://paddledetection.readthedocs.io/zh/latest/MODEL_ZOO_cn.html)发布的模型权重作为预训练权重。 - 蒸馏模型训练时student模型使用backbone的预训练权重 ### YOLOv3 on COCO -- GitLab