未验证 提交 c2f44fe6 编写于 作者: S songyouwei 提交者: GitHub

[cherry pick] Add missing docs (#1875)

test=develop test=release/1.7
上级 f1b371e7
.. _cn_api_fluid_save:
save
-------------------------------
**注意:该API仅支持【静态图】模式**
.. py:function:: paddle.fluid.save(program, model_path)
该接口将传入的参数、优化器信息和网络描述保存到 ``model_path`` 。
参数包含所有的可训练 :ref:`cn_api_fluid_Variable` ,将保存到后缀为 ``.pdparams`` 的文件中。
优化器信息包含优化器使用的所有变量。对于Adam优化器,包含beta1、beta2、momentum等。
所有信息将保存到后缀为 ``.pdopt`` 的文件中。(如果优化器没有需要保存的变量(如sgd),则不会生成)。
网络描述是程序的描述。它只用于部署。描述将保存到后缀为 ``.pdmodel`` 的文件中。
参数:
- **program** ( :ref:`cn_api_fluid_Program` ) – 要保存的Program。
- **model_path** (str) – 保存program的文件前缀。格式为 ``目录名称/文件前缀``。如果文件前缀为空字符串,会引发异常。
返回: 无
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
x = fluid.data(name="x", shape=[10, 10], dtype='float32')
y = fluid.layers.fc(x, 10)
z = fluid.layers.fc(y, 10)
place = fluid.CPUPlace()
exe = fluid.Executor(place)
exe.run(fluid.default_startup_program())
fluid.save(fluid.default_main_program(), "./test_path")
...@@ -17,6 +17,8 @@ fluid.io ...@@ -17,6 +17,8 @@ fluid.io
io_cn/ComposeNotAligned_cn.rst io_cn/ComposeNotAligned_cn.rst
io_cn/DataLoader_cn.rst io_cn/DataLoader_cn.rst
io_cn/firstn_cn.rst io_cn/firstn_cn.rst
io_cn/get_program_parameter_cn.rst
io_cn/get_program_persistable_vars_cn.rst
io_cn/load_cn.rst io_cn/load_cn.rst
io_cn/load_inference_model_cn.rst io_cn/load_inference_model_cn.rst
io_cn/load_params_cn.rst io_cn/load_params_cn.rst
......
.. _cn_api_fluid_io_get_program_parameter:
get_program_parameter
-------------------------------
.. py:function:: paddle.fluid.io.get_program_parameter(program)
该接口从Program中获取所有参数。
参数:
- **program** ( :ref:`cn_api_fluid_Program` ) – 从该Program中获取参数。
返回: 包含此Program中所有参数的list
返回类型: list
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
data = fluid.data(name="img", shape=[64, 784])
w = fluid.layers.create_parameter(shape=[784, 200], dtype='float32', name='fc_w')
b = fluid.layers.create_parameter(shape=[200], dtype='float32', name='fc_b')
list_para = fluid.io.get_program_parameter( fluid.default_main_program() )
.. _cn_api_fluid_io_get_program_persistable_vars:
get_program_persistable_vars
-------------------------------
.. py:function:: paddle.fluid.io.get_program_persistable_vars(program)
该接口从Program中获取所有persistable的变量。
参数:
- **program** ( :ref:`cn_api_fluid_Program` ) – 从该Program中获取persistable的变量。
返回: 包含此Program中所有persistable的变量
返回类型: list
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
data = fluid.data(name="img", shape=[64, 784])
w = fluid.layers.create_parameter(shape=[784, 200], dtype='float32', name='fc_w')
b = fluid.layers.create_parameter(shape=[200], dtype='float32', name='fc_b')
list_para = fluid.io.get_program_persistable_vars( fluid.default_main_program() )
...@@ -5,4 +5,4 @@ load ...@@ -5,4 +5,4 @@ load
.. py:function:: paddle.fluid.io.load(program, model_path, executor=None, var_list=None) .. py:function:: paddle.fluid.io.load(program, model_path, executor=None, var_list=None)
``fluid.io.load`` 是 ``fluid.load`` 的别名 ``fluid.io.load`` 是 :ref:`cn_api_fluid_load` 的别名
...@@ -7,39 +7,4 @@ save ...@@ -7,39 +7,4 @@ save
.. py:function:: paddle.fluid.io.save(program, model_path) .. py:function:: paddle.fluid.io.save(program, model_path)
该接口将传入的参数、优化器信息和网络描述保存到 ``model_path`` 。 ``fluid.io.save`` 是 :ref:`cn_api_fluid_save` 的别名
参数包含所有的可训练 :ref:`cn_api_fluid_Variable` ,将保存到后缀为 ``.pdparams`` 的文件中。
优化器信息包含优化器使用的所有变量。对于Adam优化器,包含beta1、beta2、momentum等。
所有信息将保存到后缀为 ``.pdopt`` 的文件中。(如果优化器没有需要保存的变量(如sgd),则不会生成)。
网络描述是程序的描述。它只用于部署。描述将保存到后缀为 ``.pdmodel`` 的文件中。
参数:
- **program** ( :ref:`cn_api_fluid_Program` ) – 要保存的Program。
- **model_path** (str) – 保存program的文件前缀。格式为 ``目录名称/文件前缀``。如果文件前缀为空字符串,会引发异常。
返回: 无
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
x = fluid.data(name="x", shape=[10, 10], dtype='float32')
y = fluid.layers.fc(x, 10)
z = fluid.layers.fc(y, 10)
place = fluid.CPUPlace()
exe = fluid.Executor(place)
exe.run(fluid.default_startup_program())
fluid.save(fluid.default_main_program(), "./test_path")
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册