未验证 提交 d16c5caf 编写于 作者: S Shan Yi 提交者: GitHub

Merge pull request #60 from tink2123/api_doc

update develop api_doc according paddle repo
...@@ -13,11 +13,3 @@ append_backward ...@@ -13,11 +13,3 @@ append_backward
.. autofunction:: paddle.fluid.backward.append_backward .. autofunction:: paddle.fluid.backward.append_backward
:noindex: :noindex:
.. _api_fluid_backward_calc_gradient:
calc_gradient
-------------
.. autofunction:: paddle.fluid.backward.calc_gradient
:noindex:
...@@ -5,24 +5,6 @@ ...@@ -5,24 +5,6 @@
fluid fluid
===== =====
.. _api_fluid_Block:
Block
-----
.. autoclass:: paddle.fluid.Block
:members:
:noindex:
.. _api_fluid_Variable:
Variable
--------
.. autoclass:: paddle.fluid.Variable
:members:
:noindex:
.. _api_fluid_Program: .. _api_fluid_Program:
Program Program
...@@ -41,6 +23,15 @@ Operator ...@@ -41,6 +23,15 @@ Operator
:members: :members:
:noindex: :noindex:
.. _api_fluid_Parameter:
Parameter
---------
.. autoclass:: paddle.fluid.Parameter
:members:
:noindex:
.. _api_fluid_default_startup_program: .. _api_fluid_default_startup_program:
default_startup_program default_startup_program
...@@ -106,48 +97,6 @@ _switch_scope ...@@ -106,48 +97,6 @@ _switch_scope
.. autofunction:: paddle.fluid._switch_scope .. autofunction:: paddle.fluid._switch_scope
:noindex: :noindex:
.. _api_fluid_make_channel:
make_channel
------------
.. autofunction:: paddle.fluid.make_channel
:noindex:
.. _api_fluid_channel_send:
channel_send
------------
.. autofunction:: paddle.fluid.channel_send
:noindex:
.. _api_fluid_channel_recv:
channel_recv
------------
.. autofunction:: paddle.fluid.channel_recv
:noindex:
.. _api_fluid_channel_close:
channel_close
-------------
.. autofunction:: paddle.fluid.channel_close
:noindex:
.. _api_fluid_Select:
Select
------
.. autoclass:: paddle.fluid.Select
:members:
:noindex:
.. _api_fluid_Trainer: .. _api_fluid_Trainer:
Trainer Trainer
...@@ -220,6 +169,15 @@ DistributeTranspiler ...@@ -220,6 +169,15 @@ DistributeTranspiler
:members: :members:
:noindex: :noindex:
.. _api_fluid_InferenceTranspiler:
InferenceTranspiler
-------------------
.. autoclass:: paddle.fluid.InferenceTranspiler
:members:
:noindex:
.. _api_fluid_memory_optimize: .. _api_fluid_memory_optimize:
memory_optimize memory_optimize
...@@ -236,6 +194,15 @@ release_memory ...@@ -236,6 +194,15 @@ release_memory
.. autofunction:: paddle.fluid.release_memory .. autofunction:: paddle.fluid.release_memory
:noindex: :noindex:
.. _api_fluid_DistributeTranspilerConfig:
DistributeTranspilerConfig
--------------------------
.. autoclass:: paddle.fluid.DistributeTranspilerConfig
:members:
:noindex:
.. _api_fluid_ParallelExecutor: .. _api_fluid_ParallelExecutor:
ParallelExecutor ParallelExecutor
...@@ -288,6 +255,15 @@ LoDTensor ...@@ -288,6 +255,15 @@ LoDTensor
:members: :members:
:noindex: :noindex:
.. _api_fluid_LoDTensorArray:
LoDTensorArray
--------------
.. autoclass:: paddle.fluid.LoDTensorArray
:members:
:noindex:
.. _api_fluid_CPUPlace: .. _api_fluid_CPUPlace:
CPUPlace CPUPlace
......
...@@ -77,51 +77,3 @@ get_inference_program ...@@ -77,51 +77,3 @@ get_inference_program
.. autofunction:: paddle.fluid.io.get_inference_program .. autofunction:: paddle.fluid.io.get_inference_program
:noindex: :noindex:
.. _api_fluid_io_save_checkpoint:
save_checkpoint
---------------
.. autofunction:: paddle.fluid.io.save_checkpoint
:noindex:
.. _api_fluid_io_load_checkpoint:
load_checkpoint
---------------
.. autofunction:: paddle.fluid.io.load_checkpoint
:noindex:
.. _api_fluid_io_clean_checkpoint:
clean_checkpoint
----------------
.. autofunction:: paddle.fluid.io.clean_checkpoint
:noindex:
.. _api_fluid_io_load_persist_vars_without_grad:
load_persist_vars_without_grad
------------------------------
.. autofunction:: paddle.fluid.io.load_persist_vars_without_grad
:noindex:
.. _api_fluid_io_save_persist_vars_without_grad:
save_persist_vars_without_grad
------------------------------
.. autofunction:: paddle.fluid.io.save_persist_vars_without_grad
:noindex:
.. _api_fluid_io_get_latest_checkpoint_serial:
get_latest_checkpoint_serial
----------------------------
.. autofunction:: paddle.fluid.io.get_latest_checkpoint_serial
:noindex:
...@@ -8,49 +8,6 @@ fluid.layers ...@@ -8,49 +8,6 @@ fluid.layers
control_flow control_flow
============ ============
.. _api_fluid_layers_split_lod_tensor:
split_lod_tensor
----------------
.. autofunction:: paddle.fluid.layers.split_lod_tensor
:noindex:
.. _api_fluid_layers_merge_lod_tensor:
merge_lod_tensor
----------------
.. autofunction:: paddle.fluid.layers.merge_lod_tensor
:noindex:
.. _api_fluid_layers_BlockGuard:
BlockGuard
----------
.. autoclass:: paddle.fluid.layers.BlockGuard
:members:
:noindex:
.. _api_fluid_layers_BlockGuardWithCompletion:
BlockGuardWithCompletion
------------------------
.. autoclass:: paddle.fluid.layers.BlockGuardWithCompletion
:members:
:noindex:
.. _api_fluid_layers_WhileGuard:
WhileGuard
----------
.. autoclass:: paddle.fluid.layers.WhileGuard
:members:
:noindex:
.. _api_fluid_layers_While: .. _api_fluid_layers_While:
While While
...@@ -69,38 +26,6 @@ Switch ...@@ -69,38 +26,6 @@ Switch
:members: :members:
:noindex: :noindex:
.. _api_fluid_layers_lod_rank_table:
lod_rank_table
--------------
.. autofunction:: paddle.fluid.layers.lod_rank_table
:noindex:
.. _api_fluid_layers_max_sequence_len:
max_sequence_len
----------------
.. autofunction:: paddle.fluid.layers.max_sequence_len
:noindex:
.. _api_fluid_layers_lod_tensor_to_array:
lod_tensor_to_array
-------------------
.. autofunction:: paddle.fluid.layers.lod_tensor_to_array
:noindex:
.. _api_fluid_layers_array_to_lod_tensor:
array_to_lod_tensor
-------------------
.. autofunction:: paddle.fluid.layers.array_to_lod_tensor
:noindex:
.. _api_fluid_layers_increment: .. _api_fluid_layers_increment:
increment increment
...@@ -149,14 +74,6 @@ array_read ...@@ -149,14 +74,6 @@ array_read
.. autofunction:: paddle.fluid.layers.array_read .. autofunction:: paddle.fluid.layers.array_read
:noindex: :noindex:
.. _api_fluid_layers_shrink_memory:
shrink_memory
-------------
.. autofunction:: paddle.fluid.layers.shrink_memory
:noindex:
.. _api_fluid_layers_array_length: .. _api_fluid_layers_array_length:
array_length array_length
...@@ -183,15 +100,6 @@ DynamicRNN ...@@ -183,15 +100,6 @@ DynamicRNN
:members: :members:
:noindex: :noindex:
.. _api_fluid_layers_ConditionalBlock:
ConditionalBlock
----------------
.. autoclass:: paddle.fluid.layers.ConditionalBlock
:members:
:noindex:
.. _api_fluid_layers_StaticRNN: .. _api_fluid_layers_StaticRNN:
StaticRNN StaticRNN
...@@ -237,14 +145,6 @@ is_empty ...@@ -237,14 +145,6 @@ is_empty
device device
====== ======
.. _api_fluid_layers_get_places:
get_places
----------
.. autofunction:: paddle.fluid.layers.get_places
:noindex:
io io
== ==
...@@ -256,40 +156,6 @@ data ...@@ -256,40 +156,6 @@ data
.. autofunction:: paddle.fluid.layers.data .. autofunction:: paddle.fluid.layers.data
:noindex: :noindex:
.. _api_fluid_layers_BlockGuardServ:
BlockGuardServ
--------------
.. autoclass:: paddle.fluid.layers.BlockGuardServ
:members:
:noindex:
.. _api_fluid_layers_ListenAndServ:
ListenAndServ
-------------
.. autoclass:: paddle.fluid.layers.ListenAndServ
:members:
:noindex:
.. _api_fluid_layers_Send:
Send
----
.. autofunction:: paddle.fluid.layers.Send
:noindex:
.. _api_fluid_layers_Recv:
Recv
----
.. autofunction:: paddle.fluid.layers.Recv
:noindex:
.. _api_fluid_layers_open_recordio_file: .. _api_fluid_layers_open_recordio_file:
open_recordio_file open_recordio_file
...@@ -346,6 +212,14 @@ random_data_generator ...@@ -346,6 +212,14 @@ random_data_generator
.. autofunction:: paddle.fluid.layers.random_data_generator .. autofunction:: paddle.fluid.layers.random_data_generator
:noindex: :noindex:
.. _api_fluid_layers_py_reader:
py_reader
---------
.. autofunction:: paddle.fluid.layers.py_reader
:noindex:
.. _api_fluid_layers_Preprocessor: .. _api_fluid_layers_Preprocessor:
Preprocessor Preprocessor
...@@ -566,6 +440,14 @@ sequence_expand ...@@ -566,6 +440,14 @@ sequence_expand
.. autofunction:: paddle.fluid.layers.sequence_expand .. autofunction:: paddle.fluid.layers.sequence_expand
:noindex: :noindex:
.. _api_fluid_layers_sequence_pad:
sequence_pad
------------
.. autofunction:: paddle.fluid.layers.sequence_pad
:noindex:
.. _api_fluid_layers_lstm_unit: .. _api_fluid_layers_lstm_unit:
lstm_unit lstm_unit
...@@ -726,6 +608,14 @@ nce ...@@ -726,6 +608,14 @@ nce
.. autofunction:: paddle.fluid.layers.nce .. autofunction:: paddle.fluid.layers.nce
:noindex: :noindex:
.. _api_fluid_layers_hsigmoid:
hsigmoid
--------
.. autofunction:: paddle.fluid.layers.hsigmoid
:noindex:
.. _api_fluid_layers_beam_search: .. _api_fluid_layers_beam_search:
beam_search beam_search
...@@ -918,6 +808,30 @@ crop ...@@ -918,6 +808,30 @@ crop
.. autofunction:: paddle.fluid.layers.crop .. autofunction:: paddle.fluid.layers.crop
:noindex: :noindex:
.. _api_fluid_layers_rank_loss:
rank_loss
---------
.. autofunction:: paddle.fluid.layers.rank_loss
:noindex:
.. _api_fluid_layers_prelu:
prelu
-----
.. autofunction:: paddle.fluid.layers.prelu
:noindex:
.. _api_fluid_layers_flatten:
flatten
-------
.. autofunction:: paddle.fluid.layers.flatten
:noindex:
ops ops
=== ===
...@@ -1105,14 +1019,6 @@ slice ...@@ -1105,14 +1019,6 @@ slice
.. autofunction:: paddle.fluid.layers.slice .. autofunction:: paddle.fluid.layers.slice
:noindex: :noindex:
.. _api_fluid_layers_polygon_box_transform:
polygon_box_transform
---------------------
.. autofunction:: paddle.fluid.layers.polygon_box_transform
:noindex:
.. _api_fluid_layers_shape: .. _api_fluid_layers_shape:
shape shape
...@@ -1121,14 +1027,6 @@ shape ...@@ -1121,14 +1027,6 @@ shape
.. autofunction:: paddle.fluid.layers.shape .. autofunction:: paddle.fluid.layers.shape
:noindex: :noindex:
.. _api_fluid_layers_iou_similarity:
iou_similarity
--------------
.. autofunction:: paddle.fluid.layers.iou_similarity
:noindex:
.. _api_fluid_layers_maxout: .. _api_fluid_layers_maxout:
maxout maxout
...@@ -1618,6 +1516,22 @@ detection_map ...@@ -1618,6 +1516,22 @@ detection_map
.. autofunction:: paddle.fluid.layers.detection_map .. autofunction:: paddle.fluid.layers.detection_map
:noindex: :noindex:
.. _api_fluid_layers_rpn_target_assign:
rpn_target_assign
-----------------
.. autofunction:: paddle.fluid.layers.rpn_target_assign
:noindex:
.. _api_fluid_layers_anchor_generator:
anchor_generator
----------------
.. autofunction:: paddle.fluid.layers.anchor_generator
:noindex:
.. _api_fluid_layers_iou_similarity: .. _api_fluid_layers_iou_similarity:
iou_similarity iou_similarity
...@@ -1634,6 +1548,14 @@ box_coder ...@@ -1634,6 +1548,14 @@ box_coder
.. autofunction:: paddle.fluid.layers.box_coder .. autofunction:: paddle.fluid.layers.box_coder
:noindex: :noindex:
.. _api_fluid_layers_polygon_box_transform:
polygon_box_transform
---------------------
.. autofunction:: paddle.fluid.layers.polygon_box_transform
:noindex:
metric_op metric_op
========= =========
...@@ -1744,6 +1666,14 @@ argmax ...@@ -1744,6 +1666,14 @@ argmax
.. autofunction:: paddle.fluid.layers.argmax .. autofunction:: paddle.fluid.layers.argmax
:noindex: :noindex:
.. _api_fluid_layers_argsort:
argsort
-------
.. autofunction:: paddle.fluid.layers.argsort
:noindex:
.. _api_fluid_layers_ones: .. _api_fluid_layers_ones:
ones ones
...@@ -1768,11 +1698,3 @@ reverse ...@@ -1768,11 +1698,3 @@ reverse
.. autofunction:: paddle.fluid.layers.reverse .. autofunction:: paddle.fluid.layers.reverse
:noindex: :noindex:
.. _api_fluid_layers_rank_loss:
rank_loss
-------
.. autofunction:: paddle.fluid.layers.rank_loss
:noindex:
...@@ -158,15 +158,6 @@ ModelAverage ...@@ -158,15 +158,6 @@ ModelAverage
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Optimizer:
Optimizer
---------
.. autoclass:: paddle.fluid.optimizer.Optimizer
:members:
:noindex:
.. _api_fluid_optimizer_RMSPropOptimizer: .. _api_fluid_optimizer_RMSPropOptimizer:
RMSPropOptimizer RMSPropOptimizer
......
...@@ -5,14 +5,6 @@ ...@@ -5,14 +5,6 @@
fluid.regularizer fluid.regularizer
================= =================
.. _api_fluid_regularizer_append_regularization_ops:
append_regularization_ops
-------------------------
.. autofunction:: paddle.fluid.regularizer.append_regularization_ops
:noindex:
.. _api_fluid_regularizer_L1Decay: .. _api_fluid_regularizer_L1Decay:
L1Decay L1Decay
......
...@@ -57,3 +57,12 @@ RoundRobin ...@@ -57,3 +57,12 @@ RoundRobin
:members: :members:
:noindex: :noindex:
.. _api_fluid_transpiler_DistributeTranspilerConfig:
DistributeTranspilerConfig
--------------------------
.. autoclass:: paddle.fluid.transpiler.DistributeTranspilerConfig
:members:
:noindex:
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册