From d5a80b968eac16eb85b454d32125dffc0a970037 Mon Sep 17 00:00:00 2001 From: yuyang18 Date: Thu, 7 Jun 2018 20:22:03 +0800 Subject: [PATCH] Complete First draft --- source/api_guides/high_level/index.rst | 7 ++ source/api_guides/index.rst | 14 ++++ .../low_level/executor/executor.rst | 3 + .../low_level/executor/parallel_executor.rst | 3 + source/api_guides/low_level/index.rst | 69 +++++++++++++++++++ .../low_level/layers/activations.rst | 4 ++ .../low_level/layers/convolution.rst | 3 + .../api_guides/low_level/layers/detection.rst | 4 ++ source/api_guides/low_level/layers/io.rst | 3 + source/api_guides/low_level/layers/math.rst | 4 ++ .../api_guides/low_level/layers/metrics.rst | 3 + .../api_guides/low_level/layers/pooling.rst | 5 ++ .../low_level/layers/preprocessing.rst | 12 ++++ source/api_reference/CMakeLists.txt | 1 + source/api_reference/clip.rst | 1 + source/api_reference/data | 1 + source/api_reference/data.rst | 1 + source/api_reference/data_feeder.rst | 1 + source/api_reference/evaluator.rst | 1 + source/api_reference/executor.rst | 1 + source/api_reference/gen_doc.py | 1 + source/api_reference/gen_doc.sh | 1 + source/api_reference/index.rst | 20 ++++++ source/api_reference/initializer.rst | 1 + source/api_reference/io.rst | 1 + source/api_reference/layers.rst | 1 + source/api_reference/metrics.rst | 1 + source/api_reference/nets.rst | 1 + source/api_reference/optimizer.rst | 1 + source/api_reference/param_attr.rst | 1 + source/api_reference/profiler.rst | 1 + source/api_reference/regularizer.rst | 1 + source/faq.rst | 3 + source/index.rst | 7 +- .../howto/index.rst | 0 source/{use_guide => user_guides}/index.rst | 0 .../model_bank/index.rst | 0 37 files changed, 180 insertions(+), 2 deletions(-) create mode 100644 source/api_guides/high_level/index.rst create mode 100644 source/api_guides/index.rst create mode 100644 source/api_guides/low_level/executor/executor.rst create mode 100644 source/api_guides/low_level/executor/parallel_executor.rst create mode 100644 source/api_guides/low_level/index.rst create mode 100644 source/api_guides/low_level/layers/activations.rst create mode 100644 source/api_guides/low_level/layers/convolution.rst create mode 100644 source/api_guides/low_level/layers/detection.rst create mode 100644 source/api_guides/low_level/layers/io.rst create mode 100644 source/api_guides/low_level/layers/math.rst create mode 100644 source/api_guides/low_level/layers/metrics.rst create mode 100644 source/api_guides/low_level/layers/pooling.rst create mode 100644 source/api_guides/low_level/layers/preprocessing.rst create mode 120000 source/api_reference/CMakeLists.txt create mode 120000 source/api_reference/clip.rst create mode 120000 source/api_reference/data create mode 120000 source/api_reference/data.rst create mode 120000 source/api_reference/data_feeder.rst create mode 120000 source/api_reference/evaluator.rst create mode 120000 source/api_reference/executor.rst create mode 120000 source/api_reference/gen_doc.py create mode 120000 source/api_reference/gen_doc.sh create mode 100644 source/api_reference/index.rst create mode 120000 source/api_reference/initializer.rst create mode 120000 source/api_reference/io.rst create mode 120000 source/api_reference/layers.rst create mode 120000 source/api_reference/metrics.rst create mode 120000 source/api_reference/nets.rst create mode 120000 source/api_reference/optimizer.rst create mode 120000 source/api_reference/param_attr.rst create mode 120000 source/api_reference/profiler.rst create mode 120000 source/api_reference/regularizer.rst create mode 100644 source/faq.rst rename source/{use_guide => user_guides}/howto/index.rst (100%) rename source/{use_guide => user_guides}/index.rst (100%) rename source/{use_guide => user_guides}/model_bank/index.rst (100%) diff --git a/source/api_guides/high_level/index.rst b/source/api_guides/high_level/index.rst new file mode 100644 index 000000000..946e2156e --- /dev/null +++ b/source/api_guides/high_level/index.rst @@ -0,0 +1,7 @@ +############## +High level API +############## + +.. todo:: + + Complete this doc \ No newline at end of file diff --git a/source/api_guides/index.rst b/source/api_guides/index.rst new file mode 100644 index 000000000..fe624a6ae --- /dev/null +++ b/source/api_guides/index.rst @@ -0,0 +1,14 @@ +######### +API Guide +######### + +.. todo:: + + Complete this doc + + +.. toctree:: + :maxdepth: 4 + + high_level/index.rst + low_level/index.rst \ No newline at end of file diff --git a/source/api_guides/low_level/executor/executor.rst b/source/api_guides/low_level/executor/executor.rst new file mode 100644 index 000000000..090dde218 --- /dev/null +++ b/source/api_guides/low_level/executor/executor.rst @@ -0,0 +1,3 @@ +######## +Executor +######## \ No newline at end of file diff --git a/source/api_guides/low_level/executor/parallel_executor.rst b/source/api_guides/low_level/executor/parallel_executor.rst new file mode 100644 index 000000000..5f14a6b36 --- /dev/null +++ b/source/api_guides/low_level/executor/parallel_executor.rst @@ -0,0 +1,3 @@ +################ +ParallelExecutor +################ \ No newline at end of file diff --git a/source/api_guides/low_level/index.rst b/source/api_guides/low_level/index.rst new file mode 100644 index 000000000..3f2c5a2fc --- /dev/null +++ b/source/api_guides/low_level/index.rst @@ -0,0 +1,69 @@ +############# +Low level API +############# + +Layers +###### + +神经网络的主体API是一些层函数，他们包括 + +.. toctree:: + :maxdepth: 1 + + layers/math.rst + layers/activations.rst + layers/convolution.rst + layers/pooling.rst + layers/preprocessing.rst + layers/io.rst + layers/metrics.rst + layers/detection.rst + +执行引擎 +######## + +.. toctree:: + + executor/executor.rst + executor/parallel_executor.rst + +数据读取 +######## + +参数属性与参数初始化(ParamAttr) +############################### + + +预测引擎 +######## + +Program/Block/Variable +###################### + +Scope +##### + +CreateOperator +############## + +Backward +######## + +模型平均(Model Average) +####################### + +Optimizers +########## + +正则化 +###### + +Transpiler +########## + +Gradient Clipping +################# + +调试工具/VisualDL +################# + diff --git a/source/api_guides/low_level/layers/activations.rst b/source/api_guides/low_level/layers/activations.rst new file mode 100644 index 000000000..88191af24 --- /dev/null +++ b/source/api_guides/low_level/layers/activations.rst @@ -0,0 +1,4 @@ +######## +激活函数 +######## + diff --git a/source/api_guides/low_level/layers/convolution.rst b/source/api_guides/low_level/layers/convolution.rst new file mode 100644 index 000000000..64df924a8 --- /dev/null +++ b/source/api_guides/low_level/layers/convolution.rst @@ -0,0 +1,3 @@ +######## +卷积操作 +######## diff --git a/source/api_guides/low_level/layers/detection.rst b/source/api_guides/low_level/layers/detection.rst new file mode 100644 index 000000000..00a3fc40c --- /dev/null +++ b/source/api_guides/low_level/layers/detection.rst @@ -0,0 +1,4 @@ +######## +图像检测 +######## + diff --git a/source/api_guides/low_level/layers/io.rst b/source/api_guides/low_level/layers/io.rst new file mode 100644 index 000000000..e48bafe1c --- /dev/null +++ b/source/api_guides/low_level/layers/io.rst @@ -0,0 +1,3 @@ +######## +输入输出 +######## \ No newline at end of file diff --git a/source/api_guides/low_level/layers/math.rst b/source/api_guides/low_level/layers/math.rst new file mode 100644 index 000000000..2c8cc5609 --- /dev/null +++ b/source/api_guides/low_level/layers/math.rst @@ -0,0 +1,4 @@ +######## +数学算子 +######## + diff --git a/source/api_guides/low_level/layers/metrics.rst b/source/api_guides/low_level/layers/metrics.rst new file mode 100644 index 000000000..42a82f606 --- /dev/null +++ b/source/api_guides/low_level/layers/metrics.rst @@ -0,0 +1,3 @@ +######## +评价指标 +######## \ No newline at end of file diff --git a/source/api_guides/low_level/layers/pooling.rst b/source/api_guides/low_level/layers/pooling.rst new file mode 100644 index 000000000..ecca8a465 --- /dev/null +++ b/source/api_guides/low_level/layers/pooling.rst @@ -0,0 +1,5 @@ +######## +池化操作 +######## + + diff --git a/source/api_guides/low_level/layers/preprocessing.rst b/source/api_guides/low_level/layers/preprocessing.rst new file mode 100644 index 000000000..7ab81de57 --- /dev/null +++ b/source/api_guides/low_level/layers/preprocessing.rst @@ -0,0 +1,12 @@ +########## +预处理操作 +########## + + + +图像预处理操作 +############## + + +语音预处理操作 +############## \ No newline at end of file diff --git a/source/api_reference/CMakeLists.txt b/source/api_reference/CMakeLists.txt new file mode 120000 index 000000000..fb6994a31 --- /dev/null +++ b/source/api_reference/CMakeLists.txt @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/CMakeLists.txt \ No newline at end of file diff --git a/source/api_reference/clip.rst b/source/api_reference/clip.rst new file mode 120000 index 000000000..87f7f380f --- /dev/null +++ b/source/api_reference/clip.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/clip.rst \ No newline at end of file diff --git a/source/api_reference/data b/source/api_reference/data new file mode 120000 index 000000000..5aa0dd5cb --- /dev/null +++ b/source/api_reference/data @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/data \ No newline at end of file diff --git a/source/api_reference/data.rst b/source/api_reference/data.rst new file mode 120000 index 000000000..f4f09037a --- /dev/null +++ b/source/api_reference/data.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/data.rst \ No newline at end of file diff --git a/source/api_reference/data_feeder.rst b/source/api_reference/data_feeder.rst new file mode 120000 index 000000000..5cbc4d50a --- /dev/null +++ b/source/api_reference/data_feeder.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/data_feeder.rst \ No newline at end of file diff --git a/source/api_reference/evaluator.rst b/source/api_reference/evaluator.rst new file mode 120000 index 000000000..634242f99 --- /dev/null +++ b/source/api_reference/evaluator.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/evaluator.rst \ No newline at end of file diff --git a/source/api_reference/executor.rst b/source/api_reference/executor.rst new file mode 120000 index 000000000..983b8370a --- /dev/null +++ b/source/api_reference/executor.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/executor.rst \ No newline at end of file diff --git a/source/api_reference/gen_doc.py b/source/api_reference/gen_doc.py new file mode 120000 index 000000000..e804d4231 --- /dev/null +++ b/source/api_reference/gen_doc.py @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/gen_doc.py \ No newline at end of file diff --git a/source/api_reference/gen_doc.sh b/source/api_reference/gen_doc.sh new file mode 120000 index 000000000..8cd71d6aa --- /dev/null +++ b/source/api_reference/gen_doc.sh @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/gen_doc.sh \ No newline at end of file diff --git a/source/api_reference/index.rst b/source/api_reference/index.rst new file mode 100644 index 000000000..691d43074 --- /dev/null +++ b/source/api_reference/index.rst @@ -0,0 +1,20 @@ +============= +API Reference +============= + +.. toctree:: + :maxdepth: 1 + + layers.rst + data_feeder.rst + executor.rst + initializer.rst + metrics.rst + nets.rst + clip.rst + optimizer.rst + param_attr.rst + profiler.rst + regularizer.rst + io.rst + data.rst diff --git a/source/api_reference/initializer.rst b/source/api_reference/initializer.rst new file mode 120000 index 000000000..25df2753b --- /dev/null +++ b/source/api_reference/initializer.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/initializer.rst \ No newline at end of file diff --git a/source/api_reference/io.rst b/source/api_reference/io.rst new file mode 120000 index 000000000..08acb699c --- /dev/null +++ b/source/api_reference/io.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/io.rst \ No newline at end of file diff --git a/source/api_reference/layers.rst b/source/api_reference/layers.rst new file mode 120000 index 000000000..8c725001f --- /dev/null +++ b/source/api_reference/layers.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/layers.rst \ No newline at end of file diff --git a/source/api_reference/metrics.rst b/source/api_reference/metrics.rst new file mode 120000 index 000000000..2b4619fb8 --- /dev/null +++ b/source/api_reference/metrics.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/metrics.rst \ No newline at end of file diff --git a/source/api_reference/nets.rst b/source/api_reference/nets.rst new file mode 120000 index 000000000..b02bc6099 --- /dev/null +++ b/source/api_reference/nets.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/nets.rst \ No newline at end of file diff --git a/source/api_reference/optimizer.rst b/source/api_reference/optimizer.rst new file mode 120000 index 000000000..2e3479f6d --- /dev/null +++ b/source/api_reference/optimizer.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/optimizer.rst \ No newline at end of file diff --git a/source/api_reference/param_attr.rst b/source/api_reference/param_attr.rst new file mode 120000 index 000000000..cf306cc4b --- /dev/null +++ b/source/api_reference/param_attr.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/param_attr.rst \ No newline at end of file diff --git a/source/api_reference/profiler.rst b/source/api_reference/profiler.rst new file mode 120000 index 000000000..f62983a99 --- /dev/null +++ b/source/api_reference/profiler.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/profiler.rst \ No newline at end of file diff --git a/source/api_reference/regularizer.rst b/source/api_reference/regularizer.rst new file mode 120000 index 000000000..d5063d766 --- /dev/null +++ b/source/api_reference/regularizer.rst @@ -0,0 +1 @@ +../../paddle/doc/fluid/api/regularizer.rst \ No newline at end of file diff --git a/source/faq.rst b/source/faq.rst new file mode 100644 index 000000000..9d43c91a8 --- /dev/null +++ b/source/faq.rst @@ -0,0 +1,3 @@ +### +FAQ +### diff --git a/source/index.rst b/source/index.rst index 8bd47d1c3..21c0c38f0 100644 --- a/source/index.rst +++ b/source/index.rst @@ -12,11 +12,14 @@ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 quick_start/index.rst - use_guide/index.rst + user_guides/index.rst advanced_usage/index.rst + api_guides/index.rst + api_reference/index.rst + faq.rst Indices and tables ================== diff --git a/source/use_guide/howto/index.rst b/source/user_guides/howto/index.rst similarity index 100% rename from source/use_guide/howto/index.rst rename to source/user_guides/howto/index.rst diff --git a/source/use_guide/index.rst b/source/user_guides/index.rst similarity index 100% rename from source/use_guide/index.rst rename to source/user_guides/index.rst diff --git a/source/use_guide/model_bank/index.rst b/source/user_guides/model_bank/index.rst similarity index 100% rename from source/use_guide/model_bank/index.rst rename to source/user_guides/model_bank/index.rst -- GitLab