模块¶

标准的 TorchRec 模块表示嵌入表的集合：

EmbeddingBagCollection 是 torch.nn.EmbeddingBag 的集合
EmbeddingCollection 是 torch.nn.Embedding 的集合

这些模块是通过标准化的配置类构建的：

EmbeddingBagConfig 用于 EmbeddingBagCollection
EmbeddingConfig 用于 EmbeddingCollection

class torchrec.modules.embedding_configs.EmbeddingBagConfig(num_embeddings: int, embedding_dim: int, name: str = '', data_type: ~torchrec.types.DataType = DataType.FP32, feature_names: ~typing.List[str] = <factory>, weight_init_max: ~typing.Optional[float] = None, weight_init_min: ~typing.Optional[float] = None, num_embeddings_post_pruning: ~typing.Optional[int] = None, init_fn: ~typing.Optional[~typing.Callable[[~torch.Tensor], ~typing.Optional[~torch.Tensor]]] = None, need_pos: bool = False, pooling: ~torchrec.modules.embedding_configs.PoolingType = PoolingType.SUM)¶

基础：BaseEmbeddingConfig

EmbeddingBagConfig 是一个表示单个嵌入表的数据类，其输出旨在进行池化。

Parameters:: pooling (PoolingType) – 池化类型。

class torchrec.modules.embedding_configs.EmbeddingConfig(num_embeddings: int, embedding_dim: int, name: str = '', data_type: ~torchrec.types.DataType = DataType.FP32, feature_names: ~typing.List[str] = <factory>, weight_init_max: ~typing.Optional[float] = None, weight_init_min: ~typing.Optional[float] = None, num_embeddings_post_pruning: ~typing.Optional[int] = None, init_fn: ~typing.Optional[~typing.Callable[[~torch.Tensor], ~typing.Optional[~torch.Tensor]]] = None, need_pos: bool = False)¶

基础：BaseEmbeddingConfig

EmbeddingConfig 是一个表示单个嵌入表的数据类。

class torchrec.modules.embedding_configs.BaseEmbeddingConfig(num_embeddings: int, embedding_dim: int, name: str = '', data_type: ~torchrec.types.DataType = DataType.FP32, feature_names: ~typing.List[str] = <factory>, weight_init_max: ~typing.Optional[float] = None, weight_init_min: ~typing.Optional[float] = None, num_embeddings_post_pruning: ~typing.Optional[int] = None, init_fn: ~typing.Optional[~typing.Callable[[~torch.Tensor], ~typing.Optional[~torch.Tensor]]] = None, need_pos: bool = False)¶

嵌入配置的基类。

Parameters:

num_embeddings (int) – 嵌入的数量。
embedding_dim (int) – 嵌入维度。
name (str) – 嵌入表的名称。
data_type (DataType) – 嵌入表的数据类型。
feature_names (List[str]) – 特征名称列表。
weight_init_max (可选[float]) – 权重初始化的最大值。
weight_init_min (可选[float]) – 权重初始化的最小值。
num_embeddings_post_pruning (Optional[int]) – 剪枝后用于推理的嵌入数量。如果为None，则不应用剪枝。
init_fn (可选[Callable[[torch.Tensor], 可选[torch.Tensor]]]) – 嵌入权重的初始化函数。
need_pos (bool) – 表格是否按位置加权。

class torchrec.modules.embedding_modules.EmbeddingBagCollection(tables: List[EmbeddingBagConfig], is_weighted: bool = False, device: Optional[device] = None)¶

EmbeddingBagCollection 表示一组池化嵌入（EmbeddingBags）。

注意

EmbeddingBagCollection 是一个未分片的模块，未进行性能优化。对于性能敏感的场景，请考虑使用分片版本 ShardedEmbeddingBagCollection。

它可以在表示稀疏数据的参数上调用，这些数据以KeyedJaggedTensor的形式存在，其值的形状为(F, B, L[f][i])，其中：

F: 特征（键）的数量
B: 批量大小
L[f][i]: 稀疏特征的长度（可能对于每个特征f和批次索引i都不同，即不规则的）

