diff --git a/README.md b/README.md index 54b2d41b6dd2cfa16ba5ef2e081231ad043796b7..e799c6bd3de46d107383b628c9af7a3d05a8029c 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) [![build status](http://v9.git.n.xiaomi.com/deep-computing/mace/badges/master/build.svg)](http://v9.git.n.xiaomi.com/deep-computing/mace/pipelines) +[![doc build status](https://readthedocs.org/projects/mace/badge/?version=latest)](https://readthedocs.org/projects/mace/badge/?version=latest) -[Documentation](docs) | -[FAQ](docs/faq.md) | +[Documentation](https://mace.readthedocs.io) | +[FAQ](https://mace.readthedocs.io/en/latest/faq.html) | [Release Notes](RELEASE.md) | [Roadmap](ROADMAP.md) | [MACE Model Zoo](https://github.com/XiaoMi/mace-models) | @@ -43,9 +44,9 @@ targets: archetectures with limited performance. ## Getting Started -* [Introduction](docs/getting_started/introduction.rst) -* [How to build](docs/getting_started/how_to_build.rst) -* [Create a model deployment file](docs/getting_started/create_a_model_deployment.rst) +* [Introduction](https://mace.readthedocs.io/en/latest/getting_started/introduction.html) +* [Create a model deployment file](https://mace.readthedocs.io/en/latest/getting_started/create_a_model_deployment.html) +* [How to build](https://mace.readthedocs.io/en/latest/getting_started/how_to_build.html) ## Performance [MACE Model Zoo](https://github.com/XiaoMi/mace-models) contains @@ -62,7 +63,7 @@ phones. The benchmark result can be found in the CI result page. Any kind of contributions are welcome. For bug reports, feature requests, please just open an issue without any hesitance. For code contributions, it's strongly suggested to open an issue for discussion first. For more details, -please refer to [the contribution guide](docs/development/contributing.md). +please refer to [the contribution guide](https://mace.readthedocs.io/en/latest/development/contributing.html). ## License [Apache License 2.0](LICENSE). diff --git a/README_zh.md b/README_zh.md index 38ccd71f2feeca95444856bbcb2a9805e4e6ba12..a0e9c6615b0a8e23666fb13009849c8f3b99eacf 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,9 +1,13 @@ -# MACE - 移动人工智能计算引擎 +
+MACE +
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) [![build status](http://v9.git.n.xiaomi.com/deep-computing/mace/badges/master/build.svg)](http://v9.git.n.xiaomi.com/deep-computing/mace/pipelines) +[![doc build status](https://readthedocs.org/projects/mace/badge/?version=latest)](https://readthedocs.org/projects/mace/badge/?version=latest) -[文档](docs) | -[FAQ](docs/faq.md) | +[文档](https://mace.readthedocs.io) | +[FAQ](https://mace.readthedocs.io/en/latest/faq.html) | [发布记录](RELEASE.md) | [路线图](ROADMAP.md) | [MACE Model Zoo](https://github.com/XiaoMi/mace-models) | @@ -31,9 +35,9 @@ 同时支持在具有POSIX接口的系统的CPU上运行。 ## 开始使用 -* [简介](docs/getting_started/introduction.rst) -* [创建模型部署文件](docs/getting_started/create_a_model_deployment.rst) -* [如何构建](docs/getting_started/how_to_build.rst) +* [简介](https://mace.readthedocs.io/en/latest/getting_started/introduction.html) +* [创建模型部署文件](https://mace.readthedocs.io/en/latest/getting_started/create_a_model_deployment.html) +* [如何构建](https://mace.readthedocs.io/en/latest/getting_started/how_to_build.html) ## 性能评测 [MACE Model Zoo](https://github.com/XiaoMi/mace-models)