From d209a196fc2dade600e1b15788e3a1fe1c584bd6 Mon Sep 17 00:00:00 2001 From: dangqingqing Date: Wed, 31 Aug 2016 09:44:39 +0000 Subject: [PATCH] Adjust catalog for documentation. ISSUE=4603671 git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1456 1ad973e4-5ce8-4261-8a94-b56d1f490c56 --- doc/algorithm/rnn/bi_lstm.jpg | 1 + .../rnn/encoder-decoder-attention-model.png | 1 + doc/{ui/api => algorithm}/rnn/index.rst | 0 doc/demo/quick_start/index_en.md | 2 +- doc/{demo => dev}/new_layer/FullyConnected.jpg | Bin doc/dev/new_layer/index.rst | 7 +++++++ .../index.rst => dev/new_layer/new_layer.rst} | 0 doc/index.md | 14 +++++++++++--- doc/ui/api/rnn/bi_lstm.jpg | 1 - .../api/rnn/encoder-decoder-attention-model.png | 1 - doc/ui/api/trainer_config_helpers/index.md | 4 ++-- doc/ui/index.md | 3 +-- 12 files changed, 24 insertions(+), 10 deletions(-) create mode 120000 doc/algorithm/rnn/bi_lstm.jpg create mode 120000 doc/algorithm/rnn/encoder-decoder-attention-model.png rename doc/{ui/api => algorithm}/rnn/index.rst (100%) rename doc/{demo => dev}/new_layer/FullyConnected.jpg (100%) create mode 100644 doc/dev/new_layer/index.rst rename doc/{demo/new_layer/index.rst => dev/new_layer/new_layer.rst} (100%) delete mode 120000 doc/ui/api/rnn/bi_lstm.jpg delete mode 120000 doc/ui/api/rnn/encoder-decoder-attention-model.png diff --git a/doc/algorithm/rnn/bi_lstm.jpg b/doc/algorithm/rnn/bi_lstm.jpg new file mode 120000 index 0000000000..a53296cf80 --- /dev/null +++ b/doc/algorithm/rnn/bi_lstm.jpg @@ -0,0 +1 @@ +../../demo/sentiment_analysis/bi_lstm.jpg \ No newline at end of file diff --git a/doc/algorithm/rnn/encoder-decoder-attention-model.png b/doc/algorithm/rnn/encoder-decoder-attention-model.png new file mode 120000 index 0000000000..db71321a43 --- /dev/null +++ b/doc/algorithm/rnn/encoder-decoder-attention-model.png @@ -0,0 +1 @@ +../../demo/text_generation/encoder-decoder-attention-model.png \ No newline at end of file diff --git a/doc/ui/api/rnn/index.rst b/doc/algorithm/rnn/index.rst similarity index 100% rename from doc/ui/api/rnn/index.rst rename to doc/algorithm/rnn/index.rst diff --git a/doc/demo/quick_start/index_en.md b/doc/demo/quick_start/index_en.md index 2a8c8a5dde..b537d8c834 100644 --- a/doc/demo/quick_start/index_en.md +++ b/doc/demo/quick_start/index_en.md @@ -1,4 +1,4 @@ -# PaddlePaddle Quick Start Tutorial +# Quick Start Tutorial This tutorial will teach the basics of deep learning (DL), including how to implement many different models in PaddlePaddle. You will learn how to: - Prepare data into the standardized format that PaddlePaddle accepts. diff --git a/doc/demo/new_layer/FullyConnected.jpg b/doc/dev/new_layer/FullyConnected.jpg similarity index 100% rename from doc/demo/new_layer/FullyConnected.jpg rename to doc/dev/new_layer/FullyConnected.jpg diff --git a/doc/dev/new_layer/index.rst b/doc/dev/new_layer/index.rst new file mode 100644 index 0000000000..37dac3a14d --- /dev/null +++ b/doc/dev/new_layer/index.rst @@ -0,0 +1,7 @@ +Writing New Layers +================== + +.. toctree:: + :maxdepth: 3 + + new_layer.rst diff --git a/doc/demo/new_layer/index.rst b/doc/dev/new_layer/new_layer.rst similarity index 100% rename from doc/demo/new_layer/index.rst rename to doc/dev/new_layer/new_layer.rst diff --git a/doc/index.md b/doc/index.md index 1e49f05af8..b9d488052f 100644 --- a/doc/index.md +++ b/doc/index.md @@ -7,8 +7,16 @@ User Guide * [Build and Installation](build/index.rst) * [Contribute Code](build/contribute_to_paddle.md) * [User Interface](ui/index.md) -* [Source Code Documents](source/index.md) -* [Layer Documents](layer.md) -* [Trainer Config Helpers](ui/api/trainer_config_helpers/index.md) +* [Model Config Interface](ui/api/trainer_config_helpers/index.md) * [Example and Demo](demo/index.md) * [Cluster Train](cluster/index.md) + +Development Guide +----------------- +* [Layer Documents](layer.md) +* [Writing New Layers](dev/new_layer/index.rst) +* [Source Code Documents](source/index.md) + +Algorithm Tutorial +------------------ +* [RNN Configuration](algorithm/rnn/rnn.rst) diff --git a/doc/ui/api/rnn/bi_lstm.jpg b/doc/ui/api/rnn/bi_lstm.jpg deleted file mode 120000 index ae94882e70..0000000000 --- a/doc/ui/api/rnn/bi_lstm.jpg +++ /dev/null @@ -1 +0,0 @@ -../../../demo/sentiment_analysis/bi_lstm.jpg \ No newline at end of file diff --git a/doc/ui/api/rnn/encoder-decoder-attention-model.png b/doc/ui/api/rnn/encoder-decoder-attention-model.png deleted file mode 120000 index f83c45bda8..0000000000 --- a/doc/ui/api/rnn/encoder-decoder-attention-model.png +++ /dev/null @@ -1 +0,0 @@ -../../../demo/text_generation/encoder-decoder-attention-model.png \ No newline at end of file diff --git a/doc/ui/api/trainer_config_helpers/index.md b/doc/ui/api/trainer_config_helpers/index.md index 0255b4ba3d..00fa99bb3f 100644 --- a/doc/ui/api/trainer_config_helpers/index.md +++ b/doc/ui/api/trainer_config_helpers/index.md @@ -1,4 +1,4 @@ -# Trainer Config Helpers +# Model Config Interface * [Optimizer](optimizers_index.rst) * [Data Source](data_sources.rst) @@ -7,4 +7,4 @@ * [Poolings](poolings_index.rst) * [Networks](networks_index.rst) * [Evaluators](evaluators_index.rst) -* [Parameter and Extra Layer Attribute](attrs.rst) +* [Parameter and Extra Layer Attribute](attrs.rst) diff --git a/doc/ui/index.md b/doc/ui/index.md index 52b3dd4688..03699b6832 100644 --- a/doc/ui/index.md +++ b/doc/ui/index.md @@ -9,13 +9,12 @@ * [PyDataProviderWrapper](api/py_data_provider_wrapper.rst) * [Trainer Config Helpers](api/trainer_config_helpers/index.md) -* [Recurrent Neural Network Configuration](api/rnn/index.rst) ## Command Line Argument * [Use Case](cmd_argument/use_case.md) * [Argument Outline](cmd_argument/argument_outline.md) -* [Detailed Descriptions of All Command Line Arguments](cmd_argument/detail_introduction.md) +* [Detailed Descriptions](cmd_argument/detail_introduction.md) ## Predict -- GitLab