评价此页

torch.nn.functional.embedding#

torch.nn.functional.embedding(input, weight, padding_idx=None, max_norm=None, norm_type=2.0, scale_grad_by_freq=False, sparse=False)[源代码]#

生成一个简单的查找表,该表在固定的词典和大小中查找嵌入。

此模块通常用于使用索引检索词嵌入。模块的输入是索引列表和嵌入矩阵,输出是相应的词嵌入。

有关更多详细信息,请参阅 torch.nn.Embedding

注意

请注意,该函数关于 padding_idx 指定的行的 weight 中条目的解析梯度预计与数值梯度不同。

注意

请注意,:class:`torch.nn.Embedding` 与此函数不同之处在于,它在构造时将 padding_idx 指定的 weight 的行初始化为全零。

参数
  • input (LongTensor) – 包含嵌入矩阵索引的张量

  • weight (Tensor) – 嵌入矩阵,行数等于最大可能索引 + 1,列数等于嵌入大小

  • padding_idx (int, optional) – 如果指定,padding_idx处的条目不计入梯度;因此,padding_idx处的嵌入向量在训练期间不会被更新,即它保持为一个固定的“pad”。

  • max_norm (float, optional) – 如果给定,范数大于 max_norm 的每个嵌入向量将被重新归一化为具有范数 max_norm。注意:这将修改 weight(就地)。

  • norm_type (float, optional) – 计算 max_norm 选项的 p-范数的 p 值。默认为 2.0

  • scale_grad_by_freq (bool, optional) – 如果给定,这将通过小批量中词语频率的倒数来缩放梯度。默认值为 False

  • sparse (bool, optional) – 如果为 True,则关于 weight 的梯度将是一个稀疏张量。有关稀疏梯度的更多详细信息,请参阅 torch.nn.Embedding 下的“说明”。

返回类型

张量

形状
  • 输入:任意形状的 LongTensor,包含要提取的索引

  • 权重:形状为 (V, embedding_dim)` 的浮点型嵌入矩阵,其中 V = 最大索引 + 1 且 embedding_dim = 嵌入大小

  • 输出:(*, embedding_dim)`,其中 * 是输入形状

示例

>>> # a batch of 2 samples of 4 indices each
>>> input = torch.tensor([[1, 2, 4, 5], [4, 3, 2, 9]])
>>> # an embedding matrix containing 10 tensors of size 3
>>> embedding_matrix = torch.rand(10, 3)
>>> F.embedding(input, embedding_matrix)
tensor([[[ 0.8490,  0.9625,  0.6753],
         [ 0.9666,  0.7761,  0.6108],
         [ 0.6246,  0.9751,  0.3618],
         [ 0.4161,  0.2419,  0.7383]],

        [[ 0.6246,  0.9751,  0.3618],
         [ 0.0237,  0.7794,  0.0528],
         [ 0.9666,  0.7761,  0.6108],
         [ 0.3385,  0.8612,  0.1867]]])

>>> # example with padding_idx
>>> weights = torch.rand(10, 3)
>>> weights[0, :].zero_()
>>> embedding_matrix = weights
>>> input = torch.tensor([[0, 2, 0, 5]])
>>> F.embedding(input, embedding_matrix, padding_idx=0)
tensor([[[ 0.0000,  0.0000,  0.0000],
         [ 0.5609,  0.5384,  0.8720],
         [ 0.0000,  0.0000,  0.0000],
         [ 0.6262,  0.2438,  0.7471]]])