并输出一个KeyedTensor，其值的形状为(B, D)，其中：

B: 批量大小
D: 所有嵌入表的嵌入维度之和，即 sum([config.embedding_dim for config in tables])

假设参数是一个具有F特征、批量大小B和L[f][i]稀疏长度的KeyedJaggedTensor J，使得J[f][i]是特征f和批量索引i的包，输出KeyedTensor KT定义如下： KT[i] = torch.cat([emb[f](J[f][i]) for f in J.keys()])，其中emb[f]是对应于特征f的EmbeddingBag。

请注意，J[f][i] 是一个可变长度的整数值列表（一个包），而 emb[f](J[f][i]) 是通过使用 EmbeddingBag emb[f] 的模式（默认是平均值）减少 J[f][i] 中每个值的嵌入而产生的池化嵌入。

Parameters:

tables (List[EmbeddingBagConfig]) – 嵌入表的列表。
is_weighted (bool) – 输入 KeyedJaggedTensor 是否加权。
device (可选[torch.device]) – 默认计算设备。

示例：

table_0 = EmbeddingBagConfig(
    name="t1", embedding_dim=3, num_embeddings=10, feature_names=["f1"]
)
table_1 = EmbeddingBagConfig(
    name="t2", embedding_dim=4, num_embeddings=10, feature_names=["f2"]
)

ebc = EmbeddingBagCollection(tables=[table_0, table_1])

#        i = 0     i = 1    i = 2  <-- batch indices
# "f1"   [0,1]     None      [2]
# "f2"   [3]       [4]     [5,6,7]
#  ^
# features

features = KeyedJaggedTensor(
    keys=["f1", "f2"],
    values=torch.tensor([0, 1,                  2,    # feature 'f1'
                            3,      4,    5, 6, 7]),  # feature 'f2'
                    #    i = 1    i = 2    i = 3   <--- batch indices
    offsets=torch.tensor([
            0, 2, 2,       # 'f1' bags are values[0:2], values[2:2], and values[2:3]
            3, 4, 5, 8]),  # 'f2' bags are values[3:4], values[4:5], and values[5:8]
)

pooled_embeddings = ebc(features)
print(pooled_embeddings.values())
tensor([
    #  f1 pooled embeddings              f2 pooled embeddings
    #     from bags (dim. 3)                from bags (dim. 4)
    [-0.8899, -0.1342, -1.9060,  -0.0905, -0.2814, -0.9369, -0.7783],  # i = 0
    [ 0.0000,  0.0000,  0.0000,   0.1598,  0.0695,  1.3265, -0.1011],  # i = 1
    [-0.4256, -1.1846, -2.1648,  -1.0893,  0.3590, -1.9784, -0.7681]],  # i = 2
    grad_fn=<CatBackward0>)
print(pooled_embeddings.keys())
['f1', 'f2']
print(pooled_embeddings.offset_per_key())
tensor([0, 3, 7])  # embeddings have dimensions 3 and 4, so embeddings are at [0, 3) and [3, 7).

property device: device¶: 返回: torch.device: 计算设备。

embedding_bag_configs() → List[EmbeddingBagConfig]¶

Returns:: 嵌入包的配置。
Return type:: 列表[EmbeddingBagConfig]

forward(features: KeyedJaggedTensor) → KeyedTensor¶

运行EmbeddingBagCollection的前向传递。此方法接收一个KeyedJaggedTensor并返回一个KeyedTensor，这是对每个特征的嵌入进行池化的结果。

Parameters:: 特征 (KeyedJaggedTensor) – 输入 KJT
Returns:: 键控张量

is_weighted() → bool¶

Returns:: EmbeddingBagCollection 是否加权。
Return type:: 布尔

reset_parameters() → None¶: 重置EmbeddingBagCollection的参数。如果每个EmbeddingBagConfig的init_fn存在，则根据其初始化参数值。

