Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some problems in api reference #11491

Merged
merged 15 commits into from
Jun 15, 2018
2 changes: 1 addition & 1 deletion doc/fluid/api/gen_doc.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
python gen_doc.py layers --submodules control_flow device io nn ops tensor detection learning_rate_scheduler > layers.rst
python gen_doc.py layers --submodules control_flow device io nn ops tensor detection learning_rate_scheduler metric > layers.rst

for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer
do
Expand Down
14 changes: 14 additions & 0 deletions doc/fluid/api/initializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ Xavier
:members:
:noindex:

Bilinear
--------

.. autoclass:: paddle.fluid.initializer.Bilinear
:members:
:noindex:

force_init_on_cpu
-----------------

Expand Down Expand Up @@ -73,3 +80,10 @@ XavierInitializer
:members:
:noindex:

BilinearInitializer
-------------------

.. autoclass:: paddle.fluid.initializer.BilinearInitializer
:members:
:noindex:

36 changes: 36 additions & 0 deletions doc/fluid/api/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,39 @@ 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:

load_persist_vars_without_grad
------------------------------

.. autofunction:: paddle.fluid.io.load_persist_vars_without_grad
:noindex:

save_persist_vars_without_grad
------------------------------

.. autofunction:: paddle.fluid.io.save_persist_vars_without_grad
:noindex:

get_latest_checkpoint_serial
----------------------------

.. autofunction:: paddle.fluid.io.get_latest_checkpoint_serial
:noindex:

181 changes: 155 additions & 26 deletions doc/fluid/api/layers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,12 @@ Print
.. autofunction:: paddle.fluid.layers.Print
:noindex:

is_empty
--------

.. autofunction:: paddle.fluid.layers.is_empty
:noindex:

device
======

Expand Down Expand Up @@ -219,6 +225,12 @@ Send
.. autofunction:: paddle.fluid.layers.Send
:noindex:

Recv
----

.. autofunction:: paddle.fluid.layers.Recv
:noindex:

open_recordio_file
------------------

Expand Down Expand Up @@ -255,6 +267,25 @@ 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
==

Expand Down Expand Up @@ -399,10 +430,9 @@ conv2d_transpose
conv3d_transpose
----------------

.. autofunction:: paddle.fluid.layers.conv2d_transpose
.. autofunction:: paddle.fluid.layers.conv3d_transpose
:noindex:


sequence_expand
---------------

Expand Down Expand Up @@ -613,6 +643,48 @@ 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:

mean_iou
--------

.. autofunction:: paddle.fluid.layers.mean_iou
:noindex:

ops
===

Expand Down Expand Up @@ -718,12 +790,6 @@ logical_not
.. autofunction:: paddle.fluid.layers.logical_not
:noindex:

uniform_random
--------------

.. autofunction:: paddle.fluid.layers.uniform_random
:noindex:

uniform_random_batch_size_like
------------------------------

Expand All @@ -742,12 +808,6 @@ gaussian_random_batch_size_like
.. autofunction:: paddle.fluid.layers.gaussian_random_batch_size_like
:noindex:

cumsum
------

.. autofunction:: paddle.fluid.layers.cumsum
:noindex:

scatter
-------

Expand All @@ -760,6 +820,30 @@ sum
.. autofunction:: paddle.fluid.layers.sum
:noindex:

slice
-----

.. autofunction:: paddle.fluid.layers.slice
:noindex:

polygon_box_transform
---------------------

.. autofunction:: paddle.fluid.layers.polygon_box_transform
:noindex:

shape
-----

.. autofunction:: paddle.fluid.layers.shape
:noindex:

maxout
------

.. autofunction:: paddle.fluid.layers.maxout
:noindex:

sigmoid
-------

Expand Down Expand Up @@ -916,18 +1000,6 @@ 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
------------

Expand All @@ -940,6 +1012,30 @@ swish
.. autofunction:: paddle.fluid.layers.swish
:noindex:

uniform_random
--------------

.. autofunction:: paddle.fluid.layers.uniform_random
:noindex:

hard_shrink
-----------

.. autofunction:: paddle.fluid.layers.hard_shrink
:noindex:

cumsum
------

.. autofunction:: paddle.fluid.layers.cumsum
:noindex:

thresholded_relu
----------------

.. autofunction:: paddle.fluid.layers.thresholded_relu
:noindex:

tensor
======

Expand Down Expand Up @@ -997,6 +1093,18 @@ fill_constant
.. autofunction:: paddle.fluid.layers.fill_constant
:noindex:

argmin
------

.. autofunction:: paddle.fluid.layers.argmin
:noindex:

argmax
------

.. autofunction:: paddle.fluid.layers.argmax
:noindex:

ones
----

Expand All @@ -1012,6 +1120,12 @@ zeros
detection
=========

prior_box
---------

.. autofunction:: paddle.fluid.layers.prior_box
:noindex:

multi_box_head
--------------

Expand Down Expand Up @@ -1099,3 +1213,18 @@ noam_decay
.. autofunction:: paddle.fluid.layers.noam_decay
:noindex:

metric
======

accuracy
--------

.. autofunction:: paddle.fluid.layers.accuracy
:noindex:

auc
---

.. autofunction:: paddle.fluid.layers.auc
:noindex:

7 changes: 7 additions & 0 deletions doc/fluid/api/optimizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ DecayedAdagradOptimizer
:members:
:noindex:

RMSPropOptimizer
----------------

.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
:members:
:noindex:

Adadelta
--------

Expand Down
12 changes: 12 additions & 0 deletions doc/fluid/api/profiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,15 @@ 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:

Loading