diff --git a/README.md b/README.md index fb51e9d15afc0e15d1f738feb88a49a5525b2bc7..0439d84ed9e0de80890f69992343fc55ff6d8d2b 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,9 @@ pip install paddleslim -i https://pypi.org/simple ## 使用 -- [API文档]():API使用介绍,包括[蒸馏]()、[剪裁]()、[量化]()和[模型结构搜索]()。 -- [示例]():基于mnist和cifar10等简单分类任务的模型压缩示例,您可以通过该部分快速体验和了解PaddleSlim的功能。 +- [API文档](doc/api_guide.md):API使用介绍,包括[蒸馏]()、[剪裁]()、[量化]()和[模型结构搜索]()。 +- [示例](doc/demo_guide.md):基于mnist和cifar10等简单分类任务的模型压缩示例,您可以通过该部分快速体验和了解PaddleSlim的功能。 +- [实践教程]():经典模型的分析和压缩实验教程。 - [模型库]():经过压缩的分类、检测、语义分割模型,包括权重文件、网络结构文件和性能数据。 - [Paddle检测库]():介绍如何在检测库中使用PaddleSlim。 - [Paddle分割库]():介绍如何在分割库中使用PaddleSlim。 diff --git a/doc/api_guide.md b/doc/api_guide.md new file mode 100644 index 0000000000000000000000000000000000000000..c7ea418c70560c860a6241e27156dd3ea3b1acf2 --- /dev/null +++ b/doc/api_guide.md @@ -0,0 +1,16 @@ + +## [蒸馏]() + +### [单进程蒸馏](../paddleslim/dist/single_distiller_api_doc.md) + +### [通道剪裁](../paddleslim/prune/prune_api.md) + +### [量化](../paddleslim/prune/prune_api.md) + +#### [量化训练]() + +#### [离线量化]() + +#### [embedding量化]() + +## [小模型结构搜索]() diff --git a/doc/demo_guide.md b/doc/demo_guide.md new file mode 100644 index 0000000000000000000000000000000000000000..affbd8c246d2d08db8f535068202c3058cc1b80b --- /dev/null +++ b/doc/demo_guide.md @@ -0,0 +1,2 @@ + +## [蒸馏]()