class torchrec.modules.embedding_modules.EmbeddingCollection(tables: List[EmbeddingConfig], device: Optional[device] = None, need_indices: bool = False)¶

EmbeddingCollection 表示一组非池化的嵌入。

注意

EmbeddingCollection 是一个未分片的模块，未进行性能优化。对于性能敏感的场景，请考虑使用分片版本 ShardedEmbeddingCollection。

它可以在表示稀疏数据的参数上调用，这些数据以KeyedJaggedTensor的形式存在，其值的形状为(F, B, L[f][i])，其中：

F: 特征（键）的数量
B: 批量大小
L[f][i]: 稀疏特征的长度（可能对于每个特征f和批次索引i都不同，即不规则的）

并输出一个类型为Dict[Feature, JaggedTensor]的结果，其中result[f]是一个形状为(EB[f], D[f])的JaggedTensor，其中：

EB[f]: 特征 f 的“扩展批量大小”，等于其包值长度的总和，即 sum([len(J[f][i]) for i in range(B)])。
D[f]: 是特征 f 的嵌入维度。

Parameters:

tables (List[EmbeddingConfig]) – 嵌入表的列表。
device (可选[torch.device]) – 默认计算设备。
need_indices (bool) – 如果我们需要将索引传递给最终的查找字典。

示例：

e1_config = EmbeddingConfig(
    name="t1", embedding_dim=3, num_embeddings=10, feature_names=["f1"]
)
e2_config = EmbeddingConfig(
    name="t2", embedding_dim=3, num_embeddings=10, feature_names=["f2"]
)

ec = EmbeddingCollection(tables=[e1_config, e2_config])

#     0       1        2  <-- batch
# 0   [0,1] None    [2]
# 1   [3]    [4]    [5,6,7]
# ^
# feature

features = KeyedJaggedTensor.from_offsets_sync(
    keys=["f1", "f2"],
    values=torch.tensor([0, 1,                  2,    # feature 'f1'
                            3,      4,    5, 6, 7]),  # feature 'f2'
                    #    i = 1    i = 2    i = 3   <--- batch indices
    offsets=torch.tensor([
            0, 2, 2,       # 'f1' bags are values[0:2], values[2:2], and values[2:3]
            3, 4, 5, 8]),  # 'f2' bags are values[3:4], values[4:5], and values[5:8]
)

feature_embeddings = ec(features)
print(feature_embeddings['f2'].values())
tensor([
    # embedding for value 3 in f2 bag values[3:4]:
    [-0.2050,  0.5478,  0.6054],

    # embedding for value 4 in f2 bag values[4:5]:
    [ 0.7352,  0.3210, -3.0399],

    # embedding for values 5, 6, 7 in f2 bag values[5:8]:
    [ 0.1279, -0.1756, -0.4130],
    [ 0.7519, -0.4341, -0.0499],
    [ 0.9329, -1.0697, -0.8095],

], grad_fn=<EmbeddingBackward>)

property device: device¶: 返回: torch.device: 计算设备。

embedding_configs() → List[EmbeddingConfig]¶

Returns:: 嵌入配置。
Return type:: 列表[EmbeddingConfig]

embedding_dim() → int¶

Returns:: 嵌入维度。
Return type:: 整数

embedding_names_by_table() → List[List[str]]¶

Returns:: 按表的嵌入名称。
Return type:: 列表[列表[字符串]]

forward(features: KeyedJaggedTensor) → Dict[str, JaggedTensor]¶

运行EmbeddingBagCollection的前向传递。此方法接收一个KeyedJaggedTensor 并返回一个Dict[str, JaggedTensor]，这是每个特征的单独嵌入的结果。

Parameters:: 特征 (KeyedJaggedTensor) – 形式为 [F X B X L] 的 KJT。
Returns:: 字典[str, 锯齿张量]

need_indices() → bool¶

Returns:: EmbeddingCollection是否需要索引。
Return type:: 布尔

reset_parameters() → None¶: 重置EmbeddingCollection的参数。如果存在，参数值将根据每个EmbeddingConfig的init_fn进行初始化。