From 89f0072a38caec86ffe03e4437bc84434d7c34b7 Mon Sep 17 00:00:00 2001 From: Luo Tao Date: Fri, 9 Dec 2016 12:02:57 +0800 Subject: [PATCH] add file extensions in doc/ --- doc/about/{index.rst => index_en.rst} | 0 .../data_provider/{index.rst => index_en.rst} | 8 ------- ...taprovider2.rst => pydataprovider2_en.rst} | 0 doc/api/{index.rst => index_en.rst} | 7 +++--- .../{basic_usage.rst => index_en.rst} | 0 ...from_source.md => build_from_source_en.md} | 0 ...cker_install.rst => docker_install_en.rst} | 0 .../{index.rst => index_en.rst} | 8 +++---- ...untu_install.rst => ubuntu_install_en.rst} | 0 doc/getstarted/index.rst | 8 ------- doc/getstarted/index_en.rst | 8 +++++++ .../{cluster_train.md => cluster_train_en.md} | 0 .../{arguments.md => arguments_en.md} | 0 ...roduction.md => detail_introduction_en.md} | 0 doc/howto/cmd_parameter/index.md | 5 ---- doc/howto/cmd_parameter/index_en.md | 5 ++++ .../{use_case.md => use_case_en.md} | 0 ...o_paddle.md => contribute_to_paddle_en.md} | 0 .../deep_model/{index.rst => index_en.rst} | 2 +- .../deep_model/rnn/{rnn.rst => rnn_en.rst} | 0 doc/howto/{index.rst => index_en.rst} | 12 +++++----- .../new_layer/{index.rst => index_en.rst} | 0 ...gpu_profiling.rst => gpu_profiling_en.rst} | 0 .../optimization/{index.rst => index_en.rst} | 2 +- doc/index.rst | 11 ++++----- .../embedding_model/{index.md => index_en.md} | 0 doc/tutorials/image_classification/index.rst | 10 -------- .../{image_classification.md => index_en.md} | 0 .../{resnet_model.md => resnet_model_en.md} | 0 doc/tutorials/index.md | 21 ----------------- doc/tutorials/index_en.md | 23 +++++++++++++++++++ .../rec/{ml_dataset.md => ml_dataset_en.md} | 0 ...ml_regression.rst => ml_regression_en.rst} | 0 .../semantic_role_labeling/index.rst | 7 ------ ...{semantic_role_labeling.md => index_en.md} | 0 doc/tutorials/sentiment_analysis/index.rst | 9 -------- .../{sentiment_analysis.md => index_en.md} | 0 doc/tutorials/text_generation/index.rst | 9 -------- .../{text_generation.md => index_en.md} | 0 39 files changed, 55 insertions(+), 100 deletions(-) rename doc/about/{index.rst => index_en.rst} (100%) rename doc/api/data_provider/{index.rst => index_en.rst} (89%) rename doc/api/data_provider/{pydataprovider2.rst => pydataprovider2_en.rst} (100%) rename doc/api/{index.rst => index_en.rst} (80%) rename doc/getstarted/basic_usage/{basic_usage.rst => index_en.rst} (100%) rename doc/getstarted/build_and_install/{build_from_source.md => build_from_source_en.md} (100%) rename doc/getstarted/build_and_install/{docker_install.rst => docker_install_en.rst} (100%) rename doc/getstarted/build_and_install/{index.rst => index_en.rst} (79%) rename doc/getstarted/build_and_install/{ubuntu_install.rst => ubuntu_install_en.rst} (100%) delete mode 100644 doc/getstarted/index.rst create mode 100644 doc/getstarted/index_en.rst rename doc/howto/cluster/{cluster_train.md => cluster_train_en.md} (100%) rename doc/howto/cmd_parameter/{arguments.md => arguments_en.md} (100%) rename doc/howto/cmd_parameter/{detail_introduction.md => detail_introduction_en.md} (100%) delete mode 100644 doc/howto/cmd_parameter/index.md create mode 100644 doc/howto/cmd_parameter/index_en.md rename doc/howto/cmd_parameter/{use_case.md => use_case_en.md} (100%) rename doc/howto/{contribute_to_paddle.md => contribute_to_paddle_en.md} (100%) rename doc/howto/deep_model/{index.rst => index_en.rst} (83%) rename doc/howto/deep_model/rnn/{rnn.rst => rnn_en.rst} (100%) rename doc/howto/{index.rst => index_en.rst} (51%) rename doc/howto/new_layer/{index.rst => index_en.rst} (100%) rename doc/howto/optimization/{gpu_profiling.rst => gpu_profiling_en.rst} (100%) rename doc/howto/optimization/{index.rst => index_en.rst} (78%) rename doc/tutorials/embedding_model/{index.md => index_en.md} (100%) delete mode 100644 doc/tutorials/image_classification/index.rst rename doc/tutorials/image_classification/{image_classification.md => index_en.md} (100%) rename doc/tutorials/imagenet_model/{resnet_model.md => resnet_model_en.md} (100%) delete mode 100644 doc/tutorials/index.md create mode 100644 doc/tutorials/index_en.md rename doc/tutorials/rec/{ml_dataset.md => ml_dataset_en.md} (100%) rename doc/tutorials/rec/{ml_regression.rst => ml_regression_en.rst} (100%) delete mode 100644 doc/tutorials/semantic_role_labeling/index.rst rename doc/tutorials/semantic_role_labeling/{semantic_role_labeling.md => index_en.md} (100%) delete mode 100644 doc/tutorials/sentiment_analysis/index.rst rename doc/tutorials/sentiment_analysis/{sentiment_analysis.md => index_en.md} (100%) delete mode 100644 doc/tutorials/text_generation/index.rst rename doc/tutorials/text_generation/{text_generation.md => index_en.md} (100%) diff --git a/doc/about/index.rst b/doc/about/index_en.rst similarity index 100% rename from doc/about/index.rst rename to doc/about/index_en.rst diff --git a/doc/api/data_provider/index.rst b/doc/api/data_provider/index_en.rst similarity index 89% rename from doc/api/data_provider/index.rst rename to doc/api/data_provider/index_en.rst index 5e7a49d632..96efbb1da9 100644 --- a/doc/api/data_provider/index.rst +++ b/doc/api/data_provider/index_en.rst @@ -32,11 +32,3 @@ Each line of train.list and test.list is an absolute or relative path (relative to the PaddePaddle program runtime) of data file. Fascinatingly more, each line can also be a HDFS file path or a SQL connection string. As long as the user assures how to access each file in DataProvider. - -Please refer to the following articles for more information about the detail -usages of DataProvider and how to implement a new DataProvider, - -.. toctree:: - - pydataprovider2.rst - write_new_dataprovider.rst diff --git a/doc/api/data_provider/pydataprovider2.rst b/doc/api/data_provider/pydataprovider2_en.rst similarity index 100% rename from doc/api/data_provider/pydataprovider2.rst rename to doc/api/data_provider/pydataprovider2_en.rst diff --git a/doc/api/index.rst b/doc/api/index_en.rst similarity index 80% rename from doc/api/index.rst rename to doc/api/index_en.rst index ccee7a0f1f..9930f93e10 100644 --- a/doc/api/index.rst +++ b/doc/api/index_en.rst @@ -7,8 +7,8 @@ DataProvider API .. toctree:: :maxdepth: 1 - data_provider/index.rst - data_provider/pydataprovider2.rst + data_provider/index_en.rst + data_provider/pydataprovider2_en.rst Model Config API ---------------- @@ -16,7 +16,6 @@ Model Config API .. toctree:: :maxdepth: 1 - trainer_config_helpers/index.rst trainer_config_helpers/optimizers.rst trainer_config_helpers/data_sources.rst trainer_config_helpers/layers.rst @@ -33,4 +32,4 @@ Applications API .. toctree:: :maxdepth: 1 - predict/swig_py_paddle_en.rst \ No newline at end of file + predict/swig_py_paddle_en.rst diff --git a/doc/getstarted/basic_usage/basic_usage.rst b/doc/getstarted/basic_usage/index_en.rst similarity index 100% rename from doc/getstarted/basic_usage/basic_usage.rst rename to doc/getstarted/basic_usage/index_en.rst diff --git a/doc/getstarted/build_and_install/build_from_source.md b/doc/getstarted/build_and_install/build_from_source_en.md similarity index 100% rename from doc/getstarted/build_and_install/build_from_source.md rename to doc/getstarted/build_and_install/build_from_source_en.md diff --git a/doc/getstarted/build_and_install/docker_install.rst b/doc/getstarted/build_and_install/docker_install_en.rst similarity index 100% rename from doc/getstarted/build_and_install/docker_install.rst rename to doc/getstarted/build_and_install/docker_install_en.rst diff --git a/doc/getstarted/build_and_install/index.rst b/doc/getstarted/build_and_install/index_en.rst similarity index 79% rename from doc/getstarted/build_and_install/index.rst rename to doc/getstarted/build_and_install/index_en.rst index 6187be9d72..1bfd4f75c0 100644 --- a/doc/getstarted/build_and_install/index.rst +++ b/doc/getstarted/build_and_install/index_en.rst @@ -6,10 +6,9 @@ Install PaddlePaddle .. toctree:: :maxdepth: 1 - :glob: - docker_install.rst - ubuntu_install.rst + docker_install_en.rst + ubuntu_install_en.rst Build from Source ----------------- @@ -20,6 +19,5 @@ Build from Source .. toctree:: :maxdepth: 1 - :glob: - build_from_source.md \ No newline at end of file + build_from_source_en.md diff --git a/doc/getstarted/build_and_install/ubuntu_install.rst b/doc/getstarted/build_and_install/ubuntu_install_en.rst similarity index 100% rename from doc/getstarted/build_and_install/ubuntu_install.rst rename to doc/getstarted/build_and_install/ubuntu_install_en.rst diff --git a/doc/getstarted/index.rst b/doc/getstarted/index.rst deleted file mode 100644 index 5f2787066e..0000000000 --- a/doc/getstarted/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -GET STARTED -============ - -.. toctree:: - :maxdepth: 2 - - build_and_install/index.rst - basic_usage/basic_usage.rst diff --git a/doc/getstarted/index_en.rst b/doc/getstarted/index_en.rst new file mode 100644 index 0000000000..55d95d8015 --- /dev/null +++ b/doc/getstarted/index_en.rst @@ -0,0 +1,8 @@ +GET STARTED +============ + +.. toctree:: + :maxdepth: 2 + + build_and_install/index_en.rst + basic_usage/index_en.rst diff --git a/doc/howto/cluster/cluster_train.md b/doc/howto/cluster/cluster_train_en.md similarity index 100% rename from doc/howto/cluster/cluster_train.md rename to doc/howto/cluster/cluster_train_en.md diff --git a/doc/howto/cmd_parameter/arguments.md b/doc/howto/cmd_parameter/arguments_en.md similarity index 100% rename from doc/howto/cmd_parameter/arguments.md rename to doc/howto/cmd_parameter/arguments_en.md diff --git a/doc/howto/cmd_parameter/detail_introduction.md b/doc/howto/cmd_parameter/detail_introduction_en.md similarity index 100% rename from doc/howto/cmd_parameter/detail_introduction.md rename to doc/howto/cmd_parameter/detail_introduction_en.md diff --git a/doc/howto/cmd_parameter/index.md b/doc/howto/cmd_parameter/index.md deleted file mode 100644 index 48cf835de1..0000000000 --- a/doc/howto/cmd_parameter/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# How to Set Command-line Parameters - -* [Use Case](use_case.md) -* [Arguments](arguments.md) -* [Detailed Descriptions](detail_introduction.md) diff --git a/doc/howto/cmd_parameter/index_en.md b/doc/howto/cmd_parameter/index_en.md new file mode 100644 index 0000000000..bd16affdd8 --- /dev/null +++ b/doc/howto/cmd_parameter/index_en.md @@ -0,0 +1,5 @@ +# How to Set Command-line Parameters + +* [Use Case](use_case_en.md) +* [Arguments](arguments_en.md) +* [Detailed Descriptions](detail_introduction_en.md) diff --git a/doc/howto/cmd_parameter/use_case.md b/doc/howto/cmd_parameter/use_case_en.md similarity index 100% rename from doc/howto/cmd_parameter/use_case.md rename to doc/howto/cmd_parameter/use_case_en.md diff --git a/doc/howto/contribute_to_paddle.md b/doc/howto/contribute_to_paddle_en.md similarity index 100% rename from doc/howto/contribute_to_paddle.md rename to doc/howto/contribute_to_paddle_en.md diff --git a/doc/howto/deep_model/index.rst b/doc/howto/deep_model/index_en.rst similarity index 83% rename from doc/howto/deep_model/index.rst rename to doc/howto/deep_model/index_en.rst index 06ef443f62..00a45641e6 100644 --- a/doc/howto/deep_model/index.rst +++ b/doc/howto/deep_model/index_en.rst @@ -4,4 +4,4 @@ How to Configure Deep Models .. toctree:: :maxdepth: 1 - rnn/rnn.rst + rnn/rnn_en.rst diff --git a/doc/howto/deep_model/rnn/rnn.rst b/doc/howto/deep_model/rnn/rnn_en.rst similarity index 100% rename from doc/howto/deep_model/rnn/rnn.rst rename to doc/howto/deep_model/rnn/rnn_en.rst diff --git a/doc/howto/index.rst b/doc/howto/index_en.rst similarity index 51% rename from doc/howto/index.rst rename to doc/howto/index_en.rst index 41877a64a5..bd64c5b1fb 100644 --- a/doc/howto/index.rst +++ b/doc/howto/index_en.rst @@ -7,9 +7,9 @@ Usage .. toctree:: :maxdepth: 1 - cmd_parameter/index.md - deep_model/index.rst - cluster/cluster_train.md + cmd_parameter/index_en.md + deep_model/index_en.rst + cluster/cluster_train_en.md Development ------------ @@ -17,8 +17,8 @@ Development .. toctree:: :maxdepth: 1 - new_layer/index.rst - contribute_to_paddle.md + new_layer/index_en.rst + contribute_to_paddle_en.md Optimization ------------- @@ -26,4 +26,4 @@ Optimization .. toctree:: :maxdepth: 1 - optimization/index.rst + optimization/index_en.rst diff --git a/doc/howto/new_layer/index.rst b/doc/howto/new_layer/index_en.rst similarity index 100% rename from doc/howto/new_layer/index.rst rename to doc/howto/new_layer/index_en.rst diff --git a/doc/howto/optimization/gpu_profiling.rst b/doc/howto/optimization/gpu_profiling_en.rst similarity index 100% rename from doc/howto/optimization/gpu_profiling.rst rename to doc/howto/optimization/gpu_profiling_en.rst diff --git a/doc/howto/optimization/index.rst b/doc/howto/optimization/index_en.rst similarity index 78% rename from doc/howto/optimization/index.rst rename to doc/howto/optimization/index_en.rst index e2822a0098..1e2f16b5da 100644 --- a/doc/howto/optimization/index.rst +++ b/doc/howto/optimization/index_en.rst @@ -4,4 +4,4 @@ How to Tune GPU Performance .. toctree:: :maxdepth: 3 - gpu_profiling.rst + gpu_profiling_en.rst diff --git a/doc/index.rst b/doc/index.rst index 3555da1dfc..c107239438 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,9 +4,8 @@ PaddlePaddle Documentation .. toctree:: :maxdepth: 1 - getstarted/index.rst - tutorials/index.md - howto/index.rst - api/index.rst - about/index.rst - \ No newline at end of file + getstarted/index_en.rst + tutorials/index_en.md + howto/index_en.rst + api/index_en.rst + about/index_en.rst diff --git a/doc/tutorials/embedding_model/index.md b/doc/tutorials/embedding_model/index_en.md similarity index 100% rename from doc/tutorials/embedding_model/index.md rename to doc/tutorials/embedding_model/index_en.md diff --git a/doc/tutorials/image_classification/index.rst b/doc/tutorials/image_classification/index.rst deleted file mode 100644 index 1ea68f1416..0000000000 --- a/doc/tutorials/image_classification/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -Image Classification Tutorial -============================= - -.. toctree:: - :maxdepth: 3 - :glob: - - Training Locally - cluster_train/internal/cluster_train.md - cluster_train/opensource/cluster_train.md diff --git a/doc/tutorials/image_classification/image_classification.md b/doc/tutorials/image_classification/index_en.md similarity index 100% rename from doc/tutorials/image_classification/image_classification.md rename to doc/tutorials/image_classification/index_en.md diff --git a/doc/tutorials/imagenet_model/resnet_model.md b/doc/tutorials/imagenet_model/resnet_model_en.md similarity index 100% rename from doc/tutorials/imagenet_model/resnet_model.md rename to doc/tutorials/imagenet_model/resnet_model_en.md diff --git a/doc/tutorials/index.md b/doc/tutorials/index.md deleted file mode 100644 index ebf5397391..0000000000 --- a/doc/tutorials/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# TUTORIALS -There are serveral examples and demos here. - -## Image - -* [Image Classification](image_classification/index.rst) - -## NLP - -* [Sentiment Analysis](sentiment_analysis/index.rst) -* [Text Generation](text_generation/index.rst) -* [Semantic Role Labeling](semantic_role_labeling/index.rst) - -## Recommendation - -* [MovieLens Dataset](rec/ml_dataset.md) -* [MovieLens Regression](rec/ml_regression.rst) - -## Model Zoo -* [ImageNet: ResNet](imagenet_model/resnet_model.md) -* [Embedding: Chinese Word](embedding_model/index.md) diff --git a/doc/tutorials/index_en.md b/doc/tutorials/index_en.md new file mode 100644 index 0000000000..97de356665 --- /dev/null +++ b/doc/tutorials/index_en.md @@ -0,0 +1,23 @@ +# TUTORIALS +There are serveral examples and demos here. + +## [Quick Start](quick_start/index_en.md) + +## Image + +* [Image Classification](image_classification/index_en.md) + +## NLP + +* [Sentiment Analysis](sentiment_analysis/index_en.md) +* [Text Generation](text_generation/index_en.md) +* [Semantic Role Labeling](semantic_role_labeling/index_en.md) + +## Recommendation + +* [MovieLens Dataset](rec/ml_dataset_en.md) +* [MovieLens Regression](rec/ml_regression_en.rst) + +## Model Zoo +* [ImageNet: ResNet](imagenet_model/resnet_model_en.md) +* [Embedding: Chinese Word](embedding_model/index_en.md) diff --git a/doc/tutorials/rec/ml_dataset.md b/doc/tutorials/rec/ml_dataset_en.md similarity index 100% rename from doc/tutorials/rec/ml_dataset.md rename to doc/tutorials/rec/ml_dataset_en.md diff --git a/doc/tutorials/rec/ml_regression.rst b/doc/tutorials/rec/ml_regression_en.rst similarity index 100% rename from doc/tutorials/rec/ml_regression.rst rename to doc/tutorials/rec/ml_regression_en.rst diff --git a/doc/tutorials/semantic_role_labeling/index.rst b/doc/tutorials/semantic_role_labeling/index.rst deleted file mode 100644 index ff3035059b..0000000000 --- a/doc/tutorials/semantic_role_labeling/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Semantic Role Labeling Tutorial -=============================== - -.. toctree:: - :maxdepth: 3 - - semantic_role_labeling.md diff --git a/doc/tutorials/semantic_role_labeling/semantic_role_labeling.md b/doc/tutorials/semantic_role_labeling/index_en.md similarity index 100% rename from doc/tutorials/semantic_role_labeling/semantic_role_labeling.md rename to doc/tutorials/semantic_role_labeling/index_en.md diff --git a/doc/tutorials/sentiment_analysis/index.rst b/doc/tutorials/sentiment_analysis/index.rst deleted file mode 100644 index 9ee6d3a177..0000000000 --- a/doc/tutorials/sentiment_analysis/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Sentiment Analasis Tutorial -=========================== - -.. toctree:: - :maxdepth: 3 - :glob: - - Training Locally - internal/cluster_train.md diff --git a/doc/tutorials/sentiment_analysis/sentiment_analysis.md b/doc/tutorials/sentiment_analysis/index_en.md similarity index 100% rename from doc/tutorials/sentiment_analysis/sentiment_analysis.md rename to doc/tutorials/sentiment_analysis/index_en.md diff --git a/doc/tutorials/text_generation/index.rst b/doc/tutorials/text_generation/index.rst deleted file mode 100644 index 82da552419..0000000000 --- a/doc/tutorials/text_generation/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Text Generation Tutorial -======================== - -.. toctree:: - :maxdepth: 3 - :glob: - - Training Locally - internal/cluster_train.md diff --git a/doc/tutorials/text_generation/text_generation.md b/doc/tutorials/text_generation/index_en.md similarity index 100% rename from doc/tutorials/text_generation/text_generation.md rename to doc/tutorials/text_generation/index_en.md -- GitLab