diff --git a/doc/build_and_install/pip_install_en.rst b/doc/build_and_install/pip_install_en.rst index c1e806c0fe5f03139c0dff985f9ae0856eaa2e98..0d4c925b6e2731bdfd76582309aa7e8adbafa6ae 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 5dd12d2233cff20e021b90beb94571a2817bd1ad..5fdc30a2d688a6a269b4972c2591af60893e7dfb 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 0000000000000000000000000000000000000000..614db457d715665073cec1a495d4d7df6887532f --- /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 0000000000000000000000000000000000000000..855b7e8e53307b82a72c156be4ef509e27edf822 --- /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 0000000000000000000000000000000000000000..57df868f760038b25fae30df7ab20a68875ad36a --- /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 0000000000000000000000000000000000000000..4cb43031933a8bbe9aebae04bc3e9c74a6d21b95 --- /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 0000000000000000000000000000000000000000..cb26f59655f97dc28a2047994643ae16b8857964 --- /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 0000000000000000000000000000000000000000..61c7845af7e531013a06125f7c35b59081dafb42 --- /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 0000000000000000000000000000000000000000..406b0cbb913894dc333d8e4561c207793c33e475 --- /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 c680e1903750117073bee64cb4d4f4ccfff5ac3d..33f299be5680e0aa4a3f36638f51135503193d94 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 0000000000000000000000000000000000000000..11d69b9b79c1a41898d3060d3fe25a31330334a3 --- /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 0000000000000000000000000000000000000000..2cbbe362fd8e06abe9866d998f60fbb3458a80b5 --- /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 0000000000000000000000000000000000000000..250d3b2f749aed018e63527e817899c843dff996 --- /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 0000000000000000000000000000000000000000..1692ecd56520675f02ad25ef73761330ebd0e740 --- /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 bf270d89ab8514801ca4629cf412f73257429df9..bac9ffe1526a06a3a23b1d8acf33a5fb74b7e50d 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 0dfa8237a3fa2c9c3ee11e873c9fbbed3cd6018f..8e8e87be711bd45177ed77c81c531606e801d1f0 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 0000000000000000000000000000000000000000..bc3d50b3ffd3b703a3a656caa1f96bdcf683f68b --- /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 c374f00a495d705ceddf8d3d930768ceeb93282b..96ff652705726fc56fa0078593cd2a695fcdb5e2 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 831cafdc03c6a908f31769d0467de022df42dab5..954b2215cc3136ec5b3e1cdc2f6d3f508f814516 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 09af46e25ebe1f843dc7c7be0997dc706413b65c..a5c02b336b8a974f546499acae32edac24219be9 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 0000000000000000000000000000000000000000..236f58a160c7f77c28e4b1216b83b3d3cdaaa459 --- /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 0000000000000000000000000000000000000000..e5aa05c117393e81c557ba67609f787b38587efd --- /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 7adc79873d699fdfd5a85034bcef964dd1f19132..e1b20ef2e7bf4c521b613e54577ff6a3feaa8936 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 0000000000000000000000000000000000000000..d264b0a9f85faffd49c1982117cb5a3ac6ffc015 --- /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 166f56c28f464563a0b36007f58cebb58c286916..909f035cca3db2a02fd38462acc451375eceff40 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