Skip to content

Commit

Permalink
update docs dtype(core.VarDesc.VarType) (PaddlePaddle#4378)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ligoml authored Mar 28, 2022
1 parent a5280b0 commit a7d698d
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/api/paddle/arange_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ arange
- **start** (float|int|Tensor) - 区间起点(且区间包括此值)。当 ``start`` 类型是Tensor时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。如果仅指定 ``start`` ,而 ``end`` 为None,则区间为[0, ``start``)。默认值为0。
- **end** (float|int|Tensor, 可选) - 区间终点(且通常区间不包括此值)。当 ``end`` 类型是Tensor时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。默认值为None。
- **step** (float|int|Tensor, 可选) - 均匀分割的步长。当 ``step`` 类型是Tensor时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。默认值为1。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持int32、int64、float32、float64。当该参数值为None时, 输出Tensor的数据类型为int64。默认值为None.
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持int32、int64、float32、float64。当该参数值为None时, 输出Tensor的数据类型为int64。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/cast_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cast

参数:
- **x** (Tensor) - 输入的多维Tensor或LoDTensor,支持的数据类型为:bool、float16、float32、float64、uint8、int32、int64。
- **dtype** (str|np.dtype|core.VarDesc.VarType) - 输出Tensor的数据类型。支持的数据类型为:bool、float16、float32、float64、int8、int32、int64、uint8。
- **dtype** (str|np.dtype) - 输出Tensor的数据类型。支持的数据类型为:bool、float16、float32、float64、int8、int32、int64、uint8。

返回:Tensor或LoDTensor,维度与 ``x`` 相同,数据类型为 ``dtype``

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/rand_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ rand
参数
::::::::::
- **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple,则其中的元素可以是int,或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor,则是数据类型为int32、int64的1-D Tensor。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/randn_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ randn
参数
::::::::::
- **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple,则其中的元素可以是int,或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor,则是数据类型为int32、int64的1-D Tensor。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/randperm_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ randperm
参数:
::::::::::
- **n** (int) - 随机序列的上限(不包括在序列中),应该大于0。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持int32、int64、float32、float64。默认值为"int64".
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持int32、int64、float32、float64。默认值为"int64".
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/standard_normal_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ standard_normal
参数
::::::::::
- **shape** (list|tuple|Tensor) - 生成的随机Tensor的形状。如果 ``shape`` 是list、tuple,则其中的元素可以是int,或者是形状为[1]且数据类型为int32、int64的Tensor。如果 ``shape`` 是Tensor,则是数据类型为int32、int64的1-D Tensor。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持float32、float64。当该参数值为None时, 输出Tensor的数据类型为float32。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/static/InputSpec_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ InputSpec

参数:
- **shape** (list|tuple)- 声明维度信息的list或tuple,默认值为None。
- **dtype** (np.dtype|VarType|str,可选)- 数据类型,支持bool,float16,float32,float64,int8,int16,int32,int64,uint8。默认值为float32。
- **dtype** (np.dtype|str,可选)- 数据类型,支持bool,float16,float32,float64,int8,int16,int32,int64,uint8。默认值为float32。
- **name** (str)- 被创建对象的名字,具体用法请参见 :ref:`api_guide_Name` 。

返回:初始化后的 ``InputSpec`` 对象
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/static/nn/embedding_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ embedding
- **is_distributed** (bool) - 是否使用分布式的方式存储embedding矩阵,仅在多机分布式cpu训练中使用。默认为False。
- **padding_idx** (int|long|None) - padding_idx需在区间 ``[-vocab_size, vocab_size)`` ,否则不生效,``padding_idx < 0`` 时,padding_idx会被改成``vocab_size + padding_idx``,input中等于padding_index的id对应的embedding信息会被设置为0,且这部分填充数据在训练时将不会被更新。如果为None,不作处理,默认为None。
- **param_attr** (ParamAttr) - 指定权重参数属性的对象。默认值为None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。此外,可以通过 ``param_attr`` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为numpy数据格式,且保证本地词向量的shape和embedding的 ``size`` 参数一致,然后使用 :ref:`cn_api_paddle_to_tensor` 进行初始化,即可实现加载自定义或预训练的词向量。
- **dtype** (str|core.VarDesc.VarType) - 输出Tensor的数据类型,数据类型必须为:float32 或 float64,默认为 float32。
- **dtype** (str) - 输出Tensor的数据类型,数据类型必须为:float32 或 float64,默认为 float32。

返回:input映射后得到的Embedding Tensor或LoDTensor,数据类型和dtype定义的类型一致。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/static/nn/sparse_embedding_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ sparse_embedding
- **entry** (str,可选) - 准入策略配置,目前支持概率准入ProbabilityEntry和频次准入CountFilterEntry。默认为None。
- **table_class** (str,可选) - 稀疏表的类型,其值可以为CommonSparseTable和SSDSparseTable。默认为CommonSparseTable。
- **param_attr** (ParamAttr,可选) - 指定权重参数属性的对象。默认值为None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。此外,可以通过 ``param_attr`` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为numpy数据格式,且保证本地词向量的shape和embedding的 ``size`` 参数一致,然后使用 :ref:`cn_api_paddle_to_tensor` 进行初始化,即可实现加载自定义或预训练的词向量。
- **dtype** (str|core.VarDesc.VarType) - 输出Tensor的数据类型,数据类型必须为:float32 或float64,默认为float32。
- **dtype** (str) - 输出Tensor的数据类型,数据类型必须为:float32 或float64,默认为float32。

返回
::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/zeros_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ zeros

参数:
- **shape** (tuple|list|Tensor) - 输出Tensor的形状, ``shape`` 的数据类型为int32或者int64。
- **dtype** (np.dtype|core.VarDesc.VarType|str,可选) - 输出Tensor的数据类型,数据类型必须为bool、float16、float32、float64、int32或int64。若为None,数据类型为float32, 默认为None。
- **dtype** (np.dtype|str,可选) - 输出Tensor的数据类型,数据类型必须为bool、float16、float32、float64、int32或int64。若为None,数据类型为float32, 默认为None。
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回:值全为0的Tensor,数据类型和 ``dtype`` 定义的类型一致。
Expand Down

0 comments on commit a7d698d

Please sign in to comment.