Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into rename_rpc_ops
typhoonzero
7 years ago
commit
4d12a81306
@ -1,9 +1,14 @@
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
===========
|
||||
DataFeeder
|
||||
data_feeder
|
||||
===========
|
||||
|
||||
DataFeeder
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.data_feeder
|
||||
:members: DataFeeder
|
||||
----------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.data_feeder.DataFeeder
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,9 +1,21 @@
|
||||
===========
|
||||
Evaluator
|
||||
===========
|
||||
|
||||
Evaluator
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.evaluator
|
||||
:members: Evaluator
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
=========
|
||||
evaluator
|
||||
=========
|
||||
|
||||
Accuracy
|
||||
--------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.evaluator.Accuracy
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
ChunkEvaluator
|
||||
--------------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.evaluator.ChunkEvaluator
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,9 +1,32 @@
|
||||
===========
|
||||
Executor
|
||||
===========
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
========
|
||||
executor
|
||||
========
|
||||
|
||||
Executor
|
||||
--------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.executor.Executor
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
global_scope
|
||||
------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.executor.global_scope
|
||||
:noindex:
|
||||
|
||||
scope_guard
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.executor
|
||||
:members: Executor
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.executor.scope_guard
|
||||
:noindex:
|
||||
|
||||
switch_scope
|
||||
------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.executor.switch_scope
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -0,0 +1,109 @@
|
||||
# Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from __future__ import print_function
|
||||
import argparse
|
||||
import sys
|
||||
import types
|
||||
|
||||
import paddle.v2.fluid as fluid
|
||||
|
||||
|
||||
def parse_arg():
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('--submodules', nargs="*")
|
||||
parser.add_argument(
|
||||
'module', type=str, help='Generate the documentation of which module')
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
class DocGenerator(object):
|
||||
def __init__(self, module_name, stream=sys.stdout):
|
||||
self.stream = stream
|
||||
self.module_name = module_name
|
||||
if not hasattr(fluid, module_name):
|
||||
raise ValueError("Cannot find fluid.{0}".format(module_name))
|
||||
else:
|
||||
self.module = getattr(fluid, module_name)
|
||||
self.stream.write('''.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
''')
|
||||
|
||||
self._print_header_(module_name, dot='=', is_title=True)
|
||||
|
||||
def print_submodule(self, submodule_name):
|
||||
submodule = getattr(self.module, submodule_name)
|
||||
if submodule is None:
|
||||
raise ValueError("Cannot find submodule {0}".format(submodule_name))
|
||||
self.print_section(submodule_name)
|
||||
|
||||
for item in submodule.__all__:
|
||||
self.print_item(item)
|
||||
|
||||
def print_current_module(self):
|
||||
for item in self.module.__all__:
|
||||
self.print_item(item)
|
||||
|
||||
def print_section(self, name):
|
||||
self._print_header_(name, dot='=', is_title=False)
|
||||
|
||||
def print_item(self, name):
|
||||
item = getattr(self.module, name)
|
||||
if isinstance(item, types.TypeType):
|
||||
self.print_class(name)
|
||||
elif isinstance(item, types.FunctionType):
|
||||
self.print_method(name)
|
||||
else:
|
||||
raise RuntimeError("Unsupported item {0}".format(name))
|
||||
|
||||
def print_class(self, name):
|
||||
self._print_header_(name, dot='-', is_title=False)
|
||||
self.stream.write('''.. autoclass:: paddle.v2.fluid.{0}.{1}
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
'''.format(self.module_name, name))
|
||||
|
||||
def print_method(self, name):
|
||||
self._print_header_(name, dot='-', is_title=False)
|
||||
self.stream.write('''.. autofunction:: paddle.v2.fluid.{0}.{1}
|
||||
:noindex:
|
||||
|
||||
'''.format(self.module_name, name))
|
||||
|
||||
def _print_header_(self, name, dot, is_title):
|
||||
dot_line = dot * len(name)
|
||||
if is_title:
|
||||
self.stream.write(dot_line)
|
||||
self.stream.write('\n')
|
||||
self.stream.write(name)
|
||||
self.stream.write('\n')
|
||||
self.stream.write(dot_line)
|
||||
self.stream.write('\n')
|
||||
self.stream.write('\n')
|
||||
|
||||
|
||||
def main():
|
||||
args = parse_arg()
|
||||
gen = DocGenerator(args.module)
|
||||
if args.submodules is None:
|
||||
gen.print_current_module()
|
||||
else:
|
||||
for submodule_name in args.submodules:
|
||||
gen.print_submodule(submodule_name)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,7 @@
|
||||
#!/bin/bash
|
||||
python gen_doc.py layers --submodules control_flow device io nn ops tensor > layers.rst
|
||||
|
||||
for module in io data_feeder evaluator executor initializer io nets optimizer param_attr profiler regularizer
|
||||
do
|
||||
python gen_doc.py ${module} > ${module}.rst
|
||||
done
|
||||
@ -1,50 +1,35 @@
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
===========
|
||||
Initializer
|
||||
initializer
|
||||
===========
|
||||
|
||||
Constant
|
||||
--------
|
||||
|
||||
|
||||
Initializer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: Initializer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
ConstantInitializer
|
||||
-------------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: ConstantInitializer
|
||||
.. autoclass:: paddle.v2.fluid.initializer.Constant
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Uniform
|
||||
-------
|
||||
|
||||
|
||||
UniformInitializer
|
||||
------------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: UniformInitializer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
NormalInitializer
|
||||
-----------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: NormalInitializer
|
||||
.. autoclass:: paddle.v2.fluid.initializer.Uniform
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Normal
|
||||
------
|
||||
|
||||
XavierInitializer
|
||||
-----------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: XavierInitializer
|
||||
.. autoclass:: paddle.v2.fluid.initializer.Normal
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Xavier
|
||||
------
|
||||
|
||||
MSRAInitializer
|
||||
---------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: MSRAInitializer
|
||||
.. autoclass:: paddle.v2.fluid.initializer.Xavier
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,10 +1,61 @@
|
||||
===========
|
||||
IO
|
||||
===========
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
==
|
||||
io
|
||||
==
|
||||
|
||||
save_vars
|
||||
---------
|
||||
|
||||
is_parameter
|
||||
.. autofunction:: paddle.v2.fluid.io.save_vars
|
||||
:noindex:
|
||||
|
||||
save_params
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.io.is_parameter
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.save_params
|
||||
:noindex:
|
||||
|
||||
save_persistables
|
||||
-----------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.save_persistables
|
||||
:noindex:
|
||||
|
||||
load_vars
|
||||
---------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.load_vars
|
||||
:noindex:
|
||||
|
||||
load_params
|
||||
-----------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.load_params
|
||||
:noindex:
|
||||
|
||||
load_persistables
|
||||
-----------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.load_persistables
|
||||
:noindex:
|
||||
|
||||
save_inference_model
|
||||
--------------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.save_inference_model
|
||||
:noindex:
|
||||
|
||||
load_inference_model
|
||||
--------------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.load_inference_model
|
||||
:noindex:
|
||||
|
||||
get_inference_program
|
||||
---------------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.io.get_inference_program
|
||||
:noindex:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,33 +1,31 @@
|
||||
===========
|
||||
Nets
|
||||
===========
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
====
|
||||
nets
|
||||
====
|
||||
|
||||
simple_img_conv_pool
|
||||
--------------------
|
||||
.. autofunction:: paddle.v2.fluid.nets.simple_img_conv_pool
|
||||
:noindex:
|
||||
|
||||
|
||||
img_conv_group
|
||||
---------------
|
||||
.. autofunction:: paddle.v2.fluid.nets.img_conv_group
|
||||
.. autofunction:: paddle.v2.fluid.nets.simple_img_conv_pool
|
||||
:noindex:
|
||||
|
||||
|
||||
sequence_conv_pool
|
||||
------------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.nets.sequence_conv_pool
|
||||
:noindex:
|
||||
|
||||
|
||||
glu
|
||||
---
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.nets.glu
|
||||
:noindex:
|
||||
|
||||
|
||||
scaled_dot_product_attention
|
||||
----------------------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.nets.scaled_dot_product_attention
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,54 +1,49 @@
|
||||
===========
|
||||
Optimizer
|
||||
===========
|
||||
|
||||
Optimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: Optimizer
|
||||
:noindex:
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
=========
|
||||
optimizer
|
||||
=========
|
||||
|
||||
SGDOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: SGDOptimizer
|
||||
:noindex:
|
||||
SGD
|
||||
---
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.SGD
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Momentum
|
||||
--------
|
||||
|
||||
MomentumOptimizer
|
||||
-----------------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: MomentumOptimizer
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.Momentum
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Adagrad
|
||||
-------
|
||||
|
||||
|
||||
AdagradOptimizer
|
||||
----------------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdagradOptimizer
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.Adagrad
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Adam
|
||||
----
|
||||
|
||||
AdamOptimizer
|
||||
-------------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdamOptimizer
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.Adam
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
Adamax
|
||||
------
|
||||
|
||||
AdamaxOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdamaxOptimizer
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.Adamax
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
DecayedAdagrad
|
||||
--------------
|
||||
|
||||
DecayedAdagradOptimizer
|
||||
-----------------------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: DecayedAdagradOptimizer
|
||||
.. autoclass:: paddle.v2.fluid.optimizer.DecayedAdagrad
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,11 +1,21 @@
|
||||
===========
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
==========
|
||||
param_attr
|
||||
==========
|
||||
|
||||
ParamAttr
|
||||
===========
|
||||
---------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.param_attr.ParamAttr
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
WeightNormParamAttr
|
||||
-------------------
|
||||
|
||||
ParamAttr
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.param_attr
|
||||
:members: ParamAttr
|
||||
.. autoclass:: paddle.v2.fluid.param_attr.WeightNormParamAttr
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,10 +1,25 @@
|
||||
===========
|
||||
Profiler
|
||||
===========
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
========
|
||||
profiler
|
||||
========
|
||||
|
||||
cuda_profiler
|
||||
-------------
|
||||
|
||||
Profiler
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.profiler.cuda_profiler
|
||||
:noindex:
|
||||
|
||||
reset_profiler
|
||||
--------------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.profiler.reset_profiler
|
||||
:noindex:
|
||||
|
||||
profiler
|
||||
--------
|
||||
|
||||
.. autofunction:: paddle.v2.fluid.profiler.profiler
|
||||
:noindex:
|
||||
|
||||
|
||||
@ -1,25 +1,27 @@
|
||||
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
|
||||
!DO NOT EDIT THIS FILE MANUALLY!
|
||||
|
||||
===========
|
||||
Regularizer
|
||||
regularizer
|
||||
===========
|
||||
|
||||
WeightDecayRegularizer
|
||||
----------------------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: WeightDecayRegularizer
|
||||
:noindex:
|
||||
|
||||
append_regularization_ops
|
||||
-------------------------
|
||||
|
||||
L2DecayRegularizer
|
||||
------------------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: L2DecayRegularizer
|
||||
.. autofunction:: paddle.v2.fluid.regularizer.append_regularization_ops
|
||||
:noindex:
|
||||
|
||||
L1Decay
|
||||
-------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.regularizer.L1Decay
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
L1DecayRegularizer
|
||||
-------------------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: L1DecayRegularizer
|
||||
L2Decay
|
||||
-------
|
||||
|
||||
.. autoclass:: paddle.v2.fluid.regularizer.L2Decay
|
||||
:members:
|
||||
:noindex:
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 464 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue