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][source]¶
生成一个简单的查找表,用于在固定字典和大小中查找嵌入。
此模块通常用于使用索引检索词嵌入。模块的输入是索引列表和嵌入矩阵,输出是相应的词嵌入。
有关更多详细信息,请参阅
torch.nn.Embedding
。注意
请注意,此函数相对于
weight
中由padding_idx
指定的行的梯度的解析值预计与数值值不同。注意
请注意,:class:`torch.nn.Embedding 与此函数的区别在于,它在构建时会将由
padding_idx
指定的weight
行初始化为全零。- 参数
input (LongTensor) – 包含嵌入矩阵索引的 Tensor
weight (Tensor) – 浮点型的嵌入矩阵,其行数等于最大可能索引 + 1,列数等于嵌入大小
padding_idx (int, 可选) – 如果指定,
padding_idx
处的条目不参与梯度计算;因此,训练期间不会更新padding_idx
处的嵌入向量,即它保持为固定的“填充”。max_norm (float, 可选) – 如果给定,每个范数大于
max_norm
的嵌入向量将被重新归一化,使其范数等于max_norm
。注意:这将原地修改weight
。norm_type (float, 可选) – 用于
max_norm
选项的 p-范数中的 p。默认为2
。scale_grad_by_freq (bool, 可选) – 如果给定,这将根据 mini-batch 中词语频率的倒数来缩放梯度。默认为
False
。sparse (bool, 可选) – 如果为
True
,则相对于weight
的梯度将是一个稀疏 tensor。有关稀疏梯度的更多详细信息,请参阅torch.nn.Embedding
下的注释。
- 返回类型
- 形状
Input: 任意形状的 LongTensor,包含要提取的索引
Weight: 浮点型的嵌入矩阵,形状为 (V, embedding_dim),其中 V = 最大索引 + 1,embedding_dim = 嵌入大小
Output: (*, 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]]])