Merge pull request #8658 from luotao1/doc_en

adjust the structure of documentation (en)
7 years ago · 9344e4e300
parent be9a2b2e30 4611a91f9a
commit 9344e4e300
25 changed files with 84 additions and 9 deletions
--- 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
--- 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
--- a/doc/faq/build_and_install/index_en.rst
+++ b/doc/faq/build_and_install/index_en.rst
@ -0,0 +1,5 @@
+############################
+Install, Build and Unit test
+############################
+
+TBD
--- a/doc/faq/cluster/index_en.rst
+++ b/doc/faq/cluster/index_en.rst
@ -0,0 +1,5 @@
+###############################
+Cluster Training and Prediction
+###############################
+
+TBD
--- a/doc/faq/index_en.rst
+++ 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
--- a/doc/faq/local/index_en.rst
+++ b/doc/faq/local/index_en.rst
@ -0,0 +1,5 @@
+#############################
+Local Training and Prediction
+#############################
+
+TBD
--- a/doc/faq/model/index_en.rst
+++ b/doc/faq/model/index_en.rst
@ -0,0 +1,5 @@
+###################
+Model Configuration
+###################
+
+TBD
--- a/doc/faq/parameter/index_en.rst
+++ b/doc/faq/parameter/index_en.rst
@ -0,0 +1,5 @@
+#################
+Parameter Setting
+#################
+
+TBD
--- a/doc/getstarted/concepts/use_concepts_en.rst
+++ b/doc/getstarted/concepts/use_concepts_en.rst
@ -0,0 +1,3 @@
+Basic Concept
+=============
+TBD
--- 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
--- a/doc/howto/capi/compile_paddle_lib_en.md
+++ b/doc/howto/capi/compile_paddle_lib_en.md
@ -0,0 +1,3 @@
+## Install and Build
+
+TBD
--- a/doc/howto/capi/index_en.rst
+++ 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
--- a/doc/howto/capi/organization_of_the_inputs_en.md
+++ b/doc/howto/capi/organization_of_the_inputs_en.md
@ -0,0 +1,3 @@
+## Input/Output Data Organization
+
+TBD
--- a/doc/howto/capi/workflow_of_capi_en.md
+++ b/doc/howto/capi/workflow_of_capi_en.md
@ -0,0 +1,3 @@
+## C-API Workflow
+
+TBD
--- 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

--- 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.

--- a/doc/howto/cluster/multi_cluster/k8s_distributed_en.md
+++ b/doc/howto/cluster/multi_cluster/k8s_distributed_en.md
@ -0,0 +1,3 @@
+# Kubernetes Distributed
+
+TBD
--- 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.

--- 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集群

--- 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

--- a/doc/howto/rnn/hierarchical_layer_en.rst
+++ b/doc/howto/rnn/hierarchical_layer_en.rst
@ -0,0 +1,4 @@
+Layers supporting hierarchical sequence as input
+================================================
+
+TBD
--- a/doc/howto/rnn/hrnn_rnn_api_compare_en.rst
+++ b/doc/howto/rnn/hrnn_rnn_api_compare_en.rst
@ -0,0 +1,4 @@
+API comparision between RNN and hierarchical RNN
+================================================
+
+TBD
--- 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
--- a/doc/howto/rnn/recurrent_group_en.md
+++ b/doc/howto/rnn/recurrent_group_en.md
@ -0,0 +1,3 @@
+# Recurrent Group Tutorial
+
+TBD
--- 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