From 4611a91f9a415d1bcd2b3a56bc8326452d601d96 Mon Sep 17 00:00:00 2001 From: Luo Tao Date: Wed, 28 Feb 2018 18:17:02 +0800 Subject: [PATCH] adjust the structure of documentation (en) --- doc/build_and_install/pip_install_en.rst | 4 ++-- doc/dev/index_en.rst | 1 - doc/faq/build_and_install/index_en.rst | 5 +++++ doc/faq/cluster/index_en.rst | 5 +++++ doc/faq/index_en.rst | 12 ++++++++++++ doc/faq/local/index_en.rst | 5 +++++ doc/faq/model/index_en.rst | 5 +++++ doc/faq/parameter/index_en.rst | 5 +++++ doc/getstarted/concepts/use_concepts_en.rst | 3 +++ doc/getstarted/index_en.rst | 1 + doc/howto/capi/compile_paddle_lib_en.md | 3 +++ doc/howto/capi/index_en.rst | 9 +++++++++ doc/howto/capi/organization_of_the_inputs_en.md | 3 +++ doc/howto/capi/workflow_of_capi_en.md | 3 +++ doc/howto/cluster/multi_cluster/fabric_en.md | 2 +- doc/howto/cluster/multi_cluster/k8s_aws_en.md | 3 +-- .../cluster/multi_cluster/k8s_distributed_en.md | 3 +++ doc/howto/cluster/multi_cluster/k8s_en.md | 2 +- doc/howto/cluster/multi_cluster/openmpi_cn.md | 2 +- doc/howto/cluster/multi_cluster/openmpi_en.md | 2 +- doc/howto/rnn/hierarchical_layer_en.rst | 4 ++++ doc/howto/rnn/hrnn_rnn_api_compare_en.rst | 4 ++++ doc/howto/rnn/index_en.rst | 3 +++ doc/howto/rnn/recurrent_group_en.md | 3 +++ doc/index_en.rst | 1 + 25 files changed, 84 insertions(+), 9 deletions(-) create mode 100644 doc/faq/build_and_install/index_en.rst create mode 100644 doc/faq/cluster/index_en.rst create mode 100644 doc/faq/index_en.rst create mode 100644 doc/faq/local/index_en.rst create mode 100644 doc/faq/model/index_en.rst create mode 100644 doc/faq/parameter/index_en.rst create mode 100644 doc/getstarted/concepts/use_concepts_en.rst create mode 100644 doc/howto/capi/compile_paddle_lib_en.md create mode 100644 doc/howto/capi/index_en.rst create mode 100644 doc/howto/capi/organization_of_the_inputs_en.md create mode 100644 doc/howto/capi/workflow_of_capi_en.md create mode 100644 doc/howto/cluster/multi_cluster/k8s_distributed_en.md create mode 100644 doc/howto/rnn/hierarchical_layer_en.rst create mode 100644 doc/howto/rnn/hrnn_rnn_api_compare_en.rst create mode 100644 doc/howto/rnn/recurrent_group_en.md diff --git a/doc/build_and_install/pip_install_en.rst b/doc/build_and_install/pip_install_en.rst index c1e806c0f..0d4c925b6 100644 --- a/doc/build_and_install/pip_install_en.rst +++ b/doc/build_and_install/pip_install_en.rst @@ -1,4 +1,4 @@ -Install Using pip +Install using pip ================================ You can use current widely used Python package management @@ -8,7 +8,7 @@ most of current Linux systems or MacOS. .. _pip_install: -Install Using pip +Install using pip ------------------------------ Run the following command to install PaddlePaddle on the current diff --git a/doc/dev/index_en.rst b/doc/dev/index_en.rst index 5dd12d223..5fdc30a2d 100644 --- a/doc/dev/index_en.rst +++ b/doc/dev/index_en.rst @@ -4,6 +4,5 @@ Development .. toctree:: :maxdepth: 1 - new_layer_en.rst contribute_to_paddle_en.md write_docs_en.rst diff --git a/doc/faq/build_and_install/index_en.rst b/doc/faq/build_and_install/index_en.rst new file mode 100644 index 000000000..614db457d --- /dev/null +++ b/doc/faq/build_and_install/index_en.rst @@ -0,0 +1,5 @@ +############################ +Install, Build and Unit test +############################ + +TBD diff --git a/doc/faq/cluster/index_en.rst b/doc/faq/cluster/index_en.rst new file mode 100644 index 000000000..855b7e8e5 --- /dev/null +++ b/doc/faq/cluster/index_en.rst @@ -0,0 +1,5 @@ +############################### +Cluster Training and Prediction +############################### + +TBD diff --git a/doc/faq/index_en.rst b/doc/faq/index_en.rst new file mode 100644 index 000000000..57df868f7 --- /dev/null +++ b/doc/faq/index_en.rst @@ -0,0 +1,12 @@ +FAQ +==== + + +.. toctree:: + :maxdepth: 1 + + build_and_install/index_en.rst + model/index_en.rst + parameter/index_en.rst + local/index_en.rst + cluster/index_en.rst diff --git a/doc/faq/local/index_en.rst b/doc/faq/local/index_en.rst new file mode 100644 index 000000000..4cb430319 --- /dev/null +++ b/doc/faq/local/index_en.rst @@ -0,0 +1,5 @@ +############################# +Local Training and Prediction +############################# + +TBD diff --git a/doc/faq/model/index_en.rst b/doc/faq/model/index_en.rst new file mode 100644 index 000000000..cb26f5965 --- /dev/null +++ b/doc/faq/model/index_en.rst @@ -0,0 +1,5 @@ +################### +Model Configuration +################### + +TBD diff --git a/doc/faq/parameter/index_en.rst b/doc/faq/parameter/index_en.rst new file mode 100644 index 000000000..61c7845af --- /dev/null +++ b/doc/faq/parameter/index_en.rst @@ -0,0 +1,5 @@ +################# +Parameter Setting +################# + +TBD diff --git a/doc/getstarted/concepts/use_concepts_en.rst b/doc/getstarted/concepts/use_concepts_en.rst new file mode 100644 index 000000000..406b0cbb9 --- /dev/null +++ b/doc/getstarted/concepts/use_concepts_en.rst @@ -0,0 +1,3 @@ +Basic Concept +============= +TBD diff --git a/doc/getstarted/index_en.rst b/doc/getstarted/index_en.rst index c680e1903..33f299be5 100644 --- a/doc/getstarted/index_en.rst +++ b/doc/getstarted/index_en.rst @@ -5,3 +5,4 @@ GET STARTED :maxdepth: 1 quickstart_en.rst + concepts/use_concepts_en.rst diff --git a/doc/howto/capi/compile_paddle_lib_en.md b/doc/howto/capi/compile_paddle_lib_en.md new file mode 100644 index 000000000..11d69b9b7 --- /dev/null +++ b/doc/howto/capi/compile_paddle_lib_en.md @@ -0,0 +1,3 @@ +## Install and Build + +TBD diff --git a/doc/howto/capi/index_en.rst b/doc/howto/capi/index_en.rst new file mode 100644 index 000000000..2cbbe362f --- /dev/null +++ b/doc/howto/capi/index_en.rst @@ -0,0 +1,9 @@ +C-API Prediction Library +======================== + +.. toctree:: + :maxdepth: 1 + + compile_paddle_lib_en.md + organization_of_the_inputs_en.md + workflow_of_capi_en.md diff --git a/doc/howto/capi/organization_of_the_inputs_en.md b/doc/howto/capi/organization_of_the_inputs_en.md new file mode 100644 index 000000000..250d3b2f7 --- /dev/null +++ b/doc/howto/capi/organization_of_the_inputs_en.md @@ -0,0 +1,3 @@ +## Input/Output Data Organization + +TBD diff --git a/doc/howto/capi/workflow_of_capi_en.md b/doc/howto/capi/workflow_of_capi_en.md new file mode 100644 index 000000000..1692ecd56 --- /dev/null +++ b/doc/howto/capi/workflow_of_capi_en.md @@ -0,0 +1,3 @@ +## C-API Workflow + +TBD diff --git a/doc/howto/cluster/multi_cluster/fabric_en.md b/doc/howto/cluster/multi_cluster/fabric_en.md index bf270d89a..bac9ffe15 100644 --- a/doc/howto/cluster/multi_cluster/fabric_en.md +++ b/doc/howto/cluster/multi_cluster/fabric_en.md @@ -1,4 +1,4 @@ -# Cluster Training Using Fabric +# Fabric ## Prepare a Linux cluster diff --git a/doc/howto/cluster/multi_cluster/k8s_aws_en.md b/doc/howto/cluster/multi_cluster/k8s_aws_en.md index 0dfa8237a..8e8e87be7 100644 --- a/doc/howto/cluster/multi_cluster/k8s_aws_en.md +++ b/doc/howto/cluster/multi_cluster/k8s_aws_en.md @@ -1,5 +1,4 @@ - -# Distributed PaddlePaddle Training on AWS with Kubernetes +# Kubernetes on AWS We will show you step by step on how to run distributed PaddlePaddle training on AWS cluster with Kubernetes. Let's start from core concepts. diff --git a/doc/howto/cluster/multi_cluster/k8s_distributed_en.md b/doc/howto/cluster/multi_cluster/k8s_distributed_en.md new file mode 100644 index 000000000..bc3d50b3f --- /dev/null +++ b/doc/howto/cluster/multi_cluster/k8s_distributed_en.md @@ -0,0 +1,3 @@ +# Kubernetes Distributed + +TBD diff --git a/doc/howto/cluster/multi_cluster/k8s_en.md b/doc/howto/cluster/multi_cluster/k8s_en.md index c374f00a4..96ff65270 100644 --- a/doc/howto/cluster/multi_cluster/k8s_en.md +++ b/doc/howto/cluster/multi_cluster/k8s_en.md @@ -1,4 +1,4 @@ -# PaddlePaddle On Kubernetes +# Kubernetes In this article, we will introduce how to run PaddlePaddle training job on single CPU machine using Kubernetes. In next article, we will introduce how to run PaddlePaddle training job on distributed cluster. diff --git a/doc/howto/cluster/multi_cluster/openmpi_cn.md b/doc/howto/cluster/multi_cluster/openmpi_cn.md index 831cafdc0..954b2215c 100644 --- a/doc/howto/cluster/multi_cluster/openmpi_cn.md +++ b/doc/howto/cluster/multi_cluster/openmpi_cn.md @@ -1,4 +1,4 @@ -# 在OpenMPI集群中提交训练作业 +# 在OpenMPI集群中启动训练 ## 准备OpenMPI集群 diff --git a/doc/howto/cluster/multi_cluster/openmpi_en.md b/doc/howto/cluster/multi_cluster/openmpi_en.md index 09af46e25..a5c02b336 100644 --- a/doc/howto/cluster/multi_cluster/openmpi_en.md +++ b/doc/howto/cluster/multi_cluster/openmpi_en.md @@ -1,4 +1,4 @@ -# Cluster Training Using OpenMPI +# OpenMPI ## Prepare an OpenMPI cluster diff --git a/doc/howto/rnn/hierarchical_layer_en.rst b/doc/howto/rnn/hierarchical_layer_en.rst new file mode 100644 index 000000000..236f58a16 --- /dev/null +++ b/doc/howto/rnn/hierarchical_layer_en.rst @@ -0,0 +1,4 @@ +Layers supporting hierarchical sequence as input +================================================ + +TBD diff --git a/doc/howto/rnn/hrnn_rnn_api_compare_en.rst b/doc/howto/rnn/hrnn_rnn_api_compare_en.rst new file mode 100644 index 000000000..e5aa05c11 --- /dev/null +++ b/doc/howto/rnn/hrnn_rnn_api_compare_en.rst @@ -0,0 +1,4 @@ +API comparision between RNN and hierarchical RNN +================================================ + +TBD diff --git a/doc/howto/rnn/index_en.rst b/doc/howto/rnn/index_en.rst index 7adc79873..e1b20ef2e 100644 --- a/doc/howto/rnn/index_en.rst +++ b/doc/howto/rnn/index_en.rst @@ -5,3 +5,6 @@ RNN Models :maxdepth: 1 rnn_config_en.rst + recurrent_group_en.md + hierarchical_layer_en.rst + hrnn_rnn_api_compare_en.rst diff --git a/doc/howto/rnn/recurrent_group_en.md b/doc/howto/rnn/recurrent_group_en.md new file mode 100644 index 000000000..d264b0a9f --- /dev/null +++ b/doc/howto/rnn/recurrent_group_en.md @@ -0,0 +1,3 @@ +# Recurrent Group Tutorial + +TBD diff --git a/doc/index_en.rst b/doc/index_en.rst index 166f56c28..909f035cc 100644 --- a/doc/index_en.rst +++ b/doc/index_en.rst @@ -8,3 +8,4 @@ PaddlePaddle Documentation build_and_install/index_en.rst howto/index_en.rst dev/index_en.rst + faq/index_en.rst -- GitLab