评价此页

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)[source]#

生成一个简单的查找表,用于在固定词典和大小中查找嵌入(embeddings)。

此模块常用于通过索引获取词嵌入。该模块的输入是索引列表和嵌入矩阵,输出是对应的词嵌入。

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

注意

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

注意

请注意,:class:`torch.nn.Embedding 与此函数的区别在于:它在构建时会将 weight 中由 padding_idx 指定的行初始化为全零。

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

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

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

  • max_norm (float, optional) – 如果给定,范数大于 max_norm 的每个嵌入向量将被重新归一化至范数为 max_norm。注意:这将原地(in-place)修改 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]]])