@@ -14,7 +14,7 @@ sparse_embedding
14
14
输出的 Tensor 的 shape 是将输入 Tensor shape 的会在输出的 embedding 最后追加一维 emb_size。
15
15
16
16
.. note ::
17
- input 中的 id 必须满足 ``0 =< id < size[0] ``,否则程序会抛异常退出。
17
+ input 中的 id 必须满足 ``0 <= id < size[0] ``,否则程序会抛异常退出。
18
18
19
19
20
20
::
@@ -59,13 +59,13 @@ sparse_embedding
59
59
60
60
参数
61
61
::::::::
62
- - **input ** (Variable) - 存储 id 信息的 Tensor,数据类型必须为:int64,输入的 shape 最后一维须为 1。input 中的 id 必须满足 ``0 =< id < size[0] `` 。
62
+ - **input ** (Variable) - 存储 id 信息的 Tensor,数据类型必须为:int64,输入的 shape 最后一维须为 1。input 中的 id 必须满足 ``0 <= id < size[0] `` 。
63
63
- **size ** (tuple|list) - embedding 矩阵的维度(vocab_size,emb_size)。必须包含两个元素,第一个元素为 vocab_size(词表大小),第二个为 emb_size(embedding 层维度)。大规模稀疏场景下,参数规模初始为 0,会随着训练的进行逐步扩展,因此如果 vocab_size 暂时无用,其值可以为任意整数,emb_size 则为词嵌入权重参数的维度配置。
64
- - **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。
65
- - **is_test ** (bool,可选) - 表示训练/预测模式。在预测模式(is_test=False)下,遇到不存在的特征,不会初始化及创建,直接以 0 填充后返回。默认值为 False。
66
- - **entry ** (str,可选) - 准入策略配置,目前支持概率准入 ProbabilityEntry 和频次准入 CountFilterEntry。默认为 None。
67
- - **table_class ** (str,可选) - 稀疏表的类型,其值可以为 CommonSparseTable 和 SSDSparseTable 。默认为 CommonSparseTable。
68
- - **param_attr ** (ParamAttr,可选) - 指定权重参数属性的对象。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref: `cn_api_paddle_ParamAttr `。此外,可以通过 ``param_attr `` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为 numpy 数据格式,且保证本地词向量的 shape 和 embedding 的 ``size `` 参数一致,然后使用 :ref: `cn_api_paddle_to_tensor ` 进行初始化,即可实现加载自定义或预训练的词向量。
64
+ - **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。
65
+ - **is_test ** (bool,可选) - 表示训练/预测模式。在预测模式(is_test=False)下,遇到不存在的特征,不会初始化及创建,会直接以 0 填充后返回。默认值为 False。
66
+ - **entry ** (str,可选) - 准入策略配置,目前支持概率准入 ProbabilityEntry、频次准入 CountFilterEntry 和曝光点击准入 ShowClickEntry 。默认为 None。
67
+ - **table_class ** (str,可选) - 稀疏表的类型,其值可以为 CommonSparseTable、SSDSparseTable 和 MemorySparseTable 。默认为 CommonSparseTable。
68
+ - **param_attr ** (ParamAttr,可选) - 指定权重参数属性的对象。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref: `cn_api_paddle_ParamAttr ` 。此外,可以通过 ``param_attr `` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为 numpy 数据格式,且保证本地词向量的 shape 和 embedding 的 ``size `` 参数一致,然后使用 :ref: `cn_api_paddle_to_tensor ` 进行初始化,即可实现加载自定义或预训练的词向量。
69
69
- **dtype ** (str) - 输出 Tensor 的数据类型,数据类型必须为:float32 或 float64,默认为 float32。
70
70
71
71
返回
0 commit comments