From 96e7da5c014fad0012dd1fe62f74e6bf23b0ca40 Mon Sep 17 00:00:00 2001 From: liuyuan04 Date: Tue, 30 Aug 2016 09:32:39 +0000 Subject: [PATCH] Add links to corresponding english docs for unfinished Chinese docs ISSUE=4591775 git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1425 1ad973e4-5ce8-4261-8a94-b56d1f490c56 --- doc/build/build_from_source.md | 2 +- .../build_and_install/cmake/install_deps.rst | 4 +-- .../cmake/make_and_install.rst | 2 ++ doc_cn/cluster/index.rst | 6 ++--- doc_cn/demo/index.md | 22 ---------------- doc_cn/demo/index.rst | 25 +++++++++++++++++++ doc_cn/index.md | 4 +-- doc_cn/ui/cmd/index.rst | 3 ++- doc_cn/ui/index.rst | 20 +++++++-------- 9 files changed, 46 insertions(+), 42 deletions(-) delete mode 100644 doc_cn/demo/index.md create mode 100644 doc_cn/demo/index.rst diff --git a/doc/build/build_from_source.md b/doc/build/build_from_source.md index 66eca325bcd..9d3b0308028 100644 --- a/doc/build/build_from_source.md +++ b/doc/build/build_from_source.md @@ -92,7 +92,7 @@ pip install sphinx_rtd_theme breathe recommonmark sudo apt-get install python-sphinx doxygen ``` -### Build an Install +### Build and Install CMake will find dependent libraries in system default paths first. After installing some optional libraries, corresponding build option will automatically be on(such as glog, gtest and gflags). And if libraries are not found, you have to set following variables manually in cmake command(CUDNN_ROOT, ATLAS_ROOT, MKL_ROOT, OPENBLAS_ROOT). diff --git a/doc_cn/build_and_install/cmake/install_deps.rst b/doc_cn/build_and_install/cmake/install_deps.rst index dd288b5a39b..7fa4665a954 100644 --- a/doc_cn/build_and_install/cmake/install_deps.rst +++ b/doc_cn/build_and_install/cmake/install_deps.rst @@ -1,4 +1,4 @@ 安装编译PaddlePaddle需要的依赖 -======================== +============================== -TBD +参见 `安装编译依赖 <../../../doc/build/build_from_source.html#install-dependencies>`_ diff --git a/doc_cn/build_and_install/cmake/make_and_install.rst b/doc_cn/build_and_install/cmake/make_and_install.rst index 2bda70ffedc..212b9c9352b 100644 --- a/doc_cn/build_and_install/cmake/make_and_install.rst +++ b/doc_cn/build_and_install/cmake/make_and_install.rst @@ -1,2 +1,4 @@ make和make install ================== + +参见 `make和make install <../../../doc/build/build_from_source.html#build-and-install>`_ diff --git a/doc_cn/cluster/index.rst b/doc_cn/cluster/index.rst index b8a7a05a796..16c1f0e37bc 100644 --- a/doc_cn/cluster/index.rst +++ b/doc_cn/cluster/index.rst @@ -1,4 +1,4 @@ -Cluster Train -==================== +集群训练 +======== -TBD +参见 `集群训练 <../../doc/cluster/index.html>`_ diff --git a/doc_cn/demo/index.md b/doc_cn/demo/index.md deleted file mode 100644 index dd5ce8d4f9a..00000000000 --- a/doc_cn/demo/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# 使用示例 - -## Image - -* [Image Classification](image_classification/index.rst) - -## NLP - -* [Sentiment Analysis](sentiment_analysis/index.md) -* [Text Generation](text_generation/index.rst) -* [Semantic Role Labeling](semantic_role_labeling/index.md) - -## Recommendation - -* MovieLens Dataset -* MovieLens Regression - -## Model Zoo -* [ImageNet: ResNet](imagenet_model/index.md) -* [Embedding: Chinese Word](embedding_model/index.md) - - diff --git a/doc_cn/demo/index.rst b/doc_cn/demo/index.rst new file mode 100644 index 00000000000..251da72d35d --- /dev/null +++ b/doc_cn/demo/index.rst @@ -0,0 +1,25 @@ +使用示例 +======== + +图像 +'''' + +* `图像分类 <../../doc/demo/image_classification/index.html>`_ + +自然语言处理 +'''''''''''' + +* `情感分析 <../../doc/demo/sentiment_analysis/index.html>`_ +* `文本生成 <../../doc/demo/text_generation/index.html>`_ +* `词性标注 <../../doc/demo/semantic_role_labeling/index.html>`_ + +推荐 +'''' + +* `MovieLens数据集 <../../doc/demo/rec/ml_dataset.html>`_ +* `MovieLens评分回归 <../../doc/demo/rec/ml_regression.html>`_ + +常用模型 +'''''''' +* `ImageNet: ResNet <../../doc/demo/imagenet_model/index.html>`_ +* `Embedding: Chinese Word <../../doc/demo/embedding_model/index.html>`_ diff --git a/doc_cn/index.md b/doc_cn/index.md index 765a1ae2d6b..0beaa5852b5 100644 --- a/doc_cn/index.md +++ b/doc_cn/index.md @@ -3,6 +3,6 @@ Paddle文档 * [快速入门](demo/quick_start/index.md) * [编译与安装](build_and_install/index.rst) -* [用户接口](ui/index.md) -* [使用示例](demo/index.md) +* [用户接口](ui/index.rst) +* [使用示例](demo/index.rst) * [集群训练](cluster/index.rst) diff --git a/doc_cn/ui/cmd/index.rst b/doc_cn/ui/cmd/index.rst index 7f492a537c1..6d62180a6a5 100644 --- a/doc_cn/ui/cmd/index.rst +++ b/doc_cn/ui/cmd/index.rst @@ -14,7 +14,8 @@ 更详细的介绍请参考各个命令的命令行参数文档。 .. toctree:: - + :glob: + paddle_train.rst paddle_pserver.rst paddle_version.rst diff --git a/doc_cn/ui/index.rst b/doc_cn/ui/index.rst index 06566539867..e1850eb9528 100644 --- a/doc_cn/ui/index.rst +++ b/doc_cn/ui/index.rst @@ -1,29 +1,27 @@ -配置 -==== - -TBD +用户接口 +======== 数据提供 -======== +'''''''' .. toctree:: data_provider/index.rst API参考 -======= +''''''' `Trainer Config Helper `_ 命令行参数 -========== - -.. toctree:: +'''''''''' +* `Use Case <../../doc/ui/cmd_argument/use_case.html>`_ +* `Argument Outline <../../doc/ui/cmd_argument/argument_outline.html>`_ +* `Detail Description <../../doc/ui/cmd_argument/detail_introduction.html>`_ - cmd/index.rst 预测 -==== +'''' .. toctree:: -- GitLab