From 5348257163584b8e4f80e29bc536aa45765e7897 Mon Sep 17 00:00:00 2001 From: yuyang18 Date: Fri, 8 Jun 2018 16:54:50 +0800 Subject: [PATCH] Update API settings --- source/api_reference/CMakeLists.txt | 1 - source/api_reference/clip.rst | 48 +- source/api_reference/data.rst | 1 - source/api_reference/data_feeder.rst | 15 +- source/api_reference/evaluator.rst | 1 - source/api_reference/executor.rst | 39 +- source/api_reference/gen_doc.sh | 8 +- source/api_reference/initializer.rst | 76 +- source/api_reference/io.rst | 80 +- source/api_reference/layers.rst | 1105 +++++++++++++++++++++++++- source/api_reference/metrics.rst | 57 +- source/api_reference/nets.rst | 32 +- source/api_reference/optimizer.rst | 120 ++- source/api_reference/param_attr.rst | 22 +- source/api_reference/profiler.rst | 38 +- source/api_reference/regularizer.rst | 49 +- source/conf.py | 2 + 17 files changed, 1678 insertions(+), 16 deletions(-) delete mode 120000 source/api_reference/CMakeLists.txt mode change 120000 => 100644 source/api_reference/clip.rst delete mode 120000 source/api_reference/data.rst mode change 120000 => 100644 source/api_reference/data_feeder.rst delete mode 120000 source/api_reference/evaluator.rst mode change 120000 => 100644 source/api_reference/executor.rst mode change 120000 => 100755 source/api_reference/gen_doc.sh mode change 120000 => 100644 source/api_reference/initializer.rst mode change 120000 => 100644 source/api_reference/io.rst mode change 120000 => 100644 source/api_reference/layers.rst mode change 120000 => 100644 source/api_reference/metrics.rst mode change 120000 => 100644 source/api_reference/nets.rst mode change 120000 => 100644 source/api_reference/optimizer.rst mode change 120000 => 100644 source/api_reference/param_attr.rst mode change 120000 => 100644 source/api_reference/profiler.rst mode change 120000 => 100644 source/api_reference/regularizer.rst diff --git a/source/api_reference/CMakeLists.txt b/source/api_reference/CMakeLists.txt deleted file mode 120000 index fb6994a31..000000000 --- a/source/api_reference/CMakeLists.txt +++ /dev/null @@ -1 +0,0 @@ -../../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 deleted file mode 120000 index 87f7f380f..000000000 --- a/source/api_reference/clip.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/clip.rst \ No newline at end of file diff --git a/source/api_reference/clip.rst b/source/api_reference/clip.rst new file mode 100644 index 000000000..3ba096388 --- /dev/null +++ b/source/api_reference/clip.rst @@ -0,0 +1,47 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +==== +clip +==== + +ErrorClipByValue +---------------- + +.. autoclass:: paddle.fluid.clip.ErrorClipByValue + :members: + :noindex: + +GradientClipByValue +------------------- + +.. autoclass:: paddle.fluid.clip.GradientClipByValue + :members: + :noindex: + +GradientClipByNorm +------------------ + +.. autoclass:: paddle.fluid.clip.GradientClipByNorm + :members: + :noindex: + +GradientClipByGlobalNorm +------------------------ + +.. autoclass:: paddle.fluid.clip.GradientClipByGlobalNorm + :members: + :noindex: + +append_gradient_clip_ops +------------------------ + +.. autofunction:: paddle.fluid.clip.append_gradient_clip_ops + :noindex: + +error_clip_callback +------------------- + +.. autofunction:: paddle.fluid.clip.error_clip_callback + :noindex: + diff --git a/source/api_reference/data.rst b/source/api_reference/data.rst deleted file mode 120000 index f4f09037a..000000000 --- a/source/api_reference/data.rst +++ /dev/null @@ -1 +0,0 @@ -../../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 deleted file mode 120000 index 5cbc4d50a..000000000 --- a/source/api_reference/data_feeder.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/data_feeder.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 100644 index 000000000..3df5c0307 --- /dev/null +++ b/source/api_reference/data_feeder.rst @@ -0,0 +1,14 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +=========== +data_feeder +=========== + +DataFeeder +---------- + +.. autoclass:: paddle.fluid.data_feeder.DataFeeder + :members: + :noindex: + diff --git a/source/api_reference/evaluator.rst b/source/api_reference/evaluator.rst deleted file mode 120000 index 634242f99..000000000 --- a/source/api_reference/evaluator.rst +++ /dev/null @@ -1 +0,0 @@ -../../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 deleted file mode 120000 index 983b8370a..000000000 --- a/source/api_reference/executor.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/executor.rst \ No newline at end of file diff --git a/source/api_reference/executor.rst b/source/api_reference/executor.rst new file mode 100644 index 000000000..f67a14c49 --- /dev/null +++ b/source/api_reference/executor.rst @@ -0,0 +1,38 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +======== +executor +======== + +Executor +-------- + +.. autoclass:: paddle.fluid.executor.Executor + :members: + :noindex: + +global_scope +------------ + +.. autofunction:: paddle.fluid.executor.global_scope + :noindex: + +scope_guard +----------- + +.. autofunction:: paddle.fluid.executor.scope_guard + :noindex: + +switch_scope +------------ + +.. autofunction:: paddle.fluid.executor.switch_scope + :noindex: + +fetch_var +--------- + +.. autofunction:: paddle.fluid.executor.fetch_var + :noindex: + diff --git a/source/api_reference/gen_doc.sh b/source/api_reference/gen_doc.sh deleted file mode 120000 index 8cd71d6aa..000000000 --- a/source/api_reference/gen_doc.sh +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/gen_doc.sh \ 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 100755 index 000000000..d628cdf05 --- /dev/null +++ b/source/api_reference/gen_doc.sh @@ -0,0 +1,7 @@ +#!/bin/bash +python gen_doc.py layers --submodules control_flow device io nn ops tensor learning_rate_scheduler > layers.rst + +for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer +do + python gen_doc.py ${module} > ${module}.rst +done diff --git a/source/api_reference/initializer.rst b/source/api_reference/initializer.rst deleted file mode 120000 index 25df2753b..000000000 --- a/source/api_reference/initializer.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/initializer.rst \ No newline at end of file diff --git a/source/api_reference/initializer.rst b/source/api_reference/initializer.rst new file mode 100644 index 000000000..c49a98c74 --- /dev/null +++ b/source/api_reference/initializer.rst @@ -0,0 +1,75 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +=========== +initializer +=========== + +Constant +-------- + +.. autoclass:: paddle.fluid.initializer.Constant + :members: + :noindex: + +Uniform +------- + +.. autoclass:: paddle.fluid.initializer.Uniform + :members: + :noindex: + +Normal +------ + +.. autoclass:: paddle.fluid.initializer.Normal + :members: + :noindex: + +Xavier +------ + +.. autoclass:: paddle.fluid.initializer.Xavier + :members: + :noindex: + +force_init_on_cpu +----------------- + +.. autofunction:: paddle.fluid.initializer.force_init_on_cpu + :noindex: + +init_on_cpu +----------- + +.. autofunction:: paddle.fluid.initializer.init_on_cpu + :noindex: + +ConstantInitializer +------------------- + +.. autoclass:: paddle.fluid.initializer.ConstantInitializer + :members: + :noindex: + +UniformInitializer +------------------ + +.. autoclass:: paddle.fluid.initializer.UniformInitializer + :members: + :noindex: + +NormalInitializer +----------------- + +.. autoclass:: paddle.fluid.initializer.NormalInitializer + :members: + :noindex: + +XavierInitializer +----------------- + +.. autoclass:: paddle.fluid.initializer.XavierInitializer + :members: + :noindex: + diff --git a/source/api_reference/io.rst b/source/api_reference/io.rst deleted file mode 120000 index 08acb699c..000000000 --- a/source/api_reference/io.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/io.rst \ No newline at end of file diff --git a/source/api_reference/io.rst b/source/api_reference/io.rst new file mode 100644 index 000000000..3e956f830 --- /dev/null +++ b/source/api_reference/io.rst @@ -0,0 +1,79 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +== +io +== + +save_vars +--------- + +.. autofunction:: paddle.fluid.io.save_vars + :noindex: + +save_params +----------- + +.. autofunction:: paddle.fluid.io.save_params + :noindex: + +save_persistables +----------------- + +.. autofunction:: paddle.fluid.io.save_persistables + :noindex: + +load_vars +--------- + +.. autofunction:: paddle.fluid.io.load_vars + :noindex: + +load_params +----------- + +.. autofunction:: paddle.fluid.io.load_params + :noindex: + +load_persistables +----------------- + +.. autofunction:: paddle.fluid.io.load_persistables + :noindex: + +save_inference_model +-------------------- + +.. autofunction:: paddle.fluid.io.save_inference_model + :noindex: + +load_inference_model +-------------------- + +.. autofunction:: paddle.fluid.io.load_inference_model + :noindex: + +get_inference_program +--------------------- + +.. autofunction:: paddle.fluid.io.get_inference_program + :noindex: + +save_checkpoint +--------------- + +.. autofunction:: paddle.fluid.io.save_checkpoint + :noindex: + +load_checkpoint +--------------- + +.. autofunction:: paddle.fluid.io.load_checkpoint + :noindex: + +clean_checkpoint +---------------- + +.. autofunction:: paddle.fluid.io.clean_checkpoint + :noindex: + diff --git a/source/api_reference/layers.rst b/source/api_reference/layers.rst deleted file mode 120000 index 8c725001f..000000000 --- a/source/api_reference/layers.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/layers.rst \ No newline at end of file diff --git a/source/api_reference/layers.rst b/source/api_reference/layers.rst new file mode 100644 index 000000000..cef738386 --- /dev/null +++ b/source/api_reference/layers.rst @@ -0,0 +1,1104 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +====== +layers +====== + +control_flow +============ + +split_lod_tensor +---------------- + +.. autofunction:: paddle.fluid.layers.split_lod_tensor + :noindex: + +merge_lod_tensor +---------------- + +.. autofunction:: paddle.fluid.layers.merge_lod_tensor + :noindex: + +BlockGuard +---------- + +.. autoclass:: paddle.fluid.layers.BlockGuard + :members: + :noindex: + +BlockGuardWithCompletion +------------------------ + +.. autoclass:: paddle.fluid.layers.BlockGuardWithCompletion + :members: + :noindex: + +StaticRNNMemoryLink +------------------- + +.. autoclass:: paddle.fluid.layers.StaticRNNMemoryLink + :members: + :noindex: + +WhileGuard +---------- + +.. autoclass:: paddle.fluid.layers.WhileGuard + :members: + :noindex: + +While +----- + +.. autoclass:: paddle.fluid.layers.While + :members: + :noindex: + +Switch +------ + +.. autoclass:: paddle.fluid.layers.Switch + :members: + :noindex: + +lod_rank_table +-------------- + +.. autofunction:: paddle.fluid.layers.lod_rank_table + :noindex: + +max_sequence_len +---------------- + +.. autofunction:: paddle.fluid.layers.max_sequence_len + :noindex: + +lod_tensor_to_array +------------------- + +.. autofunction:: paddle.fluid.layers.lod_tensor_to_array + :noindex: + +array_to_lod_tensor +------------------- + +.. autofunction:: paddle.fluid.layers.array_to_lod_tensor + :noindex: + +increment +--------- + +.. autofunction:: paddle.fluid.layers.increment + :noindex: + +array_write +----------- + +.. autofunction:: paddle.fluid.layers.array_write + :noindex: + +create_array +------------ + +.. autofunction:: paddle.fluid.layers.create_array + :noindex: + +less_than +--------- + +.. autofunction:: paddle.fluid.layers.less_than + :noindex: + +equal +----- + +.. autofunction:: paddle.fluid.layers.equal + :noindex: + +array_read +---------- + +.. autofunction:: paddle.fluid.layers.array_read + :noindex: + +shrink_memory +------------- + +.. autofunction:: paddle.fluid.layers.shrink_memory + :noindex: + +array_length +------------ + +.. autofunction:: paddle.fluid.layers.array_length + :noindex: + +IfElse +------ + +.. autoclass:: paddle.fluid.layers.IfElse + :members: + :noindex: + +DynamicRNN +---------- + +.. autoclass:: paddle.fluid.layers.DynamicRNN + :members: + :noindex: + +ConditionalBlock +---------------- + +.. autoclass:: paddle.fluid.layers.ConditionalBlock + :members: + :noindex: + +StaticRNN +--------- + +.. autoclass:: paddle.fluid.layers.StaticRNN + :members: + :noindex: + +reorder_lod_tensor_by_rank +-------------------------- + +.. autofunction:: paddle.fluid.layers.reorder_lod_tensor_by_rank + :noindex: + +ParallelDo +---------- + +.. autoclass:: paddle.fluid.layers.ParallelDo + :members: + :noindex: + +Print +----- + +.. autofunction:: paddle.fluid.layers.Print + :noindex: + +is_empty +-------- + +.. autofunction:: paddle.fluid.layers.is_empty + :noindex: + +device +====== + +get_places +---------- + +.. autofunction:: paddle.fluid.layers.get_places + :noindex: + +io +== + +data +---- + +.. autofunction:: paddle.fluid.layers.data + :noindex: + +BlockGuardServ +-------------- + +.. autoclass:: paddle.fluid.layers.BlockGuardServ + :members: + :noindex: + +ListenAndServ +------------- + +.. autoclass:: paddle.fluid.layers.ListenAndServ + :members: + :noindex: + +Send +---- + +.. autofunction:: paddle.fluid.layers.Send + :noindex: + +open_recordio_file +------------------ + +.. autofunction:: paddle.fluid.layers.open_recordio_file + :noindex: + +open_files +---------- + +.. autofunction:: paddle.fluid.layers.open_files + :noindex: + +read_file +--------- + +.. autofunction:: paddle.fluid.layers.read_file + :noindex: + +shuffle +------- + +.. autofunction:: paddle.fluid.layers.shuffle + :noindex: + +batch +----- + +.. autofunction:: paddle.fluid.layers.batch + :noindex: + +double_buffer +------------- + +.. autofunction:: paddle.fluid.layers.double_buffer + :noindex: + +random_data_generator +--------------------- + +.. autofunction:: paddle.fluid.layers.random_data_generator + :noindex: + +Preprocessor +------------ + +.. autoclass:: paddle.fluid.layers.Preprocessor + :members: + :noindex: + +load +---- + +.. autofunction:: paddle.fluid.layers.load + :noindex: + +nn +== + +fc +-- + +.. autofunction:: paddle.fluid.layers.fc + :noindex: + +embedding +--------- + +.. autofunction:: paddle.fluid.layers.embedding + :noindex: + +dynamic_lstm +------------ + +.. autofunction:: paddle.fluid.layers.dynamic_lstm + :noindex: + +dynamic_lstmp +------------- + +.. autofunction:: paddle.fluid.layers.dynamic_lstmp + :noindex: + +dynamic_gru +----------- + +.. autofunction:: paddle.fluid.layers.dynamic_gru + :noindex: + +gru_unit +-------- + +.. autofunction:: paddle.fluid.layers.gru_unit + :noindex: + +linear_chain_crf +---------------- + +.. autofunction:: paddle.fluid.layers.linear_chain_crf + :noindex: + +crf_decoding +------------ + +.. autofunction:: paddle.fluid.layers.crf_decoding + :noindex: + +cos_sim +------- + +.. autofunction:: paddle.fluid.layers.cos_sim + :noindex: + +cross_entropy +------------- + +.. autofunction:: paddle.fluid.layers.cross_entropy + :noindex: + +square_error_cost +----------------- + +.. autofunction:: paddle.fluid.layers.square_error_cost + :noindex: + +chunk_eval +---------- + +.. autofunction:: paddle.fluid.layers.chunk_eval + :noindex: + +sequence_conv +------------- + +.. autofunction:: paddle.fluid.layers.sequence_conv + :noindex: + +conv2d +------ + +.. autofunction:: paddle.fluid.layers.conv2d + :noindex: + +sequence_pool +------------- + +.. autofunction:: paddle.fluid.layers.sequence_pool + :noindex: + +sequence_softmax +---------------- + +.. autofunction:: paddle.fluid.layers.sequence_softmax + :noindex: + +softmax +------- + +.. autofunction:: paddle.fluid.layers.softmax + :noindex: + +pool2d +------ + +.. autofunction:: paddle.fluid.layers.pool2d + :noindex: + +batch_norm +---------- + +.. autofunction:: paddle.fluid.layers.batch_norm + :noindex: + +beam_search_decode +------------------ + +.. autofunction:: paddle.fluid.layers.beam_search_decode + :noindex: + +conv2d_transpose +---------------- + +.. autofunction:: paddle.fluid.layers.conv2d_transpose + :noindex: + +sequence_expand +--------------- + +.. autofunction:: paddle.fluid.layers.sequence_expand + :noindex: + +lstm_unit +--------- + +.. autofunction:: paddle.fluid.layers.lstm_unit + :noindex: + +reduce_sum +---------- + +.. autofunction:: paddle.fluid.layers.reduce_sum + :noindex: + +reduce_mean +----------- + +.. autofunction:: paddle.fluid.layers.reduce_mean + :noindex: + +reduce_max +---------- + +.. autofunction:: paddle.fluid.layers.reduce_max + :noindex: + +reduce_min +---------- + +.. autofunction:: paddle.fluid.layers.reduce_min + :noindex: + +reduce_prod +----------- + +.. autofunction:: paddle.fluid.layers.reduce_prod + :noindex: + +sequence_first_step +------------------- + +.. autofunction:: paddle.fluid.layers.sequence_first_step + :noindex: + +sequence_last_step +------------------ + +.. autofunction:: paddle.fluid.layers.sequence_last_step + :noindex: + +dropout +------- + +.. autofunction:: paddle.fluid.layers.dropout + :noindex: + +split +----- + +.. autofunction:: paddle.fluid.layers.split + :noindex: + +ctc_greedy_decoder +------------------ + +.. autofunction:: paddle.fluid.layers.ctc_greedy_decoder + :noindex: + +edit_distance +------------- + +.. autofunction:: paddle.fluid.layers.edit_distance + :noindex: + +l2_normalize +------------ + +.. autofunction:: paddle.fluid.layers.l2_normalize + :noindex: + +matmul +------ + +.. autofunction:: paddle.fluid.layers.matmul + :noindex: + +topk +---- + +.. autofunction:: paddle.fluid.layers.topk + :noindex: + +warpctc +------- + +.. autofunction:: paddle.fluid.layers.warpctc + :noindex: + +sequence_reshape +---------------- + +.. autofunction:: paddle.fluid.layers.sequence_reshape + :noindex: + +transpose +--------- + +.. autofunction:: paddle.fluid.layers.transpose + :noindex: + +im2sequence +----------- + +.. autofunction:: paddle.fluid.layers.im2sequence + :noindex: + +nce +--- + +.. autofunction:: paddle.fluid.layers.nce + :noindex: + +beam_search +----------- + +.. autofunction:: paddle.fluid.layers.beam_search + :noindex: + +row_conv +-------- + +.. autofunction:: paddle.fluid.layers.row_conv + :noindex: + +multiplex +--------- + +.. autofunction:: paddle.fluid.layers.multiplex + :noindex: + +layer_norm +---------- + +.. autofunction:: paddle.fluid.layers.layer_norm + :noindex: + +softmax_with_cross_entropy +-------------------------- + +.. autofunction:: paddle.fluid.layers.softmax_with_cross_entropy + :noindex: + +smooth_l1 +--------- + +.. autofunction:: paddle.fluid.layers.smooth_l1 + :noindex: + +one_hot +------- + +.. autofunction:: paddle.fluid.layers.one_hot + :noindex: + +autoincreased_step_counter +-------------------------- + +.. autofunction:: paddle.fluid.layers.autoincreased_step_counter + :noindex: + +reshape +------- + +.. autofunction:: paddle.fluid.layers.reshape + :noindex: + +lod_reset +--------- + +.. autofunction:: paddle.fluid.layers.lod_reset + :noindex: + +lrn +--- + +.. autofunction:: paddle.fluid.layers.lrn + :noindex: + +pad +--- + +.. autofunction:: paddle.fluid.layers.pad + :noindex: + +label_smooth +------------ + +.. autofunction:: paddle.fluid.layers.label_smooth + :noindex: + +roi_pool +-------- + +.. autofunction:: paddle.fluid.layers.roi_pool + :noindex: + +dice_loss +--------- + +.. autofunction:: paddle.fluid.layers.dice_loss + :noindex: + +image_resize +------------ + +.. autofunction:: paddle.fluid.layers.image_resize + :noindex: + +image_resize_short +------------------ + +.. autofunction:: paddle.fluid.layers.image_resize_short + :noindex: + +resize_bilinear +--------------- + +.. autofunction:: paddle.fluid.layers.resize_bilinear + :noindex: + +gather +------ + +.. autofunction:: paddle.fluid.layers.gather + :noindex: + +random_crop +----------- + +.. autofunction:: paddle.fluid.layers.random_crop + :noindex: + +ops +=== + +mean +---- + +.. autofunction:: paddle.fluid.layers.mean + :noindex: + +mul +--- + +.. autofunction:: paddle.fluid.layers.mul + :noindex: + +scale +----- + +.. autofunction:: paddle.fluid.layers.scale + :noindex: + +sigmoid_cross_entropy_with_logits +--------------------------------- + +.. autofunction:: paddle.fluid.layers.sigmoid_cross_entropy_with_logits + :noindex: + +elementwise_add +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_add + :noindex: + +elementwise_div +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_div + :noindex: + +elementwise_sub +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_sub + :noindex: + +elementwise_mul +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_mul + :noindex: + +elementwise_max +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_max + :noindex: + +elementwise_min +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_min + :noindex: + +elementwise_pow +--------------- + +.. autofunction:: paddle.fluid.layers.elementwise_pow + :noindex: + +clip +---- + +.. autofunction:: paddle.fluid.layers.clip + :noindex: + +clip_by_norm +------------ + +.. autofunction:: paddle.fluid.layers.clip_by_norm + :noindex: + +logical_and +----------- + +.. autofunction:: paddle.fluid.layers.logical_and + :noindex: + +logical_or +---------- + +.. autofunction:: paddle.fluid.layers.logical_or + :noindex: + +logical_xor +----------- + +.. autofunction:: paddle.fluid.layers.logical_xor + :noindex: + +logical_not +----------- + +.. autofunction:: paddle.fluid.layers.logical_not + :noindex: + +uniform_random +-------------- + +.. autofunction:: paddle.fluid.layers.uniform_random + :noindex: + +uniform_random_batch_size_like +------------------------------ + +.. autofunction:: paddle.fluid.layers.uniform_random_batch_size_like + :noindex: + +gaussian_random +--------------- + +.. autofunction:: paddle.fluid.layers.gaussian_random + :noindex: + +gaussian_random_batch_size_like +------------------------------- + +.. autofunction:: paddle.fluid.layers.gaussian_random_batch_size_like + :noindex: + +cumsum +------ + +.. autofunction:: paddle.fluid.layers.cumsum + :noindex: + +scatter +------- + +.. autofunction:: paddle.fluid.layers.scatter + :noindex: + +sum +--- + +.. autofunction:: paddle.fluid.layers.sum + :noindex: + +polygon_box_transform +--------------------- + +.. autofunction:: paddle.fluid.layers.polygon_box_transform + :noindex: + +shape +----- + +.. autofunction:: paddle.fluid.layers.shape + :noindex: + +sigmoid +------- + +.. autofunction:: paddle.fluid.layers.sigmoid + :noindex: + +logsigmoid +---------- + +.. autofunction:: paddle.fluid.layers.logsigmoid + :noindex: + +exp +--- + +.. autofunction:: paddle.fluid.layers.exp + :noindex: + +relu +---- + +.. autofunction:: paddle.fluid.layers.relu + :noindex: + +tanh +---- + +.. autofunction:: paddle.fluid.layers.tanh + :noindex: + +tanh_shrink +----------- + +.. autofunction:: paddle.fluid.layers.tanh_shrink + :noindex: + +softshrink +---------- + +.. autofunction:: paddle.fluid.layers.softshrink + :noindex: + +sqrt +---- + +.. autofunction:: paddle.fluid.layers.sqrt + :noindex: + +abs +--- + +.. autofunction:: paddle.fluid.layers.abs + :noindex: + +ceil +---- + +.. autofunction:: paddle.fluid.layers.ceil + :noindex: + +floor +----- + +.. autofunction:: paddle.fluid.layers.floor + :noindex: + +cos +--- + +.. autofunction:: paddle.fluid.layers.cos + :noindex: + +sin +--- + +.. autofunction:: paddle.fluid.layers.sin + :noindex: + +round +----- + +.. autofunction:: paddle.fluid.layers.round + :noindex: + +reciprocal +---------- + +.. autofunction:: paddle.fluid.layers.reciprocal + :noindex: + +log +--- + +.. autofunction:: paddle.fluid.layers.log + :noindex: + +square +------ + +.. autofunction:: paddle.fluid.layers.square + :noindex: + +softplus +-------- + +.. autofunction:: paddle.fluid.layers.softplus + :noindex: + +softsign +-------- + +.. autofunction:: paddle.fluid.layers.softsign + :noindex: + +brelu +----- + +.. autofunction:: paddle.fluid.layers.brelu + :noindex: + +leaky_relu +---------- + +.. autofunction:: paddle.fluid.layers.leaky_relu + :noindex: + +soft_relu +--------- + +.. autofunction:: paddle.fluid.layers.soft_relu + :noindex: + +elu +--- + +.. autofunction:: paddle.fluid.layers.elu + :noindex: + +relu6 +----- + +.. autofunction:: paddle.fluid.layers.relu6 + :noindex: + +pow +--- + +.. autofunction:: paddle.fluid.layers.pow + :noindex: + +stanh +----- + +.. autofunction:: paddle.fluid.layers.stanh + :noindex: + +hard_shrink +----------- + +.. autofunction:: paddle.fluid.layers.hard_shrink + :noindex: + +thresholded_relu +---------------- + +.. autofunction:: paddle.fluid.layers.thresholded_relu + :noindex: + +hard_sigmoid +------------ + +.. autofunction:: paddle.fluid.layers.hard_sigmoid + :noindex: + +swish +----- + +.. autofunction:: paddle.fluid.layers.swish + :noindex: + +tensor +====== + +create_tensor +------------- + +.. autofunction:: paddle.fluid.layers.create_tensor + :noindex: + +create_parameter +---------------- + +.. autofunction:: paddle.fluid.layers.create_parameter + :noindex: + +create_global_var +----------------- + +.. autofunction:: paddle.fluid.layers.create_global_var + :noindex: + +cast +---- + +.. autofunction:: paddle.fluid.layers.cast + :noindex: + +concat +------ + +.. autofunction:: paddle.fluid.layers.concat + :noindex: + +sums +---- + +.. autofunction:: paddle.fluid.layers.sums + :noindex: + +assign +------ + +.. autofunction:: paddle.fluid.layers.assign + :noindex: + +fill_constant_batch_size_like +----------------------------- + +.. autofunction:: paddle.fluid.layers.fill_constant_batch_size_like + :noindex: + +fill_constant +------------- + +.. autofunction:: paddle.fluid.layers.fill_constant + :noindex: + +ones +---- + +.. autofunction:: paddle.fluid.layers.ones + :noindex: + +zeros +----- + +.. autofunction:: paddle.fluid.layers.zeros + :noindex: + +learning_rate_scheduler +======================= + +exponential_decay +----------------- + +.. autofunction:: paddle.fluid.layers.exponential_decay + :noindex: + +natural_exp_decay +----------------- + +.. autofunction:: paddle.fluid.layers.natural_exp_decay + :noindex: + +inverse_time_decay +------------------ + +.. autofunction:: paddle.fluid.layers.inverse_time_decay + :noindex: + +polynomial_decay +---------------- + +.. autofunction:: paddle.fluid.layers.polynomial_decay + :noindex: + +piecewise_decay +--------------- + +.. autofunction:: paddle.fluid.layers.piecewise_decay + :noindex: + +noam_decay +---------- + +.. autofunction:: paddle.fluid.layers.noam_decay + :noindex: + diff --git a/source/api_reference/metrics.rst b/source/api_reference/metrics.rst deleted file mode 120000 index 2b4619fb8..000000000 --- a/source/api_reference/metrics.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/metrics.rst \ No newline at end of file diff --git a/source/api_reference/metrics.rst b/source/api_reference/metrics.rst new file mode 100644 index 000000000..ddf07775d --- /dev/null +++ b/source/api_reference/metrics.rst @@ -0,0 +1,56 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +======= +metrics +======= + +MetricBase +---------- + +.. autoclass:: paddle.fluid.metrics.MetricBase + :members: + :noindex: + +CompositeMetric +--------------- + +.. autoclass:: paddle.fluid.metrics.CompositeMetric + :members: + :noindex: + +Accuracy +-------- + +.. autoclass:: paddle.fluid.metrics.Accuracy + :members: + :noindex: + +ChunkEvaluator +-------------- + +.. autoclass:: paddle.fluid.metrics.ChunkEvaluator + :members: + :noindex: + +EditDistance +------------ + +.. autoclass:: paddle.fluid.metrics.EditDistance + :members: + :noindex: + +DetectionMAP +------------ + +.. autoclass:: paddle.fluid.metrics.DetectionMAP + :members: + :noindex: + +Auc +--- + +.. autoclass:: paddle.fluid.metrics.Auc + :members: + :noindex: + diff --git a/source/api_reference/nets.rst b/source/api_reference/nets.rst deleted file mode 120000 index b02bc6099..000000000 --- a/source/api_reference/nets.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/nets.rst \ No newline at end of file diff --git a/source/api_reference/nets.rst b/source/api_reference/nets.rst new file mode 100644 index 000000000..7ae318730 --- /dev/null +++ b/source/api_reference/nets.rst @@ -0,0 +1,31 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +==== +nets +==== + +simple_img_conv_pool +-------------------- + +.. autofunction:: paddle.fluid.nets.simple_img_conv_pool + :noindex: + +sequence_conv_pool +------------------ + +.. autofunction:: paddle.fluid.nets.sequence_conv_pool + :noindex: + +glu +--- + +.. autofunction:: paddle.fluid.nets.glu + :noindex: + +scaled_dot_product_attention +---------------------------- + +.. autofunction:: paddle.fluid.nets.scaled_dot_product_attention + :noindex: + diff --git a/source/api_reference/optimizer.rst b/source/api_reference/optimizer.rst deleted file mode 120000 index 2e3479f6d..000000000 --- a/source/api_reference/optimizer.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/optimizer.rst \ No newline at end of file diff --git a/source/api_reference/optimizer.rst b/source/api_reference/optimizer.rst new file mode 100644 index 000000000..6ad44bb69 --- /dev/null +++ b/source/api_reference/optimizer.rst @@ -0,0 +1,119 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +========= +optimizer +========= + +SGD +--- + +.. autoclass:: paddle.fluid.optimizer.SGD + :members: + :noindex: + +Momentum +-------- + +.. autoclass:: paddle.fluid.optimizer.Momentum + :members: + :noindex: + +Adagrad +------- + +.. autoclass:: paddle.fluid.optimizer.Adagrad + :members: + :noindex: + +Adam +---- + +.. autoclass:: paddle.fluid.optimizer.Adam + :members: + :noindex: + +Adamax +------ + +.. autoclass:: paddle.fluid.optimizer.Adamax + :members: + :noindex: + +DecayedAdagrad +-------------- + +.. autoclass:: paddle.fluid.optimizer.DecayedAdagrad + :members: + :noindex: + +SGDOptimizer +------------ + +.. autoclass:: paddle.fluid.optimizer.SGDOptimizer + :members: + :noindex: + +MomentumOptimizer +----------------- + +.. autoclass:: paddle.fluid.optimizer.MomentumOptimizer + :members: + :noindex: + +AdagradOptimizer +---------------- + +.. autoclass:: paddle.fluid.optimizer.AdagradOptimizer + :members: + :noindex: + +AdamOptimizer +------------- + +.. autoclass:: paddle.fluid.optimizer.AdamOptimizer + :members: + :noindex: + +AdamaxOptimizer +--------------- + +.. autoclass:: paddle.fluid.optimizer.AdamaxOptimizer + :members: + :noindex: + +DecayedAdagradOptimizer +----------------------- + +.. autoclass:: paddle.fluid.optimizer.DecayedAdagradOptimizer + :members: + :noindex: + +RMSPropOptimizer +---------------- + +.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer + :members: + :noindex: + +Adadelta +-------- + +.. autoclass:: paddle.fluid.optimizer.Adadelta + :members: + :noindex: + +ModelAverage +------------ + +.. autoclass:: paddle.fluid.optimizer.ModelAverage + :members: + :noindex: + +Optimizer +--------- + +.. autoclass:: paddle.fluid.optimizer.Optimizer + :members: + :noindex: + diff --git a/source/api_reference/param_attr.rst b/source/api_reference/param_attr.rst deleted file mode 120000 index cf306cc4b..000000000 --- a/source/api_reference/param_attr.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/param_attr.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 100644 index 000000000..8e4ddb2b0 --- /dev/null +++ b/source/api_reference/param_attr.rst @@ -0,0 +1,21 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +========== +param_attr +========== + +ParamAttr +--------- + +.. autoclass:: paddle.fluid.param_attr.ParamAttr + :members: + :noindex: + +WeightNormParamAttr +------------------- + +.. autoclass:: paddle.fluid.param_attr.WeightNormParamAttr + :members: + :noindex: + diff --git a/source/api_reference/profiler.rst b/source/api_reference/profiler.rst deleted file mode 120000 index f62983a99..000000000 --- a/source/api_reference/profiler.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/profiler.rst \ No newline at end of file diff --git a/source/api_reference/profiler.rst b/source/api_reference/profiler.rst new file mode 100644 index 000000000..39fda6586 --- /dev/null +++ b/source/api_reference/profiler.rst @@ -0,0 +1,37 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +======== +profiler +======== + +cuda_profiler +------------- + +.. autofunction:: paddle.fluid.profiler.cuda_profiler + :noindex: + +reset_profiler +-------------- + +.. autofunction:: paddle.fluid.profiler.reset_profiler + :noindex: + +profiler +-------- + +.. autofunction:: paddle.fluid.profiler.profiler + :noindex: + +start_profiler +-------------- + +.. autofunction:: paddle.fluid.profiler.start_profiler + :noindex: + +stop_profiler +------------- + +.. autofunction:: paddle.fluid.profiler.stop_profiler + :noindex: + diff --git a/source/api_reference/regularizer.rst b/source/api_reference/regularizer.rst deleted file mode 120000 index d5063d766..000000000 --- a/source/api_reference/regularizer.rst +++ /dev/null @@ -1 +0,0 @@ -../../paddle/doc/fluid/api/regularizer.rst \ No newline at end of file diff --git a/source/api_reference/regularizer.rst b/source/api_reference/regularizer.rst new file mode 100644 index 000000000..756bc53ba --- /dev/null +++ b/source/api_reference/regularizer.rst @@ -0,0 +1,48 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +=========== +regularizer +=========== + +append_regularization_ops +------------------------- + +.. autofunction:: paddle.fluid.regularizer.append_regularization_ops + :noindex: + +WeightDecayRegularizer +---------------------- + +.. autoclass:: paddle.fluid.regularizer.WeightDecayRegularizer + :members: + :noindex: + +L1Decay +------- + +.. autoclass:: paddle.fluid.regularizer.L1Decay + :members: + :noindex: + +L2Decay +------- + +.. autoclass:: paddle.fluid.regularizer.L2Decay + :members: + :noindex: + +L1DecayRegularizer +------------------ + +.. autoclass:: paddle.fluid.regularizer.L1DecayRegularizer + :members: + :noindex: + +L2DecayRegularizer +------------------ + +.. autoclass:: paddle.fluid.regularizer.L2DecayRegularizer + :members: + :noindex: + diff --git a/source/conf.py b/source/conf.py index 8dccb0bb2..b5f5bfa95 100644 --- a/source/conf.py +++ b/source/conf.py @@ -18,6 +18,7 @@ import shlex from recommonmark.parser import CommonMarkParser from recommonmark.transform import AutoStructify import paddle.fluid +import sphinx.ext.napoleon # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -38,6 +39,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.todo', 'sphinx_markdown_tables', + 'sphinx.ext.napoleon', ] # Add any paths that contain templates here, relative to this directory. -- GitLab