未验证 提交 15f16747 编写于 作者: A Aurelius84 提交者: GitHub

Add InputSpec zh and en doc (#2488)

* add InputSpec zh doc

* fix sample code

* modify declarative into to_static

* sync with 2.0 api
上级 bd0935ef
...@@ -14,6 +14,7 @@ API Reference ...@@ -14,6 +14,7 @@ API Reference
metric.rst metric.rst
nn.rst nn.rst
optimizer.rst optimizer.rst
static.rst
tensor.rst tensor.rst
fluid.rst fluid.rst
backward.rst backward.rst
......
=======================
paddle.static
=======================
.. toctree::
:maxdepth: 1
static/data.rst
static/InputSpec.rst
\ No newline at end of file
.. _api_static_InputSpec:
InputSpec
------------
.. autoclass:: paddle.static.InputSpec
:members:
:noindex:
\ No newline at end of file
.. _api_static_data:
data
------------
.. autofunction:: paddle.static.data
:noindex:
\ No newline at end of file
...@@ -15,6 +15,7 @@ API接口 ...@@ -15,6 +15,7 @@ API接口
dataset_cn.rst dataset_cn.rst
distributed_cn.rst distributed_cn.rst
dygraph_cn.rst dygraph_cn.rst
static_cn.rst
executor_cn.rst executor_cn.rst
initializer_cn.rst initializer_cn.rst
io_cn.rst io_cn.rst
......
...@@ -102,6 +102,7 @@ Note。 ...@@ -102,6 +102,7 @@ Note。
imperative_cn.rst imperative_cn.rst
declarative_cn.rst declarative_cn.rst
optimizer_cn.rst optimizer_cn.rst
static_cn.rst
metric_cn.rst metric_cn.rst
framework_cn.rst framework_cn.rst
io_cn.rst io_cn.rst
...@@ -121,7 +122,6 @@ Note。 ...@@ -121,7 +122,6 @@ Note。
layers_cn.rst layers_cn.rst
metrics_cn.rst metrics_cn.rst
nets_cn.rst nets_cn.rst
optimizer_cn.rst
profiler_cn.rst profiler_cn.rst
regularizer_cn.rst regularizer_cn.rst
transpiler_cn.rst transpiler_cn.rst
......
...@@ -9,4 +9,5 @@ paddle.static ...@@ -9,4 +9,5 @@ paddle.static
:maxdepth: 1 :maxdepth: 1
static_cn/data_cn.rst static_cn/data_cn.rst
static_cn/InputSpec_cn.rst
.. _cn_api_static_cn_InputSpec:
InputSpec
-------------------------------
.. py:class:: paddle.static.InputSpec(shape=None, dtype='float32', name=None)
用于描述模型输入的签名信息,包括shape、dtype和name。
此接口常用于指定高层API中模型的输入张量信息,或动态图转静态图时,指定被 ``paddle.jit.to_static`` 装饰的forward函数每个输入参数的张量信息。
参数:
- **shape** (list|tuple)- 声明维度信息的list或tuple,默认值为None。
- **dtype** (np.dtype|VarType|str,可选)- 数据类型,支持bool,float16,float32,float64,int8,int16,int32,int64,uint8。默认值为float32。
- **name** (str)- 被创建对象的名字,具体用法请参见 :ref:`api_guide_Name` 。
返回:初始化后的 ``InputSpec`` 对象
返回类型:InputSpec
**代码示例**
.. code-block:: python
from paddle.static import InputSpec
input = InputSpec([None, 784], 'float32', 'x')
label = InputSpec([None, 1], 'int64', 'label')
print(input) # InputSpec(shape=(-1, 784), dtype=VarType.FP32, name=x)
print(label) # InputSpec(shape=(-1, 1), dtype=VarType.INT64, name=label)
.. py:method:: from_tensor(tensor, name=None)
该接口将根据输入Tensor的shape、dtype等信息构建InputSpec对象。
参数:
- **tensor** (Tensor) - 用于构建InputSpec的源Tensor
- **name** (str): 被创建对象的名字,具体用法请参见 :ref:`api_guide_Name` 。 默认为:None。
返回:根据Tensor信息构造的 ``InputSpec`` 对象
返回类型:InputSpec
**代码示例**
.. code-block:: python
import numpy as np
import paddle
from paddle.static import InputSpec
paddle.disable_static()
x = paddle.to_tensor(np.ones([2, 2], np.float32))
x_spec = InputSpec.from_tensor(x, name='x')
print(x_spec) # InputSpec(shape=(2, 2), dtype=VarType.FP32, name=x)
.. py:method:: from_numpy(ndarray, name=None)
该接口将根据输入numpy ndarray的shape、dtype等信息构建InputSpec对象。
参数:
- **ndarray** (Tensor) - 用于构建InputSpec的numpy ndarray
- **name** (str): 被创建对象的名字,具体用法请参见 :ref:`api_guide_Name` 。 默认为:None。
返回:根据ndarray信息构造的 ``InputSpec`` 对象
返回类型:InputSpec
**代码示例**
.. code-block:: python
import numpy as np
from paddle.static import InputSpec
x = np.ones([2, 2], np.float32)
x_spec = InputSpec.from_numpy(x, name='x')
print(x_spec) # InputSpec(shape=(2, 2), dtype=VarType.FP32, name=x)
.. py:method:: batch(batch_size)
该接口将batch_size插入到当前InputSpec对象的shape元组最前面。
参数:
- **batch_size** (int) - 被插入的batch size整型数值
返回: 更新shape信息后的 ``InputSpec`` 对象
返回类型:InputSpec
**代码示例**
.. code-block:: python
from paddle.static import InputSpec
x_spec = InputSpec(shape=[64], dtype='float32', name='x')
x_spec.batch(4)
print(x_spec) # InputSpec(shape=(4, 64), dtype=VarType.FP32, name=x)
.. py:method:: unbatch()
该接口将当前InputSpec对象shape[0]值移除。
返回: 更新shape信息后的 ``InputSpec`` 对象
返回类型:InputSpec
**代码示例**
.. code-block:: python
from paddle.static import InputSpec
x_spec = InputSpec(shape=[4, 64], dtype='float32', name='x')
x_spec.unbatch()
print(x_spec) # InputSpec(shape=(64,), dtype=VarType.FP32, name=x)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册