Skip to content

P
Paddle

BaiXuePrincess / Paddle
与 Fork 源项目一致

Fork自 PaddlePaddle / Paddle

通知 1
Star 1
Fork 0
P
Paddle
未验证 提交 fac1d477 编写于 作者: Y Yu Yang 提交者： GitHub
浏览文件
操作

Merge pull request #11693 from reyoung/feature/fix_api_gen_py 

Update api.rst (merge to release/0.14.0)
上级 46186ce1 043763ad
展开全部 隐藏空白更改
内联 并排
Showing with 1320 addition and 134 deletion
doc/fluid/api/evaluator.rst → doc/fluid/api/average.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
========= =============
evaluator fluid.average
========= =============
.. _api_fluid_average_WeightedAverage:
WeightedAverage
---------------
.. autoclass:: paddle.fluid.average.WeightedAverage
:members:
:noindex:
doc/fluid/api/backward.rst 0 → 100644
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
==============
fluid.backward
==============
.. _api_fluid_backward_append_backward:
append_backward
---------------
.. autofunction:: paddle.fluid.backward.append_backward
:noindex:
.. _api_fluid_backward_calc_gradient:
calc_gradient
-------------
.. autofunction:: paddle.fluid.backward.calc_gradient
:noindex:
doc/fluid/api/clip.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
==== ==========
clip fluid.clip
==== ==========
.. _api_fluid_clip_ErrorClipByValue:
ErrorClipByValue ErrorClipByValue
---------------- ----------------
...@@ -12,6 +14,8 @@ ErrorClipByValue ...@@ -12,6 +14,8 @@ ErrorClipByValue
:members: :members:
:noindex: :noindex:
.. _api_fluid_clip_GradientClipByValue:
GradientClipByValue GradientClipByValue
------------------- -------------------
...@@ -19,6 +23,8 @@ GradientClipByValue ...@@ -19,6 +23,8 @@ GradientClipByValue
:members: :members:
:noindex: :noindex:
.. _api_fluid_clip_GradientClipByNorm:
GradientClipByNorm GradientClipByNorm
------------------ ------------------
...@@ -26,6 +32,8 @@ GradientClipByNorm ...@@ -26,6 +32,8 @@ GradientClipByNorm
:members: :members:
:noindex: :noindex:
.. _api_fluid_clip_GradientClipByGlobalNorm:
GradientClipByGlobalNorm GradientClipByGlobalNorm
------------------------ ------------------------
...@@ -33,15 +41,3 @@ GradientClipByGlobalNorm ...@@ -33,15 +41,3 @@ GradientClipByGlobalNorm
:members: :members:
:noindex: :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:
doc/fluid/api/data.rst 已删除 100644 → 0
浏览文件 @ 46186ce1
==================================
Data Reader Interface and DataSets
==================================
.. toctree::
:maxdepth: 1
data/data_reader.rst
data/image.rst
data/dataset.rst
doc/fluid/api/data_feeder.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
=========== =================
data_feeder fluid.data_feeder
=========== =================
.. _api_fluid_data_feeder_DataFeeder:
DataFeeder DataFeeder
---------- ----------
......
doc/fluid/api/executor.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
======== ==============
executor fluid.executor
======== ==============
.. _api_fluid_executor_Executor:
Executor Executor
-------- --------
...@@ -12,24 +14,32 @@ Executor ...@@ -12,24 +14,32 @@ Executor
:members: :members:
:noindex: :noindex:
.. _api_fluid_executor_global_scope:
global_scope global_scope
------------ ------------
.. autofunction:: paddle.fluid.executor.global_scope .. autofunction:: paddle.fluid.executor.global_scope
:noindex: :noindex:
.. _api_fluid_executor_scope_guard:
scope_guard scope_guard
----------- -----------
.. autofunction:: paddle.fluid.executor.scope_guard .. autofunction:: paddle.fluid.executor.scope_guard
:noindex: :noindex:
switch_scope .. _api_fluid_executor__switch_scope:
------------
_switch_scope
-------------
.. autofunction:: paddle.fluid.executor.switch_scope .. autofunction:: paddle.fluid.executor._switch_scope
:noindex: :noindex:
.. _api_fluid_executor_fetch_var:
fetch_var fetch_var
--------- ---------
......
doc/fluid/api/fluid.rst 0 → 100644
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
=====
fluid
=====
.. _api_fluid_Block:
Block
-----
.. autoclass:: paddle.fluid.Block
:members:
:noindex:
.. _api_fluid_Variable:
Variable
--------
.. autoclass:: paddle.fluid.Variable
:members:
:noindex:
.. _api_fluid_Program:
Program
-------
.. autoclass:: paddle.fluid.Program
:members:
:noindex:
.. _api_fluid_Operator:
Operator
--------
.. autoclass:: paddle.fluid.Operator
:members:
:noindex:
.. _api_fluid_default_startup_program:
default_startup_program
-----------------------
.. autofunction:: paddle.fluid.default_startup_program
:noindex:
.. _api_fluid_default_main_program:
default_main_program
--------------------
.. autofunction:: paddle.fluid.default_main_program
:noindex:
.. _api_fluid_program_guard:
program_guard
-------------
.. autofunction:: paddle.fluid.program_guard
:noindex:
.. _api_fluid_get_var:
get_var
-------
.. autofunction:: paddle.fluid.get_var
:noindex:
.. _api_fluid_Executor:
Executor
--------
.. autoclass:: paddle.fluid.Executor
:members:
:noindex:
.. _api_fluid_global_scope:
global_scope
------------
.. autofunction:: paddle.fluid.global_scope
:noindex:
.. _api_fluid_scope_guard:
scope_guard
-----------
.. autofunction:: paddle.fluid.scope_guard
:noindex:
.. _api_fluid__switch_scope:
_switch_scope
-------------
.. autofunction:: paddle.fluid._switch_scope
:noindex:
.. _api_fluid_fetch_var:
fetch_var
---------
.. autofunction:: paddle.fluid.fetch_var
:noindex:
.. _api_fluid_Go:
Go
--
.. autoclass:: paddle.fluid.Go
:members:
: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:
Trainer
-------
.. autoclass:: paddle.fluid.Trainer
:members:
:noindex:
.. _api_fluid_BeginEpochEvent:
BeginEpochEvent
---------------
.. autoclass:: paddle.fluid.BeginEpochEvent
:members:
:noindex:
.. _api_fluid_EndEpochEvent:
EndEpochEvent
-------------
.. autoclass:: paddle.fluid.EndEpochEvent
:members:
:noindex:
.. _api_fluid_BeginStepEvent:
BeginStepEvent
--------------
.. autoclass:: paddle.fluid.BeginStepEvent
:members:
:noindex:
.. _api_fluid_EndStepEvent:
EndStepEvent
------------
.. autoclass:: paddle.fluid.EndStepEvent
:members:
:noindex:
.. _api_fluid_CheckpointConfig:
CheckpointConfig
----------------
.. autoclass:: paddle.fluid.CheckpointConfig
:members:
:noindex:
.. _api_fluid_Inferencer:
Inferencer
----------
.. autoclass:: paddle.fluid.Inferencer
:members:
:noindex:
.. _api_fluid_DistributeTranspiler:
DistributeTranspiler
--------------------
.. autoclass:: paddle.fluid.DistributeTranspiler
:members:
:noindex:
.. _api_fluid_memory_optimize:
memory_optimize
---------------
.. autofunction:: paddle.fluid.memory_optimize
:noindex:
.. _api_fluid_release_memory:
release_memory
--------------
.. autofunction:: paddle.fluid.release_memory
:noindex:
.. _api_fluid_ParallelExecutor:
ParallelExecutor
----------------
.. autoclass:: paddle.fluid.ParallelExecutor
:members:
:noindex:
.. _api_fluid_ExecutionStrategy:
ExecutionStrategy
-----------------
.. autoclass:: paddle.fluid.ExecutionStrategy
:members:
:noindex:
.. _api_fluid_BuildStrategy:
BuildStrategy
-------------
.. autoclass:: paddle.fluid.BuildStrategy
:members:
:noindex:
.. _api_fluid_create_lod_tensor:
create_lod_tensor
-----------------
.. autofunction:: paddle.fluid.create_lod_tensor
:noindex:
.. _api_fluid_create_random_int_lodtensor:
create_random_int_lodtensor
---------------------------
.. autofunction:: paddle.fluid.create_random_int_lodtensor
:noindex:
.. _api_fluid_LoDTensor:
LoDTensor
---------
.. autoclass:: paddle.fluid.LoDTensor
:members:
:noindex:
.. _api_fluid_CPUPlace:
CPUPlace
--------
.. autoclass:: paddle.fluid.CPUPlace
:members:
:noindex:
.. _api_fluid_CUDAPlace:
CUDAPlace
---------
.. autoclass:: paddle.fluid.CUDAPlace
:members:
:noindex:
.. _api_fluid_CUDAPinnedPlace:
CUDAPinnedPlace
---------------
.. autoclass:: paddle.fluid.CUDAPinnedPlace
:members:
:noindex:
.. _api_fluid_Tensor:
Tensor
------
.. autoclass:: paddle.fluid.Tensor
:members:
:noindex:
.. _api_fluid_ParamAttr:
ParamAttr
---------
.. autoclass:: paddle.fluid.ParamAttr
:members:
:noindex:
.. _api_fluid_WeightNormParamAttr:
WeightNormParamAttr
-------------------
.. autoclass:: paddle.fluid.WeightNormParamAttr
:members:
:noindex:
.. _api_fluid_DataFeeder:
DataFeeder
----------
.. autoclass:: paddle.fluid.DataFeeder
:members:
:noindex:
.. _api_fluid_Scope:
Scope
-----
.. autoclass:: paddle.fluid.Scope
:members:
:noindex:
doc/fluid/api/gen_doc.py
浏览文件 @ fac1d477
...@@ -29,19 +29,27 @@ def parse_arg(): ...@@ -29,19 +29,27 @@ def parse_arg():
class DocGenerator(object): class DocGenerator(object):
def __init__(self, module_name, stream=sys.stdout): def __init__(self, module_name=None, stream=sys.stdout):
if module_name == "":
module_name = None
self.stream = stream self.stream = stream
self.module_name = module_name if module_name is None:
if not hasattr(fluid, module_name): self.module_name = "fluid"
raise ValueError("Cannot find fluid.{0}".format(module_name))
else: else:
self.module = getattr(fluid, module_name) self.module_name = "fluid." + module_name
if module_name is None:
self.module = fluid
else:
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}` self.stream.write('''.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
''') ''')
self._print_header_(module_name, dot='=', is_title=True) self._print_header_(self.module_name, dot='=', is_title=True)
def print_submodule(self, submodule_name): def print_submodule(self, submodule_name):
submodule = getattr(self.module, submodule_name) submodule = getattr(self.module, submodule_name)
...@@ -60,25 +68,29 @@ class DocGenerator(object): ...@@ -60,25 +68,29 @@ class DocGenerator(object):
self._print_header_(name, dot='=', is_title=False) self._print_header_(name, dot='=', is_title=False)
def print_item(self, name): def print_item(self, name):
item = getattr(self.module, name) item = getattr(self.module, name, None)
if item is None:
return
if isinstance(item, types.TypeType): if isinstance(item, types.TypeType):
self.print_class(name) self.print_class(name)
elif isinstance(item, types.FunctionType): elif isinstance(item, types.FunctionType):
self.print_method(name) self.print_method(name)
else: else:
raise RuntimeError("Unsupported item {0}".format(name)) pass
def print_class(self, name): def print_class(self, name):
self._print_ref_(name)
self._print_header_(name, dot='-', is_title=False) self._print_header_(name, dot='-', is_title=False)
self.stream.write('''.. autoclass:: paddle.fluid.{0}.{1} self.stream.write('''.. autoclass:: paddle.{0}.{1}
:members: :members:
:noindex: :noindex:
'''.format(self.module_name, name)) '''.format(self.module_name, name))
def print_method(self, name): def print_method(self, name):
self._print_ref_(name)
self._print_header_(name, dot='-', is_title=False) self._print_header_(name, dot='-', is_title=False)
self.stream.write('''.. autofunction:: paddle.fluid.{0}.{1} self.stream.write('''.. autofunction:: paddle.{0}.{1}
:noindex: :noindex:
'''.format(self.module_name, name)) '''.format(self.module_name, name))
...@@ -94,6 +106,10 @@ class DocGenerator(object): ...@@ -94,6 +106,10 @@ class DocGenerator(object):
self.stream.write('\n') self.stream.write('\n')
self.stream.write('\n') self.stream.write('\n')
def _print_ref_(self, name):
self.stream.write(".. _api_{0}_{1}:\n\n".format("_".join(
self.module_name.split(".")), name))
def main(): def main():
args = parse_arg() args = parse_arg()
......
doc/fluid/api/gen_doc.sh
浏览文件 @ fac1d477
#!/bin/bash #!/bin/bash
python gen_doc.py layers --submodules control_flow device io nn ops tensor detection learning_rate_scheduler metric > layers.rst python gen_doc.py layers --submodules control_flow device io nn ops tensor learning_rate_scheduler detection metric_op tensor > layers.rst
for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer transpiler for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer transpiler recordio_writer backward average profiler
do do
python gen_doc.py ${module} > ${module}.rst python gen_doc.py ${module} > ${module}.rst
done done
python gen_doc.py "" > fluid.rst
doc/fluid/api/index_en.rst
浏览文件 @ fac1d477
====================== =============
Fluid API Reference
====================== =============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
fluid.rst
layers.rst layers.rst
data_feeder.rst data_feeder.rst
executor.rst executor.rst
...@@ -18,3 +19,8 @@ Fluid ...@@ -18,3 +19,8 @@ Fluid
regularizer.rst regularizer.rst
io.rst io.rst
data.rst data.rst
transpiler.rst
recordio_writer.rst
backward.rst
average.rst
profiler.rst
doc/fluid/api/initializer.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
=========== =================
initializer fluid.initializer
=========== =================
.. _api_fluid_initializer_Constant:
Constant Constant
-------- --------
...@@ -12,6 +14,8 @@ Constant ...@@ -12,6 +14,8 @@ Constant
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_Uniform:
Uniform Uniform
------- -------
...@@ -19,6 +23,8 @@ Uniform ...@@ -19,6 +23,8 @@ Uniform
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_Normal:
Normal Normal
------ ------
...@@ -26,6 +32,8 @@ Normal ...@@ -26,6 +32,8 @@ Normal
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_Xavier:
Xavier Xavier
------ ------
...@@ -33,6 +41,8 @@ Xavier ...@@ -33,6 +41,8 @@ Xavier
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_Bilinear:
Bilinear Bilinear
-------- --------
...@@ -40,18 +50,33 @@ Bilinear ...@@ -40,18 +50,33 @@ Bilinear
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_MSRA:
MSRA
----
.. autoclass:: paddle.fluid.initializer.MSRA
:members:
:noindex:
.. _api_fluid_initializer_force_init_on_cpu:
force_init_on_cpu force_init_on_cpu
----------------- -----------------
.. autofunction:: paddle.fluid.initializer.force_init_on_cpu .. autofunction:: paddle.fluid.initializer.force_init_on_cpu
:noindex: :noindex:
.. _api_fluid_initializer_init_on_cpu:
init_on_cpu init_on_cpu
----------- -----------
.. autofunction:: paddle.fluid.initializer.init_on_cpu .. autofunction:: paddle.fluid.initializer.init_on_cpu
:noindex: :noindex:
.. _api_fluid_initializer_ConstantInitializer:
ConstantInitializer ConstantInitializer
------------------- -------------------
...@@ -59,6 +84,8 @@ ConstantInitializer ...@@ -59,6 +84,8 @@ ConstantInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_UniformInitializer:
UniformInitializer UniformInitializer
------------------ ------------------
...@@ -66,6 +93,8 @@ UniformInitializer ...@@ -66,6 +93,8 @@ UniformInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_NormalInitializer:
NormalInitializer NormalInitializer
----------------- -----------------
...@@ -73,6 +102,8 @@ NormalInitializer ...@@ -73,6 +102,8 @@ NormalInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_XavierInitializer:
XavierInitializer XavierInitializer
----------------- -----------------
...@@ -80,6 +111,8 @@ XavierInitializer ...@@ -80,6 +111,8 @@ XavierInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_BilinearInitializer:
BilinearInitializer BilinearInitializer
------------------- -------------------
...@@ -87,3 +120,12 @@ BilinearInitializer ...@@ -87,3 +120,12 @@ BilinearInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_MSRAInitializer:
MSRAInitializer
---------------
.. autoclass:: paddle.fluid.initializer.MSRAInitializer
:members:
:noindex:
doc/fluid/api/io.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
== ========
io fluid.io
== ========
.. _api_fluid_io_save_vars:
save_vars save_vars
--------- ---------
...@@ -11,84 +13,112 @@ save_vars ...@@ -11,84 +13,112 @@ save_vars
.. autofunction:: paddle.fluid.io.save_vars .. autofunction:: paddle.fluid.io.save_vars
:noindex: :noindex:
.. _api_fluid_io_save_params:
save_params save_params
----------- -----------
.. autofunction:: paddle.fluid.io.save_params .. autofunction:: paddle.fluid.io.save_params
:noindex: :noindex:
.. _api_fluid_io_save_persistables:
save_persistables save_persistables
----------------- -----------------
.. autofunction:: paddle.fluid.io.save_persistables .. autofunction:: paddle.fluid.io.save_persistables
:noindex: :noindex:
.. _api_fluid_io_load_vars:
load_vars load_vars
--------- ---------
.. autofunction:: paddle.fluid.io.load_vars .. autofunction:: paddle.fluid.io.load_vars
:noindex: :noindex:
.. _api_fluid_io_load_params:
load_params load_params
----------- -----------
.. autofunction:: paddle.fluid.io.load_params .. autofunction:: paddle.fluid.io.load_params
:noindex: :noindex:
.. _api_fluid_io_load_persistables:
load_persistables load_persistables
----------------- -----------------
.. autofunction:: paddle.fluid.io.load_persistables .. autofunction:: paddle.fluid.io.load_persistables
:noindex: :noindex:
.. _api_fluid_io_save_inference_model:
save_inference_model save_inference_model
-------------------- --------------------
.. autofunction:: paddle.fluid.io.save_inference_model .. autofunction:: paddle.fluid.io.save_inference_model
:noindex: :noindex:
.. _api_fluid_io_load_inference_model:
load_inference_model load_inference_model
-------------------- --------------------
.. autofunction:: paddle.fluid.io.load_inference_model .. autofunction:: paddle.fluid.io.load_inference_model
:noindex: :noindex:
.. _api_fluid_io_get_inference_program:
get_inference_program 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 save_checkpoint
--------------- ---------------
.. autofunction:: paddle.fluid.io.save_checkpoint .. autofunction:: paddle.fluid.io.save_checkpoint
:noindex: :noindex:
.. _api_fluid_io_load_checkpoint:
load_checkpoint load_checkpoint
--------------- ---------------
.. autofunction:: paddle.fluid.io.load_checkpoint .. autofunction:: paddle.fluid.io.load_checkpoint
:noindex: :noindex:
.. _api_fluid_io_clean_checkpoint:
clean_checkpoint clean_checkpoint
---------------- ----------------
.. autofunction:: paddle.fluid.io.clean_checkpoint .. autofunction:: paddle.fluid.io.clean_checkpoint
:noindex: :noindex:
.. _api_fluid_io_load_persist_vars_without_grad:
load_persist_vars_without_grad load_persist_vars_without_grad
------------------------------ ------------------------------
.. autofunction:: paddle.fluid.io.load_persist_vars_without_grad .. autofunction:: paddle.fluid.io.load_persist_vars_without_grad
:noindex: :noindex:
.. _api_fluid_io_save_persist_vars_without_grad:
save_persist_vars_without_grad save_persist_vars_without_grad
------------------------------ ------------------------------
.. autofunction:: paddle.fluid.io.save_persist_vars_without_grad .. autofunction:: paddle.fluid.io.save_persist_vars_without_grad
:noindex: :noindex:
.. _api_fluid_io_get_latest_checkpoint_serial:
get_latest_checkpoint_serial get_latest_checkpoint_serial
---------------------------- ----------------------------
......
doc/fluid/api/layers.rst
浏览文件 @ fac1d477
此差异已折叠。
doc/fluid/api/metrics.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
======= =============
metrics fluid.metrics
======= =============
.. _api_fluid_metrics_MetricBase:
MetricBase MetricBase
---------- ----------
...@@ -12,6 +14,8 @@ MetricBase ...@@ -12,6 +14,8 @@ MetricBase
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_CompositeMetric:
CompositeMetric CompositeMetric
--------------- ---------------
...@@ -19,6 +23,26 @@ CompositeMetric ...@@ -19,6 +23,26 @@ CompositeMetric
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_Precision:
Precision
---------
.. autoclass:: paddle.fluid.metrics.Precision
:members:
:noindex:
.. _api_fluid_metrics_Recall:
Recall
------
.. autoclass:: paddle.fluid.metrics.Recall
:members:
:noindex:
.. _api_fluid_metrics_Accuracy:
Accuracy Accuracy
-------- --------
...@@ -26,6 +50,8 @@ Accuracy ...@@ -26,6 +50,8 @@ Accuracy
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_ChunkEvaluator:
ChunkEvaluator ChunkEvaluator
-------------- --------------
...@@ -33,6 +59,8 @@ ChunkEvaluator ...@@ -33,6 +59,8 @@ ChunkEvaluator
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_EditDistance:
EditDistance EditDistance
------------ ------------
...@@ -40,6 +68,8 @@ EditDistance ...@@ -40,6 +68,8 @@ EditDistance
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_DetectionMAP:
DetectionMAP DetectionMAP
------------ ------------
...@@ -47,6 +77,8 @@ DetectionMAP ...@@ -47,6 +77,8 @@ DetectionMAP
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_Auc:
Auc Auc
--- ---
......
doc/fluid/api/nets.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
==== ==========
nets fluid.nets
==== ==========
.. _api_fluid_nets_simple_img_conv_pool:
simple_img_conv_pool simple_img_conv_pool
-------------------- --------------------
...@@ -11,18 +13,24 @@ simple_img_conv_pool ...@@ -11,18 +13,24 @@ simple_img_conv_pool
.. autofunction:: paddle.fluid.nets.simple_img_conv_pool .. autofunction:: paddle.fluid.nets.simple_img_conv_pool
:noindex: :noindex:
.. _api_fluid_nets_sequence_conv_pool:
sequence_conv_pool sequence_conv_pool
------------------ ------------------
.. autofunction:: paddle.fluid.nets.sequence_conv_pool .. autofunction:: paddle.fluid.nets.sequence_conv_pool
:noindex: :noindex:
.. _api_fluid_nets_glu:
glu glu
--- ---
.. autofunction:: paddle.fluid.nets.glu .. autofunction:: paddle.fluid.nets.glu
:noindex: :noindex:
.. _api_fluid_nets_scaled_dot_product_attention:
scaled_dot_product_attention scaled_dot_product_attention
---------------------------- ----------------------------
......
doc/fluid/api/optimizer.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
========= ===============
optimizer fluid.optimizer
========= ===============
.. _api_fluid_optimizer_SGD:
SGD SGD
--- ---
...@@ -12,6 +14,8 @@ SGD ...@@ -12,6 +14,8 @@ SGD
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Momentum:
Momentum Momentum
-------- --------
...@@ -19,6 +23,8 @@ Momentum ...@@ -19,6 +23,8 @@ Momentum
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Adagrad:
Adagrad Adagrad
------- -------
...@@ -26,6 +32,8 @@ Adagrad ...@@ -26,6 +32,8 @@ Adagrad
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Adam:
Adam Adam
---- ----
...@@ -33,6 +41,8 @@ Adam ...@@ -33,6 +41,8 @@ Adam
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Adamax:
Adamax Adamax
------ ------
...@@ -40,6 +50,8 @@ Adamax ...@@ -40,6 +50,8 @@ Adamax
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_DecayedAdagrad:
DecayedAdagrad DecayedAdagrad
-------------- --------------
...@@ -47,6 +59,17 @@ DecayedAdagrad ...@@ -47,6 +59,17 @@ DecayedAdagrad
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Ftrl:
Ftrl
----
.. autoclass:: paddle.fluid.optimizer.Ftrl
:members:
:noindex:
.. _api_fluid_optimizer_SGDOptimizer:
SGDOptimizer SGDOptimizer
------------ ------------
...@@ -54,6 +77,8 @@ SGDOptimizer ...@@ -54,6 +77,8 @@ SGDOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_MomentumOptimizer:
MomentumOptimizer MomentumOptimizer
----------------- -----------------
...@@ -61,6 +86,8 @@ MomentumOptimizer ...@@ -61,6 +86,8 @@ MomentumOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_AdagradOptimizer:
AdagradOptimizer AdagradOptimizer
---------------- ----------------
...@@ -68,6 +95,8 @@ AdagradOptimizer ...@@ -68,6 +95,8 @@ AdagradOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_AdamOptimizer:
AdamOptimizer AdamOptimizer
------------- -------------
...@@ -75,6 +104,8 @@ AdamOptimizer ...@@ -75,6 +104,8 @@ AdamOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_AdamaxOptimizer:
AdamaxOptimizer AdamaxOptimizer
--------------- ---------------
...@@ -82,6 +113,8 @@ AdamaxOptimizer ...@@ -82,6 +113,8 @@ AdamaxOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_DecayedAdagradOptimizer:
DecayedAdagradOptimizer DecayedAdagradOptimizer
----------------------- -----------------------
...@@ -89,6 +122,8 @@ DecayedAdagradOptimizer ...@@ -89,6 +122,8 @@ DecayedAdagradOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_RMSPropOptimizer:
RMSPropOptimizer RMSPropOptimizer
---------------- ----------------
...@@ -96,6 +131,17 @@ RMSPropOptimizer ...@@ -96,6 +131,17 @@ RMSPropOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_FtrlOptimizer:
FtrlOptimizer
-------------
.. autoclass:: paddle.fluid.optimizer.FtrlOptimizer
:members:
:noindex:
.. _api_fluid_optimizer_Adadelta:
Adadelta Adadelta
-------- --------
...@@ -103,6 +149,8 @@ Adadelta ...@@ -103,6 +149,8 @@ Adadelta
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_ModelAverage:
ModelAverage ModelAverage
------------ ------------
...@@ -110,6 +158,8 @@ ModelAverage ...@@ -110,6 +158,8 @@ ModelAverage
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Optimizer:
Optimizer Optimizer
--------- ---------
...@@ -117,3 +167,12 @@ Optimizer ...@@ -117,3 +167,12 @@ Optimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_RMSPropOptimizer:
RMSPropOptimizer
----------------
.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
:members:
:noindex:
doc/fluid/api/param_attr.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
========== ================
param_attr fluid.param_attr
========== ================
.. _api_fluid_param_attr_ParamAttr:
ParamAttr ParamAttr
--------- ---------
...@@ -12,6 +14,8 @@ ParamAttr ...@@ -12,6 +14,8 @@ ParamAttr
:members: :members:
:noindex: :noindex:
.. _api_fluid_param_attr_WeightNormParamAttr:
WeightNormParamAttr WeightNormParamAttr
------------------- -------------------
......
doc/fluid/api/profiler.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
======== ==============
profiler fluid.profiler
======== ==============
.. _api_fluid_profiler_cuda_profiler:
cuda_profiler cuda_profiler
------------- -------------
...@@ -11,24 +13,32 @@ cuda_profiler ...@@ -11,24 +13,32 @@ cuda_profiler
.. autofunction:: paddle.fluid.profiler.cuda_profiler .. autofunction:: paddle.fluid.profiler.cuda_profiler
:noindex: :noindex:
.. _api_fluid_profiler_reset_profiler:
reset_profiler reset_profiler
-------------- --------------
.. autofunction:: paddle.fluid.profiler.reset_profiler .. autofunction:: paddle.fluid.profiler.reset_profiler
:noindex: :noindex:
.. _api_fluid_profiler_profiler:
profiler profiler
-------- --------
.. autofunction:: paddle.fluid.profiler.profiler .. autofunction:: paddle.fluid.profiler.profiler
:noindex: :noindex:
.. _api_fluid_profiler_start_profiler:
start_profiler start_profiler
-------------- --------------
.. autofunction:: paddle.fluid.profiler.start_profiler .. autofunction:: paddle.fluid.profiler.start_profiler
:noindex: :noindex:
.. _api_fluid_profiler_stop_profiler:
stop_profiler stop_profiler
------------- -------------
......
doc/fluid/api/recordio_writer.rst 0 → 100644
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
=====================
fluid.recordio_writer
=====================
.. _api_fluid_recordio_writer_convert_reader_to_recordio_file:
convert_reader_to_recordio_file
-------------------------------
.. autofunction:: paddle.fluid.recordio_writer.convert_reader_to_recordio_file
:noindex:
.. _api_fluid_recordio_writer_convert_reader_to_recordio_files:
convert_reader_to_recordio_files
--------------------------------
.. autofunction:: paddle.fluid.recordio_writer.convert_reader_to_recordio_files
:noindex:
doc/fluid/api/regularizer.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
=========== =================
regularizer fluid.regularizer
=========== =================
.. _api_fluid_regularizer_append_regularization_ops:
append_regularization_ops append_regularization_ops
------------------------- -------------------------
...@@ -11,12 +13,7 @@ append_regularization_ops ...@@ -11,12 +13,7 @@ append_regularization_ops
.. autofunction:: paddle.fluid.regularizer.append_regularization_ops .. autofunction:: paddle.fluid.regularizer.append_regularization_ops
:noindex: :noindex:
WeightDecayRegularizer .. _api_fluid_regularizer_L1Decay:
----------------------
.. autoclass:: paddle.fluid.regularizer.WeightDecayRegularizer
:members:
:noindex:
L1Decay L1Decay
------- -------
...@@ -25,6 +22,8 @@ L1Decay ...@@ -25,6 +22,8 @@ L1Decay
:members: :members:
:noindex: :noindex:
.. _api_fluid_regularizer_L2Decay:
L2Decay L2Decay
------- -------
...@@ -32,6 +31,8 @@ L2Decay ...@@ -32,6 +31,8 @@ L2Decay
:members: :members:
:noindex: :noindex:
.. _api_fluid_regularizer_L1DecayRegularizer:
L1DecayRegularizer L1DecayRegularizer
------------------ ------------------
...@@ -39,6 +40,8 @@ L1DecayRegularizer ...@@ -39,6 +40,8 @@ L1DecayRegularizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_regularizer_L2DecayRegularizer:
L2DecayRegularizer L2DecayRegularizer
------------------ ------------------
......
doc/fluid/api/transpiler.rst
浏览文件 @ fac1d477
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
========== ================
transpiler fluid.transpiler
========== ================
.. _api_fluid_transpiler_DistributeTranspiler:
DistributeTranspiler DistributeTranspiler
-------------------- --------------------
...@@ -12,12 +14,7 @@ DistributeTranspiler ...@@ -12,12 +14,7 @@ DistributeTranspiler
:members: :members:
:noindex: :noindex:
InferenceTranspiler .. _api_fluid_transpiler_memory_optimize:
-------------------
.. autoclass:: paddle.fluid.transpiler.InferenceTranspiler
:members:
:noindex:
memory_optimize memory_optimize
--------------- ---------------
...@@ -25,12 +22,16 @@ memory_optimize ...@@ -25,12 +22,16 @@ memory_optimize
.. autofunction:: paddle.fluid.transpiler.memory_optimize .. autofunction:: paddle.fluid.transpiler.memory_optimize
:noindex: :noindex:
.. _api_fluid_transpiler_release_memory:
release_memory release_memory
-------------- --------------
.. autofunction:: paddle.fluid.transpiler.release_memory .. autofunction:: paddle.fluid.transpiler.release_memory
:noindex: :noindex:
.. _api_fluid_transpiler_HashName:
HashName HashName
-------- --------
...@@ -38,9 +39,12 @@ HashName ...@@ -38,9 +39,12 @@ HashName
:members: :members:
:noindex: :noindex:
.. _api_fluid_transpiler_RoundRobin:
RoundRobin RoundRobin
---------- ----------
.. autoclass:: paddle.fluid.transpiler.RoundRobin .. autoclass:: paddle.fluid.transpiler.RoundRobin
:members: :members:
:noindex: :noindex:
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或