From 2f41aaa492aa952fc5429ffb408f4de044f6229f Mon Sep 17 00:00:00 2001 From: Luo Tao Date: Wed, 7 Feb 2018 13:35:11 +0800 Subject: [PATCH] adjust the structure of documentation --- .../dev => build_and_install}/build_cn.md | 0 .../dev => build_and_install}/build_en.md | 0 .../build_from_source_cn.rst | 0 .../build_from_source_en.rst | 0 .../build_and_install/docker_install_cn.rst | 0 .../build_and_install/docker_install_en.rst | 0 .../build_and_install/index_cn.rst | 2 +- .../build_and_install/index_en.rst | 2 +- .../build_and_install/paddleci.png | Bin .../build_and_install/pip_install_cn.rst | 0 .../build_and_install/pip_install_en.rst | 0 doc/{howto => }/dev/FullyConnected.jpg | Bin .../dev/contribute_to_paddle_cn.md | 0 doc/dev/contribute_to_paddle_en.md | 1 + doc/dev/index_cn.rst | 8 +++++ doc/dev/index_en.rst | 9 +++++ doc/{howto => }/dev/new_layer_cn.rst | 0 doc/{howto => }/dev/new_layer_en.rst | 0 doc/{howto => }/dev/new_op_cn.md | 0 doc/{howto => }/dev/new_op_en.md | 0 doc/{howto => }/dev/new_op_kernel_en.md | 0 doc/{howto => }/dev/use_eigen_cn.md | 0 doc/{howto => }/dev/use_eigen_en.md | 0 doc/{howto => }/dev/write_docs_cn.rst | 6 ++-- doc/{howto => }/dev/write_docs_en.rst | 4 +-- .../{usage => }/capi/compile_paddle_lib_cn.md | 2 +- doc/howto/{usage => }/capi/images/csr.png | Bin .../{usage => }/capi/images/sequence_data.png | Bin .../capi/images/workflow_of_CAPI.png | Bin doc/howto/{usage => }/capi/index_cn.rst | 2 +- .../capi/organization_of_the_inputs_cn.md | 0 .../{usage => }/capi/workflow_of_capi_cn.md | 2 +- .../{usage => }/cluster/cluster_train_cn.md | 0 .../{usage => }/cluster/cluster_train_en.md | 0 doc/howto/{usage => }/cluster/fabric_cn.md | 0 doc/howto/{usage => }/cluster/fabric_en.md | 0 .../cluster/fluid_cluster_train_en.md | 0 doc/howto/{usage => }/cluster/k8s_aws_cn.md | 0 doc/howto/{usage => }/cluster/k8s_aws_en.md | 0 doc/howto/{usage => }/cluster/k8s_cn.md | 0 .../{usage => }/cluster/k8s_distributed_cn.md | 0 doc/howto/{usage => }/cluster/k8s_en.md | 0 doc/howto/{usage => }/cluster/openmpi_cn.md | 0 doc/howto/{usage => }/cluster/openmpi_en.md | 0 doc/howto/{usage => }/cluster/src/Dockerfile | 0 .../cluster/src/add_security_group.png | Bin .../{usage => }/cluster/src/create_efs.png | Bin .../{usage => }/cluster/src/efs_mount.png | Bin .../cluster/src/k8s-paddle-arch.png | Bin .../cluster/src/k8s_data/Dockerfile | 0 .../cluster/src/k8s_data/README.md | 0 .../cluster/src/k8s_data/get_data.sh | 0 .../cluster/src/k8s_train/Dockerfile | 0 .../cluster/src/k8s_train/README.md | 0 .../cluster/src/k8s_train/start.sh | 0 .../cluster/src/k8s_train/start_paddle.py | 0 .../cluster/src/managed_policy.png | Bin .../cluster/src/pserver_and_trainer.png | Bin .../cluster/src/route53_create_recordset.png | Bin .../cluster/src/route53_create_zone.png | Bin doc/howto/{usage => }/cluster/src/trainer.png | Bin .../{usage => }/cluster/src/trainer_cn.png | Bin .../cluster/src/word2vec/api_train_v2.py | 0 .../src/word2vec/api_train_v2_cluster.py | 0 .../cluster/src/word2vec/prepare.py | 0 .../cluster/src/worker_security_group.png | Bin .../{usage => }/cmd_parameter/arguments_cn.md | 0 .../{usage => }/cmd_parameter/arguments_en.md | 0 .../cmd_parameter/detail_introduction_cn.md | 0 .../cmd_parameter/detail_introduction_en.md | 0 .../{usage => }/cmd_parameter/index_cn.rst | 2 +- .../{usage => }/cmd_parameter/index_en.rst | 0 .../{usage => }/cmd_parameter/use_case_cn.md | 0 .../{usage => }/cmd_parameter/use_case_en.md | 0 doc/howto/dev/contribute_to_paddle_en.md | 1 - doc/howto/index_cn.rst | 34 +++--------------- doc/howto/index_en.rst | 33 ++--------------- .../{cpu_profiling.md => cpu_profiling_en.md} | 0 doc/howto/optimization/gpu_profiling_cn.rst | 6 ++-- .../rnn/hierarchical_layer_cn.rst | 0 .../rnn/hrnn_rnn_api_compare_cn.rst | 0 doc/howto/{deep_model => }/rnn/index_cn.rst | 0 doc/howto/{deep_model => }/rnn/index_en.rst | 0 .../rnn/recurrent_group_cn.md | 0 .../{deep_model => }/rnn/rnn_config_cn.rst | 0 .../{deep_model => }/rnn/rnn_config_en.rst | 0 .../{deep_model => }/rnn/src/bi_lstm.jpg | Bin .../src/encoder-decoder-attention-model.png | Bin .../{deep_model => }/rnn/src/glossary_rnn.dot | 0 .../rnn/src/glossary_rnn_with_memory.dot | 0 .../simple_full_hierarchical_recurrent.dot | 0 .../rnn/src/simple_full_recurrent.dot | 0 doc/index_cn.rst | 2 ++ doc/index_en.rst | 2 ++ 94 files changed, 43 insertions(+), 75 deletions(-) rename doc/{howto/dev => build_and_install}/build_cn.md (100%) rename doc/{howto/dev => build_and_install}/build_en.md (100%) rename doc/{getstarted => }/build_and_install/build_from_source_cn.rst (100%) rename doc/{getstarted => }/build_and_install/build_from_source_en.rst (100%) rename doc/{getstarted => }/build_and_install/docker_install_cn.rst (100%) rename doc/{getstarted => }/build_and_install/docker_install_en.rst (100%) rename doc/{getstarted => }/build_and_install/index_cn.rst (94%) rename doc/{getstarted => }/build_and_install/index_en.rst (95%) rename doc/{getstarted => }/build_and_install/paddleci.png (100%) rename doc/{getstarted => }/build_and_install/pip_install_cn.rst (100%) rename doc/{getstarted => }/build_and_install/pip_install_en.rst (100%) rename doc/{howto => }/dev/FullyConnected.jpg (100%) rename doc/{howto => }/dev/contribute_to_paddle_cn.md (100%) create mode 120000 doc/dev/contribute_to_paddle_en.md create mode 100644 doc/dev/index_cn.rst create mode 100644 doc/dev/index_en.rst rename doc/{howto => }/dev/new_layer_cn.rst (100%) rename doc/{howto => }/dev/new_layer_en.rst (100%) rename doc/{howto => }/dev/new_op_cn.md (100%) rename doc/{howto => }/dev/new_op_en.md (100%) rename doc/{howto => }/dev/new_op_kernel_en.md (100%) rename doc/{howto => }/dev/use_eigen_cn.md (100%) rename doc/{howto => }/dev/use_eigen_en.md (100%) rename doc/{howto => }/dev/write_docs_cn.rst (98%) rename doc/{howto => }/dev/write_docs_en.rst (98%) rename doc/howto/{usage => }/capi/compile_paddle_lib_cn.md (99%) rename doc/howto/{usage => }/capi/images/csr.png (100%) rename doc/howto/{usage => }/capi/images/sequence_data.png (100%) rename doc/howto/{usage => }/capi/images/workflow_of_CAPI.png (100%) rename doc/howto/{usage => }/capi/index_cn.rst (87%) rename doc/howto/{usage => }/capi/organization_of_the_inputs_cn.md (100%) rename doc/howto/{usage => }/capi/workflow_of_capi_cn.md (99%) rename doc/howto/{usage => }/cluster/cluster_train_cn.md (100%) rename doc/howto/{usage => }/cluster/cluster_train_en.md (100%) rename doc/howto/{usage => }/cluster/fabric_cn.md (100%) rename doc/howto/{usage => }/cluster/fabric_en.md (100%) rename doc/howto/{usage => }/cluster/fluid_cluster_train_en.md (100%) rename doc/howto/{usage => }/cluster/k8s_aws_cn.md (100%) rename doc/howto/{usage => }/cluster/k8s_aws_en.md (100%) rename doc/howto/{usage => }/cluster/k8s_cn.md (100%) rename doc/howto/{usage => }/cluster/k8s_distributed_cn.md (100%) rename doc/howto/{usage => }/cluster/k8s_en.md (100%) rename doc/howto/{usage => }/cluster/openmpi_cn.md (100%) rename doc/howto/{usage => }/cluster/openmpi_en.md (100%) rename doc/howto/{usage => }/cluster/src/Dockerfile (100%) rename doc/howto/{usage => }/cluster/src/add_security_group.png (100%) rename doc/howto/{usage => }/cluster/src/create_efs.png (100%) rename doc/howto/{usage => }/cluster/src/efs_mount.png (100%) rename doc/howto/{usage => }/cluster/src/k8s-paddle-arch.png (100%) rename doc/howto/{usage => }/cluster/src/k8s_data/Dockerfile (100%) rename doc/howto/{usage => }/cluster/src/k8s_data/README.md (100%) rename doc/howto/{usage => }/cluster/src/k8s_data/get_data.sh (100%) rename doc/howto/{usage => }/cluster/src/k8s_train/Dockerfile (100%) rename doc/howto/{usage => }/cluster/src/k8s_train/README.md (100%) rename doc/howto/{usage => }/cluster/src/k8s_train/start.sh (100%) rename doc/howto/{usage => }/cluster/src/k8s_train/start_paddle.py (100%) rename doc/howto/{usage => }/cluster/src/managed_policy.png (100%) rename doc/howto/{usage => }/cluster/src/pserver_and_trainer.png (100%) rename doc/howto/{usage => }/cluster/src/route53_create_recordset.png (100%) rename doc/howto/{usage => }/cluster/src/route53_create_zone.png (100%) rename doc/howto/{usage => }/cluster/src/trainer.png (100%) rename doc/howto/{usage => }/cluster/src/trainer_cn.png (100%) rename doc/howto/{usage => }/cluster/src/word2vec/api_train_v2.py (100%) rename doc/howto/{usage => }/cluster/src/word2vec/api_train_v2_cluster.py (100%) rename doc/howto/{usage => }/cluster/src/word2vec/prepare.py (100%) rename doc/howto/{usage => }/cluster/src/worker_security_group.png (100%) rename doc/howto/{usage => }/cmd_parameter/arguments_cn.md (100%) rename doc/howto/{usage => }/cmd_parameter/arguments_en.md (100%) rename doc/howto/{usage => }/cmd_parameter/detail_introduction_cn.md (100%) rename doc/howto/{usage => }/cmd_parameter/detail_introduction_en.md (100%) rename doc/howto/{usage => }/cmd_parameter/index_cn.rst (85%) rename doc/howto/{usage => }/cmd_parameter/index_en.rst (100%) rename doc/howto/{usage => }/cmd_parameter/use_case_cn.md (100%) rename doc/howto/{usage => }/cmd_parameter/use_case_en.md (100%) delete mode 120000 doc/howto/dev/contribute_to_paddle_en.md rename doc/howto/optimization/{cpu_profiling.md => cpu_profiling_en.md} (100%) rename doc/howto/{deep_model => }/rnn/hierarchical_layer_cn.rst (100%) rename doc/howto/{deep_model => }/rnn/hrnn_rnn_api_compare_cn.rst (100%) rename doc/howto/{deep_model => }/rnn/index_cn.rst (100%) rename doc/howto/{deep_model => }/rnn/index_en.rst (100%) rename doc/howto/{deep_model => }/rnn/recurrent_group_cn.md (100%) rename doc/howto/{deep_model => }/rnn/rnn_config_cn.rst (100%) rename doc/howto/{deep_model => }/rnn/rnn_config_en.rst (100%) rename doc/howto/{deep_model => }/rnn/src/bi_lstm.jpg (100%) rename doc/howto/{deep_model => }/rnn/src/encoder-decoder-attention-model.png (100%) rename doc/howto/{deep_model => }/rnn/src/glossary_rnn.dot (100%) rename doc/howto/{deep_model => }/rnn/src/glossary_rnn_with_memory.dot (100%) rename doc/howto/{deep_model => }/rnn/src/simple_full_hierarchical_recurrent.dot (100%) rename doc/howto/{deep_model => }/rnn/src/simple_full_recurrent.dot (100%) diff --git a/doc/howto/dev/build_cn.md b/doc/build_and_install/build_cn.md similarity index 100% rename from doc/howto/dev/build_cn.md rename to doc/build_and_install/build_cn.md diff --git a/doc/howto/dev/build_en.md b/doc/build_and_install/build_en.md similarity index 100% rename from doc/howto/dev/build_en.md rename to doc/build_and_install/build_en.md diff --git a/doc/getstarted/build_and_install/build_from_source_cn.rst b/doc/build_and_install/build_from_source_cn.rst similarity index 100% rename from doc/getstarted/build_and_install/build_from_source_cn.rst rename to doc/build_and_install/build_from_source_cn.rst diff --git a/doc/getstarted/build_and_install/build_from_source_en.rst b/doc/build_and_install/build_from_source_en.rst similarity index 100% rename from doc/getstarted/build_and_install/build_from_source_en.rst rename to doc/build_and_install/build_from_source_en.rst diff --git a/doc/getstarted/build_and_install/docker_install_cn.rst b/doc/build_and_install/docker_install_cn.rst similarity index 100% rename from doc/getstarted/build_and_install/docker_install_cn.rst rename to doc/build_and_install/docker_install_cn.rst diff --git a/doc/getstarted/build_and_install/docker_install_en.rst b/doc/build_and_install/docker_install_en.rst similarity index 100% rename from doc/getstarted/build_and_install/docker_install_en.rst rename to doc/build_and_install/docker_install_en.rst diff --git a/doc/getstarted/build_and_install/index_cn.rst b/doc/build_and_install/index_cn.rst similarity index 94% rename from doc/getstarted/build_and_install/index_cn.rst rename to doc/build_and_install/index_cn.rst index c9ba84c842..4220ff2279 100644 --- a/doc/getstarted/build_and_install/index_cn.rst +++ b/doc/build_and_install/index_cn.rst @@ -13,7 +13,7 @@ PaddlePaddle提供pip和Docker的安装方式： pip_install_cn.rst docker_install_cn.rst - ../../howto/dev/build_cn.md + build_cn.md 编译流程 ++++++++ diff --git a/doc/getstarted/build_and_install/index_en.rst b/doc/build_and_install/index_en.rst similarity index 95% rename from doc/getstarted/build_and_install/index_en.rst rename to doc/build_and_install/index_en.rst index 32d66d63dd..db6b5be742 100644 --- a/doc/getstarted/build_and_install/index_en.rst +++ b/doc/build_and_install/index_en.rst @@ -13,7 +13,7 @@ You can choose either pip or Docker to complete your install: pip_install_en.rst docker_install_en.rst - ../../howto/dev/build_en.md + build_en.md Build from Source diff --git a/doc/getstarted/build_and_install/paddleci.png b/doc/build_and_install/paddleci.png similarity index 100% rename from doc/getstarted/build_and_install/paddleci.png rename to doc/build_and_install/paddleci.png diff --git a/doc/getstarted/build_and_install/pip_install_cn.rst b/doc/build_and_install/pip_install_cn.rst similarity index 100% rename from doc/getstarted/build_and_install/pip_install_cn.rst rename to doc/build_and_install/pip_install_cn.rst diff --git a/doc/getstarted/build_and_install/pip_install_en.rst b/doc/build_and_install/pip_install_en.rst similarity index 100% rename from doc/getstarted/build_and_install/pip_install_en.rst rename to doc/build_and_install/pip_install_en.rst diff --git a/doc/howto/dev/FullyConnected.jpg b/doc/dev/FullyConnected.jpg similarity index 100% rename from doc/howto/dev/FullyConnected.jpg rename to doc/dev/FullyConnected.jpg diff --git a/doc/howto/dev/contribute_to_paddle_cn.md b/doc/dev/contribute_to_paddle_cn.md similarity index 100% rename from doc/howto/dev/contribute_to_paddle_cn.md rename to doc/dev/contribute_to_paddle_cn.md diff --git a/doc/dev/contribute_to_paddle_en.md b/doc/dev/contribute_to_paddle_en.md new file mode 120000 index 0000000000..f939e75f21 --- /dev/null +++ b/doc/dev/contribute_to_paddle_en.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/doc/dev/index_cn.rst b/doc/dev/index_cn.rst new file mode 100644 index 0000000000..487db868bb --- /dev/null +++ b/doc/dev/index_cn.rst @@ -0,0 +1,8 @@ +开发标准 +======== + +.. toctree:: + :maxdepth: 1 + + contribute_to_paddle_cn.md + write_docs_cn.rst diff --git a/doc/dev/index_en.rst b/doc/dev/index_en.rst new file mode 100644 index 0000000000..5dd12d2233 --- /dev/null +++ b/doc/dev/index_en.rst @@ -0,0 +1,9 @@ +Development +------------ + +.. toctree:: + :maxdepth: 1 + + new_layer_en.rst + contribute_to_paddle_en.md + write_docs_en.rst diff --git a/doc/howto/dev/new_layer_cn.rst b/doc/dev/new_layer_cn.rst similarity index 100% rename from doc/howto/dev/new_layer_cn.rst rename to doc/dev/new_layer_cn.rst diff --git a/doc/howto/dev/new_layer_en.rst b/doc/dev/new_layer_en.rst similarity index 100% rename from doc/howto/dev/new_layer_en.rst rename to doc/dev/new_layer_en.rst diff --git a/doc/howto/dev/new_op_cn.md b/doc/dev/new_op_cn.md similarity index 100% rename from doc/howto/dev/new_op_cn.md rename to doc/dev/new_op_cn.md diff --git a/doc/howto/dev/new_op_en.md b/doc/dev/new_op_en.md similarity index 100% rename from doc/howto/dev/new_op_en.md rename to doc/dev/new_op_en.md diff --git a/doc/howto/dev/new_op_kernel_en.md b/doc/dev/new_op_kernel_en.md similarity index 100% rename from doc/howto/dev/new_op_kernel_en.md rename to doc/dev/new_op_kernel_en.md diff --git a/doc/howto/dev/use_eigen_cn.md b/doc/dev/use_eigen_cn.md similarity index 100% rename from doc/howto/dev/use_eigen_cn.md rename to doc/dev/use_eigen_cn.md diff --git a/doc/howto/dev/use_eigen_en.md b/doc/dev/use_eigen_en.md similarity index 100% rename from doc/howto/dev/use_eigen_en.md rename to doc/dev/use_eigen_en.md diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/dev/write_docs_cn.rst similarity index 98% rename from doc/howto/dev/write_docs_cn.rst rename to doc/dev/write_docs_cn.rst index 1bc947c260..f79769b810 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/dev/write_docs_cn.rst @@ -1,6 +1,6 @@ -################## -如何贡献/修改文档 -################## +############# +如何贡献文档 +############# PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。 也可以利用PaddlePaddle 工具来编译文档，这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下 diff --git a/doc/howto/dev/write_docs_en.rst b/doc/dev/write_docs_en.rst similarity index 98% rename from doc/howto/dev/write_docs_en.rst rename to doc/dev/write_docs_en.rst index b3ef07eb1d..f3408a8426 100644 --- a/doc/howto/dev/write_docs_en.rst +++ b/doc/dev/write_docs_en.rst @@ -1,6 +1,6 @@ -################## +######################## Contribute Documentation -################## +######################## PaddlePaddle supports English documentation ``doc`` and Chinese documentation ``doc_cn``. Both are compiled by `cmake`_ and `sphinx`_ , the compiled documentations will be stored under ``doc`` and ``doc_cn`` directories. diff --git a/doc/howto/usage/capi/compile_paddle_lib_cn.md b/doc/howto/capi/compile_paddle_lib_cn.md similarity index 99% rename from doc/howto/usage/capi/compile_paddle_lib_cn.md rename to doc/howto/capi/compile_paddle_lib_cn.md index ac5ecffe2e..fd8dec8164 100644 --- a/doc/howto/usage/capi/compile_paddle_lib_cn.md +++ b/doc/howto/capi/compile_paddle_lib_cn.md @@ -1,4 +1,4 @@ -## 编译 PaddlePaddle 预测库 +## 安装与编译C-API预测库 ### 概述 diff --git a/doc/howto/usage/capi/images/csr.png b/doc/howto/capi/images/csr.png similarity index 100% rename from doc/howto/usage/capi/images/csr.png rename to doc/howto/capi/images/csr.png diff --git a/doc/howto/usage/capi/images/sequence_data.png b/doc/howto/capi/images/sequence_data.png similarity index 100% rename from doc/howto/usage/capi/images/sequence_data.png rename to doc/howto/capi/images/sequence_data.png diff --git a/doc/howto/usage/capi/images/workflow_of_CAPI.png b/doc/howto/capi/images/workflow_of_CAPI.png similarity index 100% rename from doc/howto/usage/capi/images/workflow_of_CAPI.png rename to doc/howto/capi/images/workflow_of_CAPI.png diff --git a/doc/howto/usage/capi/index_cn.rst b/doc/howto/capi/index_cn.rst similarity index 87% rename from doc/howto/usage/capi/index_cn.rst rename to doc/howto/capi/index_cn.rst index fd774fbc74..e589a6d346 100644 --- a/doc/howto/usage/capi/index_cn.rst +++ b/doc/howto/capi/index_cn.rst @@ -1,4 +1,4 @@ -PaddlePaddle C-API +C-API预测库 ================== .. toctree:: diff --git a/doc/howto/usage/capi/organization_of_the_inputs_cn.md b/doc/howto/capi/organization_of_the_inputs_cn.md similarity index 100% rename from doc/howto/usage/capi/organization_of_the_inputs_cn.md rename to doc/howto/capi/organization_of_the_inputs_cn.md diff --git a/doc/howto/usage/capi/workflow_of_capi_cn.md b/doc/howto/capi/workflow_of_capi_cn.md similarity index 99% rename from doc/howto/usage/capi/workflow_of_capi_cn.md rename to doc/howto/capi/workflow_of_capi_cn.md index e0a42fff12..a61d2267bf 100644 --- a/doc/howto/usage/capi/workflow_of_capi_cn.md +++ b/doc/howto/capi/workflow_of_capi_cn.md @@ -1,4 +1,4 @@ -## C-API 使用流程 +## C-API使用流程 这篇文档介绍 PaddlePaddle C-API 整体使用流程。 diff --git a/doc/howto/usage/cluster/cluster_train_cn.md b/doc/howto/cluster/cluster_train_cn.md similarity index 100% rename from doc/howto/usage/cluster/cluster_train_cn.md rename to doc/howto/cluster/cluster_train_cn.md diff --git a/doc/howto/usage/cluster/cluster_train_en.md b/doc/howto/cluster/cluster_train_en.md similarity index 100% rename from doc/howto/usage/cluster/cluster_train_en.md rename to doc/howto/cluster/cluster_train_en.md diff --git a/doc/howto/usage/cluster/fabric_cn.md b/doc/howto/cluster/fabric_cn.md similarity index 100% rename from doc/howto/usage/cluster/fabric_cn.md rename to doc/howto/cluster/fabric_cn.md diff --git a/doc/howto/usage/cluster/fabric_en.md b/doc/howto/cluster/fabric_en.md similarity index 100% rename from doc/howto/usage/cluster/fabric_en.md rename to doc/howto/cluster/fabric_en.md diff --git a/doc/howto/usage/cluster/fluid_cluster_train_en.md b/doc/howto/cluster/fluid_cluster_train_en.md similarity index 100% rename from doc/howto/usage/cluster/fluid_cluster_train_en.md rename to doc/howto/cluster/fluid_cluster_train_en.md diff --git a/doc/howto/usage/cluster/k8s_aws_cn.md b/doc/howto/cluster/k8s_aws_cn.md similarity index 100% rename from doc/howto/usage/cluster/k8s_aws_cn.md rename to doc/howto/cluster/k8s_aws_cn.md diff --git a/doc/howto/usage/cluster/k8s_aws_en.md b/doc/howto/cluster/k8s_aws_en.md similarity index 100% rename from doc/howto/usage/cluster/k8s_aws_en.md rename to doc/howto/cluster/k8s_aws_en.md diff --git a/doc/howto/usage/cluster/k8s_cn.md b/doc/howto/cluster/k8s_cn.md similarity index 100% rename from doc/howto/usage/cluster/k8s_cn.md rename to doc/howto/cluster/k8s_cn.md diff --git a/doc/howto/usage/cluster/k8s_distributed_cn.md b/doc/howto/cluster/k8s_distributed_cn.md similarity index 100% rename from doc/howto/usage/cluster/k8s_distributed_cn.md rename to doc/howto/cluster/k8s_distributed_cn.md diff --git a/doc/howto/usage/cluster/k8s_en.md b/doc/howto/cluster/k8s_en.md similarity index 100% rename from doc/howto/usage/cluster/k8s_en.md rename to doc/howto/cluster/k8s_en.md diff --git a/doc/howto/usage/cluster/openmpi_cn.md b/doc/howto/cluster/openmpi_cn.md similarity index 100% rename from doc/howto/usage/cluster/openmpi_cn.md rename to doc/howto/cluster/openmpi_cn.md diff --git a/doc/howto/usage/cluster/openmpi_en.md b/doc/howto/cluster/openmpi_en.md similarity index 100% rename from doc/howto/usage/cluster/openmpi_en.md rename to doc/howto/cluster/openmpi_en.md diff --git a/doc/howto/usage/cluster/src/Dockerfile b/doc/howto/cluster/src/Dockerfile similarity index 100% rename from doc/howto/usage/cluster/src/Dockerfile rename to doc/howto/cluster/src/Dockerfile diff --git a/doc/howto/usage/cluster/src/add_security_group.png b/doc/howto/cluster/src/add_security_group.png similarity index 100% rename from doc/howto/usage/cluster/src/add_security_group.png rename to doc/howto/cluster/src/add_security_group.png diff --git a/doc/howto/usage/cluster/src/create_efs.png b/doc/howto/cluster/src/create_efs.png similarity index 100% rename from doc/howto/usage/cluster/src/create_efs.png rename to doc/howto/cluster/src/create_efs.png diff --git a/doc/howto/usage/cluster/src/efs_mount.png b/doc/howto/cluster/src/efs_mount.png similarity index 100% rename from doc/howto/usage/cluster/src/efs_mount.png rename to doc/howto/cluster/src/efs_mount.png diff --git a/doc/howto/usage/cluster/src/k8s-paddle-arch.png b/doc/howto/cluster/src/k8s-paddle-arch.png similarity index 100% rename from doc/howto/usage/cluster/src/k8s-paddle-arch.png rename to doc/howto/cluster/src/k8s-paddle-arch.png diff --git a/doc/howto/usage/cluster/src/k8s_data/Dockerfile b/doc/howto/cluster/src/k8s_data/Dockerfile similarity index 100% rename from doc/howto/usage/cluster/src/k8s_data/Dockerfile rename to doc/howto/cluster/src/k8s_data/Dockerfile diff --git a/doc/howto/usage/cluster/src/k8s_data/README.md b/doc/howto/cluster/src/k8s_data/README.md similarity index 100% rename from doc/howto/usage/cluster/src/k8s_data/README.md rename to doc/howto/cluster/src/k8s_data/README.md diff --git a/doc/howto/usage/cluster/src/k8s_data/get_data.sh b/doc/howto/cluster/src/k8s_data/get_data.sh similarity index 100% rename from doc/howto/usage/cluster/src/k8s_data/get_data.sh rename to doc/howto/cluster/src/k8s_data/get_data.sh diff --git a/doc/howto/usage/cluster/src/k8s_train/Dockerfile b/doc/howto/cluster/src/k8s_train/Dockerfile similarity index 100% rename from doc/howto/usage/cluster/src/k8s_train/Dockerfile rename to doc/howto/cluster/src/k8s_train/Dockerfile diff --git a/doc/howto/usage/cluster/src/k8s_train/README.md b/doc/howto/cluster/src/k8s_train/README.md similarity index 100% rename from doc/howto/usage/cluster/src/k8s_train/README.md rename to doc/howto/cluster/src/k8s_train/README.md diff --git a/doc/howto/usage/cluster/src/k8s_train/start.sh b/doc/howto/cluster/src/k8s_train/start.sh similarity index 100% rename from doc/howto/usage/cluster/src/k8s_train/start.sh rename to doc/howto/cluster/src/k8s_train/start.sh diff --git a/doc/howto/usage/cluster/src/k8s_train/start_paddle.py b/doc/howto/cluster/src/k8s_train/start_paddle.py similarity index 100% rename from doc/howto/usage/cluster/src/k8s_train/start_paddle.py rename to doc/howto/cluster/src/k8s_train/start_paddle.py diff --git a/doc/howto/usage/cluster/src/managed_policy.png b/doc/howto/cluster/src/managed_policy.png similarity index 100% rename from doc/howto/usage/cluster/src/managed_policy.png rename to doc/howto/cluster/src/managed_policy.png diff --git a/doc/howto/usage/cluster/src/pserver_and_trainer.png b/doc/howto/cluster/src/pserver_and_trainer.png similarity index 100% rename from doc/howto/usage/cluster/src/pserver_and_trainer.png rename to doc/howto/cluster/src/pserver_and_trainer.png diff --git a/doc/howto/usage/cluster/src/route53_create_recordset.png b/doc/howto/cluster/src/route53_create_recordset.png similarity index 100% rename from doc/howto/usage/cluster/src/route53_create_recordset.png rename to doc/howto/cluster/src/route53_create_recordset.png diff --git a/doc/howto/usage/cluster/src/route53_create_zone.png b/doc/howto/cluster/src/route53_create_zone.png similarity index 100% rename from doc/howto/usage/cluster/src/route53_create_zone.png rename to doc/howto/cluster/src/route53_create_zone.png diff --git a/doc/howto/usage/cluster/src/trainer.png b/doc/howto/cluster/src/trainer.png similarity index 100% rename from doc/howto/usage/cluster/src/trainer.png rename to doc/howto/cluster/src/trainer.png diff --git a/doc/howto/usage/cluster/src/trainer_cn.png b/doc/howto/cluster/src/trainer_cn.png similarity index 100% rename from doc/howto/usage/cluster/src/trainer_cn.png rename to doc/howto/cluster/src/trainer_cn.png diff --git a/doc/howto/usage/cluster/src/word2vec/api_train_v2.py b/doc/howto/cluster/src/word2vec/api_train_v2.py similarity index 100% rename from doc/howto/usage/cluster/src/word2vec/api_train_v2.py rename to doc/howto/cluster/src/word2vec/api_train_v2.py diff --git a/doc/howto/usage/cluster/src/word2vec/api_train_v2_cluster.py b/doc/howto/cluster/src/word2vec/api_train_v2_cluster.py similarity index 100% rename from doc/howto/usage/cluster/src/word2vec/api_train_v2_cluster.py rename to doc/howto/cluster/src/word2vec/api_train_v2_cluster.py diff --git a/doc/howto/usage/cluster/src/word2vec/prepare.py b/doc/howto/cluster/src/word2vec/prepare.py similarity index 100% rename from doc/howto/usage/cluster/src/word2vec/prepare.py rename to doc/howto/cluster/src/word2vec/prepare.py diff --git a/doc/howto/usage/cluster/src/worker_security_group.png b/doc/howto/cluster/src/worker_security_group.png similarity index 100% rename from doc/howto/usage/cluster/src/worker_security_group.png rename to doc/howto/cluster/src/worker_security_group.png diff --git a/doc/howto/usage/cmd_parameter/arguments_cn.md b/doc/howto/cmd_parameter/arguments_cn.md similarity index 100% rename from doc/howto/usage/cmd_parameter/arguments_cn.md rename to doc/howto/cmd_parameter/arguments_cn.md diff --git a/doc/howto/usage/cmd_parameter/arguments_en.md b/doc/howto/cmd_parameter/arguments_en.md similarity index 100% rename from doc/howto/usage/cmd_parameter/arguments_en.md rename to doc/howto/cmd_parameter/arguments_en.md diff --git a/doc/howto/usage/cmd_parameter/detail_introduction_cn.md b/doc/howto/cmd_parameter/detail_introduction_cn.md similarity index 100% rename from doc/howto/usage/cmd_parameter/detail_introduction_cn.md rename to doc/howto/cmd_parameter/detail_introduction_cn.md diff --git a/doc/howto/usage/cmd_parameter/detail_introduction_en.md b/doc/howto/cmd_parameter/detail_introduction_en.md similarity index 100% rename from doc/howto/usage/cmd_parameter/detail_introduction_en.md rename to doc/howto/cmd_parameter/detail_introduction_en.md diff --git a/doc/howto/usage/cmd_parameter/index_cn.rst b/doc/howto/cmd_parameter/index_cn.rst similarity index 85% rename from doc/howto/usage/cmd_parameter/index_cn.rst rename to doc/howto/cmd_parameter/index_cn.rst index 4c87298211..17b379f629 100644 --- a/doc/howto/usage/cmd_parameter/index_cn.rst +++ b/doc/howto/cmd_parameter/index_cn.rst @@ -1,6 +1,6 @@ .. _cmd_line_index: -设置命令行参数 +命令行参数设置 =============== .. toctree:: diff --git a/doc/howto/usage/cmd_parameter/index_en.rst b/doc/howto/cmd_parameter/index_en.rst similarity index 100% rename from doc/howto/usage/cmd_parameter/index_en.rst rename to doc/howto/cmd_parameter/index_en.rst diff --git a/doc/howto/usage/cmd_parameter/use_case_cn.md b/doc/howto/cmd_parameter/use_case_cn.md similarity index 100% rename from doc/howto/usage/cmd_parameter/use_case_cn.md rename to doc/howto/cmd_parameter/use_case_cn.md diff --git a/doc/howto/usage/cmd_parameter/use_case_en.md b/doc/howto/cmd_parameter/use_case_en.md similarity index 100% rename from doc/howto/usage/cmd_parameter/use_case_en.md rename to doc/howto/cmd_parameter/use_case_en.md diff --git a/doc/howto/dev/contribute_to_paddle_en.md b/doc/howto/dev/contribute_to_paddle_en.md deleted file mode 120000 index c97564d93a..0000000000 --- a/doc/howto/dev/contribute_to_paddle_en.md +++ /dev/null @@ -1 +0,0 @@ -../../../CONTRIBUTING.md \ No newline at end of file diff --git a/doc/howto/index_cn.rst b/doc/howto/index_cn.rst index e0c69f7a6a..37a34c113f 100644 --- a/doc/howto/index_cn.rst +++ b/doc/howto/index_cn.rst @@ -1,37 +1,11 @@ 进阶指南 ======== -使用说明 --------- - -.. toctree:: - :maxdepth: 1 - - usage/cmd_parameter/index_cn.rst - usage/cluster/cluster_train_cn.md - usage/capi/index_cn.rst - -开发标准 --------- - -.. toctree:: - :maxdepth: 1 - - dev/contribute_to_paddle_cn.md - dev/write_docs_cn.rst - -模型配置 --------- - -.. toctree:: - :maxdepth: 1 - - deep_model/rnn/index_cn.rst - -性能优化 --------- - .. toctree:: :maxdepth: 1 + cmd_parameter/index_cn.rst + cluster/cluster_train_cn.md + capi/index_cn.rst + rnn/index_cn.rst optimization/gpu_profiling_cn.rst diff --git a/doc/howto/index_en.rst b/doc/howto/index_en.rst index 6d1bf7dfc0..3ba76d6aad 100644 --- a/doc/howto/index_en.rst +++ b/doc/howto/index_en.rst @@ -1,37 +1,10 @@ HOW TO ======= -Usage -------- - -.. toctree:: - :maxdepth: 1 - - usage/cmd_parameter/index_en.rst - usage/cluster/cluster_train_en.md - -Development ------------- - -.. toctree:: - :maxdepth: 1 - - dev/new_layer_en.rst - dev/contribute_to_paddle_en.md - dev/write_docs_en.rst - -Configuration -------------- - -.. toctree:: - :maxdepth: 1 - - deep_model/rnn/index_en.rst - -Optimization -------------- - .. toctree:: :maxdepth: 1 + cmd_parameter/index_en.rst + cluster/cluster_train_en.md + rnn/index_en.rst optimization/gpu_profiling_en.rst diff --git a/doc/howto/optimization/cpu_profiling.md b/doc/howto/optimization/cpu_profiling_en.md similarity index 100% rename from doc/howto/optimization/cpu_profiling.md rename to doc/howto/optimization/cpu_profiling_en.md diff --git a/doc/howto/optimization/gpu_profiling_cn.rst b/doc/howto/optimization/gpu_profiling_cn.rst index e2b0b0396e..0239eef4f1 100644 --- a/doc/howto/optimization/gpu_profiling_cn.rst +++ b/doc/howto/optimization/gpu_profiling_cn.rst @@ -1,6 +1,6 @@ -================== -GPU性能分析与调优 -================== +============ +GPU性能调优 +============ .. contents:: diff --git a/doc/howto/deep_model/rnn/hierarchical_layer_cn.rst b/doc/howto/rnn/hierarchical_layer_cn.rst similarity index 100% rename from doc/howto/deep_model/rnn/hierarchical_layer_cn.rst rename to doc/howto/rnn/hierarchical_layer_cn.rst diff --git a/doc/howto/deep_model/rnn/hrnn_rnn_api_compare_cn.rst b/doc/howto/rnn/hrnn_rnn_api_compare_cn.rst similarity index 100% rename from doc/howto/deep_model/rnn/hrnn_rnn_api_compare_cn.rst rename to doc/howto/rnn/hrnn_rnn_api_compare_cn.rst diff --git a/doc/howto/deep_model/rnn/index_cn.rst b/doc/howto/rnn/index_cn.rst similarity index 100% rename from doc/howto/deep_model/rnn/index_cn.rst rename to doc/howto/rnn/index_cn.rst diff --git a/doc/howto/deep_model/rnn/index_en.rst b/doc/howto/rnn/index_en.rst similarity index 100% rename from doc/howto/deep_model/rnn/index_en.rst rename to doc/howto/rnn/index_en.rst diff --git a/doc/howto/deep_model/rnn/recurrent_group_cn.md b/doc/howto/rnn/recurrent_group_cn.md similarity index 100% rename from doc/howto/deep_model/rnn/recurrent_group_cn.md rename to doc/howto/rnn/recurrent_group_cn.md diff --git a/doc/howto/deep_model/rnn/rnn_config_cn.rst b/doc/howto/rnn/rnn_config_cn.rst similarity index 100% rename from doc/howto/deep_model/rnn/rnn_config_cn.rst rename to doc/howto/rnn/rnn_config_cn.rst diff --git a/doc/howto/deep_model/rnn/rnn_config_en.rst b/doc/howto/rnn/rnn_config_en.rst similarity index 100% rename from doc/howto/deep_model/rnn/rnn_config_en.rst rename to doc/howto/rnn/rnn_config_en.rst diff --git a/doc/howto/deep_model/rnn/src/bi_lstm.jpg b/doc/howto/rnn/src/bi_lstm.jpg similarity index 100% rename from doc/howto/deep_model/rnn/src/bi_lstm.jpg rename to doc/howto/rnn/src/bi_lstm.jpg diff --git a/doc/howto/deep_model/rnn/src/encoder-decoder-attention-model.png b/doc/howto/rnn/src/encoder-decoder-attention-model.png similarity index 100% rename from doc/howto/deep_model/rnn/src/encoder-decoder-attention-model.png rename to doc/howto/rnn/src/encoder-decoder-attention-model.png diff --git a/doc/howto/deep_model/rnn/src/glossary_rnn.dot b/doc/howto/rnn/src/glossary_rnn.dot similarity index 100% rename from doc/howto/deep_model/rnn/src/glossary_rnn.dot rename to doc/howto/rnn/src/glossary_rnn.dot diff --git a/doc/howto/deep_model/rnn/src/glossary_rnn_with_memory.dot b/doc/howto/rnn/src/glossary_rnn_with_memory.dot similarity index 100% rename from doc/howto/deep_model/rnn/src/glossary_rnn_with_memory.dot rename to doc/howto/rnn/src/glossary_rnn_with_memory.dot diff --git a/doc/howto/deep_model/rnn/src/simple_full_hierarchical_recurrent.dot b/doc/howto/rnn/src/simple_full_hierarchical_recurrent.dot similarity index 100% rename from doc/howto/deep_model/rnn/src/simple_full_hierarchical_recurrent.dot rename to doc/howto/rnn/src/simple_full_hierarchical_recurrent.dot diff --git a/doc/howto/deep_model/rnn/src/simple_full_recurrent.dot b/doc/howto/rnn/src/simple_full_recurrent.dot similarity index 100% rename from doc/howto/deep_model/rnn/src/simple_full_recurrent.dot rename to doc/howto/rnn/src/simple_full_recurrent.dot diff --git a/doc/index_cn.rst b/doc/index_cn.rst index 9279bac7f4..63a7842858 100644 --- a/doc/index_cn.rst +++ b/doc/index_cn.rst @@ -5,6 +5,8 @@ PaddlePaddle 文档 :maxdepth: 1 getstarted/index_cn.rst + build_and_install/index_cn.rst howto/index_cn.rst + dev/index_cn.rst api/index_cn.rst faq/index_cn.rst diff --git a/doc/index_en.rst b/doc/index_en.rst index 64684b8b9b..5631381be0 100644 --- a/doc/index_en.rst +++ b/doc/index_en.rst @@ -5,5 +5,7 @@ PaddlePaddle Documentation :maxdepth: 1 getstarted/index_en.rst + build_and_install/index_en.rst howto/index_en.rst + dev/index_en.rst api/index_en.rst -- GitLab