注意

点击这里下载完整的示例代码

TorchRec 简介

创建于：2024年10月2日 | 最后更新：2024年10月10日 | 最后验证：2024年10月2日

TorchRec 是一个专为使用嵌入构建可扩展且高效的推荐系统而设计的 PyTorch 库。本教程将引导您完成安装过程，介绍嵌入的概念，并强调其在推荐系统中的重要性。它提供了使用 PyTorch 和 TorchRec 实现嵌入的实用演示，重点是通过分布式训练和高级优化处理大型嵌入表。

What you will learn

嵌入的基础知识及其在推荐系统中的作用
如何在PyTorch环境中设置TorchRec以管理和实现嵌入
探索在多个GPU上分发大型嵌入表的高级技术

Prerequisites

PyTorch v2.5 或更高版本，CUDA 11.8 或更高版本
Python 3.9 或更高版本
FBGEMM

安装依赖

在Google Colab或其他环境中运行本教程之前，请安装以下依赖项：

!pip3 install --pre torch --index-url https://download.pytorch.org/whl/cu121 -U
!pip3 install fbgemm_gpu --index-url https://download.pytorch.org/whl/cu121
!pip3 install torchmetrics==1.0.3
!pip3 install torchrec --index-url https://download.pytorch.org/whl/cu121

注意

如果您在Google Colab中运行此操作，请确保切换到GPU运行时类型。有关更多信息，请参阅启用CUDA

嵌入

在构建推荐系统时，分类特征通常具有巨大的基数，如帖子、用户、广告等。

为了表示这些实体并建模这些关系，使用了嵌入。在机器学习中，嵌入是高维空间中的实数向量，用于表示复杂数据（如单词、图像或用户）中的意义。

TorchRec 功能概述

在上一节中，我们学习了如何使用嵌入表，这是现代推荐系统的基础之一！这些表代表实体和关系，例如用户、页面、帖子等。鉴于这些实体总是在增加，通常会应用哈希函数来确保ID在某个嵌入表的范围内。然而，为了表示大量实体并减少哈希冲突，这些表可能会变得非常庞大（例如，考虑广告的数量）。事实上，这些表可能会变得如此庞大，以至于即使有80G的内存，也无法在1个GPU上容纳。

为了训练具有大规模嵌入表的模型，需要将这些表分片到多个GPU上，这随后在并行性和优化方面引入了一系列全新的问题和机会。幸运的是，我们有TorchRec库，它已经遇到、整合并解决了许多这些问题。TorchRec作为一个提供大规模分布式嵌入原语的库。

接下来，我们将探讨TorchRec库的主要功能。我们将从torch.nn.Embedding开始，并将其扩展到自定义的TorchRec模块，探索分布式训练环境，生成嵌入的分片计划，查看TorchRec的固有优化，并将模型扩展到准备在C++中进行推理。以下是本节内容的简要概述：

TorchRec 模块和数据类型
分布式训练、分片和优化
推理

让我们从导入TorchRec开始：

import torchrec

本节介绍TorchRec模块和数据类型，包括诸如EmbeddingCollection和EmbeddingBagCollection、JaggedTensor、KeyedJaggedTensor、KeyedTensor等实体。

从`EmbeddingBag`到`EmbeddingBagCollection`

我们已经探讨了torch.nn.Embedding和torch.nn.EmbeddingBag。 TorchRec通过创建嵌入集合扩展了这些模块，换句话说，这些模块可以拥有多个嵌入表，使用 EmbeddingCollection和EmbeddingBagCollection。我们将使用EmbeddingBagCollection来表示一组嵌入包。

在下面的示例代码中，我们创建了一个EmbeddingBagCollection (EBC)，其中包含两个嵌入包，1个代表产品，1个代表用户。每个表，product_table和user_table，都由一个大小为4096的64维嵌入表示。

ebc = torchrec.EmbeddingBagCollection(
    device="cpu",
    tables=[
        torchrec.EmbeddingBagConfig(
            name="product_table",
            embedding_dim=64,
            num_embeddings=4096,
            feature_names=["product"],
            pooling=torchrec.PoolingType.SUM,
        ),
        torchrec.EmbeddingBagConfig(
            name="user_table",
            embedding_dim=64,
            num_embeddings=4096,
            feature_names=["user"],
            pooling=torchrec.PoolingType.SUM,
        )
    ]
)
print(ebc.embedding_bags)

ModuleDict(
  (product_table): EmbeddingBag(4096, 64, mode='sum')
  (user_table): EmbeddingBag(4096, 64, mode='sum')
)

让我们检查一下EmbeddingBagCollection的前向方法以及模块的输入和输出：

import inspect

# Let's look at the ``EmbeddingBagCollection`` forward method
# What is a ``KeyedJaggedTensor`` and ``KeyedTensor``?
print(inspect.getsource(ebc.forward))

def forward(self, features: KeyedJaggedTensor) -> KeyedTensor:
    """
    Run the EmbeddingBagCollection forward pass. This method takes in a `KeyedJaggedTensor`
    and returns a `KeyedTensor`, which is the result of pooling the embeddings for each feature.

    Args:
        features (KeyedJaggedTensor): Input KJT
    Returns:
        KeyedTensor
    """
    flat_feature_names: List[str] = []
    for names in self._feature_names:
        flat_feature_names.extend(names)
    inverse_indices = reorder_inverse_indices(
        inverse_indices=features.inverse_indices_or_none(),
        feature_names=flat_feature_names,
    )
    pooled_embeddings: List[torch.Tensor] = []
    feature_dict = features.to_dict()
    for i, embedding_bag in enumerate(self.embedding_bags.values()):
        for feature_name in self._feature_names[i]:
            f = feature_dict[feature_name]
            res = embedding_bag(
                input=f.values(),
                offsets=f.offsets(),
                per_sample_weights=f.weights() if self._is_weighted else None,
            ).float()
            pooled_embeddings.append(res)
    return KeyedTensor(
        keys=self._embedding_names,
        values=process_pooled_embeddings(
            pooled_embeddings=pooled_embeddings,
            inverse_indices=inverse_indices,
        ),
        length_per_key=self._lengths_per_embedding,
    )

TorchRec 输入/输出数据类型

TorchRec 为其模块的输入和输出定义了独特的数据类型： JaggedTensor, KeyedJaggedTensor, 和 KeyedTensor。现在你可能会问，为什么要创建新的数据类型来表示稀疏特征？为了回答这个问题，我们必须理解稀疏特征在代码中是如何表示的。

稀疏特征也被称为id_list_feature和id_score_list_feature，它们是ID，将用作嵌入表的索引以检索该ID的嵌入。举一个非常简单的例子，想象一个单一的稀疏特征是用户与之互动的广告。输入本身将是用户与之互动的一组广告ID，检索到的嵌入将是这些广告的语义表示。在代码中表示这些特征的棘手之处在于，在每个输入示例中，ID的数量是可变的。某一天用户可能只与一个广告互动，而第二天他们可能与三个广告互动。

下面展示了一个简单的表示，其中我们有一个lengths张量，表示一个批次中每个示例的索引数量，以及一个values张量，包含索引本身。

# Batch Size 2
# 1 ID in example 1, 2 IDs in example 2
id_list_feature_lengths = torch.tensor([1, 2])

# Values (IDs) tensor: ID 5 is in example 1, ID 7, 1 is in example 2
id_list_feature_values = torch.tensor([5, 7, 1])

接下来，我们来看看偏移量以及每个批次中包含的内容

# Lengths can be converted to offsets for easy indexing of values
id_list_feature_offsets = torch.cumsum(id_list_feature_lengths, dim=0)

print("Offsets: ", id_list_feature_offsets)
print("First Batch: ", id_list_feature_values[: id_list_feature_offsets[0]])
print(
    "Second Batch: ",
    id_list_feature_values[id_list_feature_offsets[0] : id_list_feature_offsets[1]],
)

from torchrec import JaggedTensor

# ``JaggedTensor`` is just a wrapper around lengths/offsets and values tensors!
jt = JaggedTensor(values=id_list_feature_values, lengths=id_list_feature_lengths)

# Automatically compute offsets from lengths
print("Offsets: ", jt.offsets())

# Convert to list of values
print("List of Values: ", jt.to_dense())

# ``__str__`` representation
print(jt)

from torchrec import KeyedJaggedTensor

# ``JaggedTensor`` represents IDs for 1 feature, but we have multiple features in an ``EmbeddingBagCollection``
# That's where ``KeyedJaggedTensor`` comes in! ``KeyedJaggedTensor`` is just multiple ``JaggedTensors`` for multiple id_list_feature_offsets
# From before, we have our two features "product" and "user". Let's create ``JaggedTensors`` for both!

product_jt = JaggedTensor(
    values=torch.tensor([1, 2, 1, 5]), lengths=torch.tensor([3, 1])
)
user_jt = JaggedTensor(values=torch.tensor([2, 3, 4, 1]), lengths=torch.tensor([2, 2]))

# Q1: How many batches are there, and which values are in the first batch for ``product_jt`` and ``user_jt``?
kjt = KeyedJaggedTensor.from_jt_dict({"product": product_jt, "user": user_jt})

# Look at our feature keys for the ``KeyedJaggedTensor``
print("Keys: ", kjt.keys())

# Look at the overall lengths for the ``KeyedJaggedTensor``
print("Lengths: ", kjt.lengths())

# Look at all values for ``KeyedJaggedTensor``
print("Values: ", kjt.values())

# Can convert ``KeyedJaggedTensor`` to dictionary representation
print("to_dict: ", kjt.to_dict())

# ``KeyedJaggedTensor`` string representation
print(kjt)

# Q2: What are the offsets for the ``KeyedJaggedTensor``?

# Now we can run a forward pass on our ``EmbeddingBagCollection`` from before
result = ebc(kjt)
result

# Result is a ``KeyedTensor``, which contains a list of the feature names and the embedding results
print(result.keys())

# The results shape is [2, 128], as batch size of 2. Reread previous section if you need a refresher on how the batch size is determined
# 128 for dimension of embedding. If you look at where we initialized the ``EmbeddingBagCollection``, we have two tables "product" and "user" of dimension 64 each
# meaning embeddings for both features are of size 64. 64 + 64 = 128
print(result.values().shape)

# Nice to_dict method to determine the embeddings that belong to each feature
result_dict = result.to_dict()
for key, embedding in result_dict.items():
    print(key, embedding.shape)

Offsets:  tensor([1, 3])
First Batch:  tensor([5])
Second Batch:  tensor([7, 1])
Offsets:  tensor([0, 1, 3])
List of Values:  [tensor([5]), tensor([7, 1])]
JaggedTensor({
    [[5], [7, 1]]
})

Keys:  ['product', 'user']
Lengths:  tensor([3, 1, 2, 2])
Values:  tensor([1, 2, 1, 5, 2, 3, 4, 1])
to_dict:  {'product': <torchrec.sparse.jagged_tensor.JaggedTensor object at 0x7f4edb57c940>, 'user': <torchrec.sparse.jagged_tensor.JaggedTensor object at 0x7f4edb57c9a0>}
KeyedJaggedTensor({
    "product": [[1, 2, 1], [5]],
    "user": [[2, 3], [4, 1]]
})

['product', 'user']
torch.Size([2, 128])
product torch.Size([2, 64])
user torch.Size([2, 64])

恭喜！你现在已经理解了TorchRec模块和数据类型。为自己走到这一步而鼓掌。接下来，我们将学习分布式训练和分片。

分布式训练和分片

既然我们已经掌握了TorchRec模块和数据类型，是时候将其提升到下一个层次了。

请记住，TorchRec的主要目的是为分布式嵌入提供原语。到目前为止，我们只在单个设备上处理嵌入表。鉴于嵌入表的大小，这是可能的，但在生产环境中，这通常不是情况。嵌入表通常会变得非常大，以至于一个表无法适应单个GPU，从而需要多个设备和分布式环境。

在本节中，我们将探讨如何设置分布式环境，确切了解实际生产训练是如何完成的，并探索使用TorchRec进行分片嵌入表。

本节也将仅使用1个GPU，尽管它将以分布式方式处理。这只是训练的一个限制，因为训练每个GPU都有一个进程。推理不需要满足此要求

在下面的示例代码中，我们设置了我们的PyTorch分布式环境。

警告

如果您在Google Colab中运行此操作，您只能调用此单元格一次，再次调用会导致错误，因为您只能初始化进程组一次。

import os

import torch.distributed as dist

# Set up environment variables for distributed training
# RANK is which GPU we are on, default 0
os.environ["RANK"] = "0"
# How many devices in our "world", colab notebook can only handle 1 process
os.environ["WORLD_SIZE"] = "1"
# Localhost as we are training locally
os.environ["MASTER_ADDR"] = "localhost"
# Port for distributed training
os.environ["MASTER_PORT"] = "29500"

# nccl backend is for GPUs, gloo is for CPUs
dist.init_process_group(backend="gloo")

print(f"Distributed environment initialized: {dist}")

Distributed environment initialized: <module 'torch.distributed' from '/usr/local/lib/python3.10/dist-packages/torch/distributed/__init__.py'>

分布式嵌入

我们已经使用了主要的TorchRec模块： EmbeddingBagCollection。我们已经研究了它的工作原理以及数据在TorchRec中的表示方式。然而，我们还没有探索TorchRec的一个主要部分，那就是分布式嵌入。

迄今为止，GPU是机器学习工作负载中最受欢迎的选择，因为它们能够执行比CPU更多的浮点运算/秒（FLOPs）。然而，GPU的局限性在于其快速内存（HBM，类似于CPU的RAM）稀缺，通常只有约几十GB。

一个RecSys模型可能包含远远超过单个GPU内存限制的嵌入表，因此需要将嵌入表分布在多个GPU上，这被称为模型并行。另一方面，数据并行是指整个模型在每个GPU上复制，每个GPU接收不同的数据批次进行训练，在反向传播时同步梯度。

模型中需要较少计算但较多内存的部分（嵌入）通过模型并行进行分布，而需要较多计算但较少内存的部分（密集层、MLP等）通过数据并行进行分布。

分片

为了分发嵌入表，我们将嵌入表分成多个部分，并将这些部分放置在不同的设备上，这也被称为“分片”。

有许多方法可以对嵌入表进行分片。最常见的方法是：

表级：表完全放置在一个设备上
按列：嵌入表的列被分片
行方式：嵌入表的行被分片

分片模块

虽然所有这些看起来需要处理和实施的内容很多，但你是幸运的。TorchRec 提供了所有原语，以便于进行分布式训练和推理！事实上，TorchRec 模块有两个相应的类，用于在分布式环境中处理任何 TorchRec 模块：

模块分片器: 这个类暴露了一个shard API 用于处理TorchRec模块的分片，生成一个分片后的模块。 * 对于EmbeddingBagCollection，分片器是EmbeddingBagCollectionSharder
分片模块: 这个类是TorchRec模块的一个分片变体。它与常规的TorchRec模块具有相同的输入/输出，但更加优化，并且可以在分布式环境中工作。 * 对于EmbeddingBagCollection，分片变体是ShardedEmbeddingBagCollection

每个TorchRec模块都有一个未分片和分片的变体。

未分片版本旨在用于原型设计和实验。
分片版本旨在用于分布式环境中的分布式训练和推理。

TorchRec模块的分片版本，例如EmbeddingBagCollection，将处理模型并行所需的一切，例如在GPU之间进行通信以将嵌入分配到正确的GPU。

我们的EmbeddingBagCollection模块的复习

ebc

from torchrec.distributed.embeddingbag import EmbeddingBagCollectionSharder
from torchrec.distributed.planner import EmbeddingShardingPlanner, Topology
from torchrec.distributed.types import ShardingEnv

# Corresponding sharder for ``EmbeddingBagCollection`` module
sharder = EmbeddingBagCollectionSharder()

# ``ProcessGroup`` from torch.distributed initialized 2 cells above
pg = dist.GroupMember.WORLD
assert pg is not None, "Process group is not initialized"

print(f"Process Group: {pg}")

Process Group: <torch.distributed.distributed_c10d.ProcessGroup object at 0x7f50a8c5cf30>

计划器

在我们展示分片如何工作之前，我们必须了解规划器，它帮助我们确定最佳的分片配置。

给定多个嵌入表和多个等级，有许多不同的分片配置是可能的。例如，给定2个嵌入表和2个GPU，你可以：

在每个GPU上放置1个表
将两个表放在一个GPU上，另一个GPU上不放任何表
将某些行和列放置在每个GPU上

考虑到所有这些可能性，我们通常需要一个对性能最优的分片配置。

这就是规划器发挥作用的地方。规划器能够根据嵌入表的数量和GPU的数量，确定最佳的配置。事实证明，手动完成这项工作非常困难，工程师需要考虑大量因素以确保最佳的分片计划。幸运的是，当使用规划器时，TorchRec提供了一个自动规划器。

TorchRec 规划器：

评估硬件的内存限制
基于内存获取的估计计算作为嵌入查找
解决数据特定因素
考虑其他硬件特性，如带宽，以生成最佳的分片计划

为了考虑所有这些变量，TorchRec规划器可以接收各种数量的数据用于嵌入表、约束、硬件信息和拓扑，以帮助生成模型的最佳分片计划，这通常在整个堆栈中提供。

要了解更多关于分片的信息，请参阅我们的分片教程。

# In our case, 1 GPU and compute on CUDA device
planner = EmbeddingShardingPlanner(
    topology=Topology(
        world_size=1,
        compute_device="cuda",
    )
)

# Run planner to get plan for sharding
plan = planner.collective_plan(ebc, [sharder], pg)

print(f"Sharding Plan generated: {plan}")

Sharding Plan generated: module:

    param     | sharding type | compute kernel | ranks
------------- | ------------- | -------------- | -----
product_table | table_wise    | fused          | [0]
user_table    | table_wise    | fused          | [0]

    param     | shard offsets | shard sizes |   placement
------------- | ------------- | ----------- | -------------
product_table | [0, 0]        | [4096, 64]  | rank:0/cuda:0
user_table    | [0, 0]        | [4096, 64]  | rank:0/cuda:0

规划器结果

如上所示，运行规划器时会有相当多的输出。我们可以看到许多统计数据被计算出来，以及我们的表最终被放置的位置。

运行规划器的结果是一个静态计划，可以重复用于分片！这使得生产模型的分片可以保持静态，而不是每次确定一个新的分片计划。下面，我们使用分片计划最终生成我们的ShardedEmbeddingBagCollection。

# The static plan that was generated
plan

env = ShardingEnv.from_process_group(pg)

# Shard the ``EmbeddingBagCollection`` module using the ``EmbeddingBagCollectionSharder``
sharded_ebc = sharder.shard(ebc, plan.plan[""], env, torch.device("cuda"))

print(f"Sharded EBC Module: {sharded_ebc}")

Sharded EBC Module: ShardedEmbeddingBagCollection(
  (lookups):
   GroupedPooledEmbeddingsLookup(
      (_emb_modules): ModuleList(
        (0): BatchedFusedEmbeddingBag(
          (_emb_module): SplitTableBatchedEmbeddingBagsCodegen()
        )
      )
    )
   (_output_dists):
   TwPooledEmbeddingDist()
  (embedding_bags): ModuleDict(
    (product_table): Module()
    (user_table): Module()
  )
)

使用`LazyAwaitable`进行GPU训练

请记住，TorchRec 是一个高度优化的分布式嵌入库。TorchRec 引入的一个概念是 LazyAwaitable，它可以在 GPU 上进行更高性能的训练。您会看到 LazyAwaitable 类型作为各种分片 TorchRec 模块的输出。LazyAwaitable 类型的作用是尽可能延迟计算某些结果，它通过表现得像一个异步类型来实现这一点。

from typing import List

from torchrec.distributed.types import LazyAwaitable


# Demonstrate a ``LazyAwaitable`` type:
class ExampleAwaitable(LazyAwaitable[torch.Tensor]):
    def __init__(self, size: List[int]) -> None:
        super().__init__()
        self._size = size

    def _wait_impl(self) -> torch.Tensor:
        return torch.ones(self._size)


awaitable = ExampleAwaitable([3, 2])
awaitable.wait()

kjt = kjt.to("cuda")
output = sharded_ebc(kjt)
# The output of our sharded ``EmbeddingBagCollection`` module is an `Awaitable`?
print(output)

kt = output.wait()
# Now we have our ``KeyedTensor`` after calling ``.wait()``
# If you are confused as to why we have a ``KeyedTensor ``output,
# give yourself a refresher on the unsharded ``EmbeddingBagCollection`` module
print(type(kt))

print(kt.keys())

print(kt.values().shape)

# Same output format as unsharded ``EmbeddingBagCollection``
result_dict = kt.to_dict()
for key, embedding in result_dict.items():
    print(key, embedding.shape)

<torchrec.distributed.embeddingbag.EmbeddingBagCollectionAwaitable object at 0x7f4ed824a9e0>
<class 'torchrec.sparse.jagged_tensor.KeyedTensor'>
['product', 'user']
torch.Size([2, 128])
product torch.Size([2, 64])
user torch.Size([2, 64])

分片 TorchRec 模块的剖析

我们现在已经成功地根据生成的切分计划对EmbeddingBagCollection进行了切分！切分后的模块具有来自TorchRec的通用API，这些API抽象了多个GPU之间的分布式通信/计算。事实上，这些API在训练和推理性能方面进行了高度优化。以下是TorchRec提供的用于分布式训练/推理的三个常见API：

input_dist: 处理从GPU到GPU的输入分发。
lookups: 使用FBGEMM TBE以优化的批处理方式进行实际的嵌入查找（稍后会详细介绍）。
output_dist: 处理从GPU到GPU的输出分发。

输入和输出的分布是通过NCCL集合完成的，即All-to-Alls，这是所有GPU相互发送和接收数据的地方。TorchRec与PyTorch分布式接口用于集合操作，并为最终用户提供清晰的抽象，消除了对低级细节的担忧。

反向传播执行所有这些集合操作，但以相反的顺序进行梯度的分发。input_dist、lookup和output_dist都依赖于分片方案。由于我们以表为单位进行分片，这些API是由TwPooledEmbeddingSharding构建的模块。

sharded_ebc

# Distribute input KJTs to all other GPUs and receive KJTs
sharded_ebc._input_dists

# Distribute output embeddings to all other GPUs and receive embeddings
sharded_ebc._output_dists

[TwPooledEmbeddingDist(
  (_dist): PooledEmbeddingsAllToAll()
)]

优化嵌入查找

在为嵌入表集合执行查找时，一个简单的解决方案是遍历所有的nn.EmbeddingBags并为每个表进行查找。这正是标准的、未分片的EmbeddingBagCollection所做的。然而，虽然这个解决方案简单，但它非常慢。

FBGEMM 是一个提供高度优化的GPU操作符（也称为内核）的库。其中一个操作符被称为Table Batched Embedding (TBE)，它提供了两个主要的优化：

表批处理，允许您通过一次内核调用查找多个嵌入。
优化器融合，允许模块在给定规范的pytorch优化器和参数的情况下自我更新。

ShardedEmbeddingBagCollection 使用 FBGEMM TBE 作为查找方式，而不是传统的 nn.EmbeddingBags，以优化嵌入查找。

sharded_ebc._lookups

[GroupedPooledEmbeddingsLookup(
  (_emb_modules): ModuleList(
    (0): BatchedFusedEmbeddingBag(
      (_emb_module): SplitTableBatchedEmbeddingBagsCodegen()
    )
  )
)]

`DistributedModelParallel`

我们现在已经探索了如何对一个单一的EmbeddingBagCollection进行分片！我们能够使用EmbeddingBagCollectionSharder并利用未分片的EmbeddingBagCollection来生成一个ShardedEmbeddingBagCollection模块。这个工作流程是可行的，但通常在实现模型并行时，DistributedModelParallel（DMP）被用作标准接口。当用DMP包装你的模型（在我们的例子中是ebc）时，将会发生以下情况：

决定如何对模型进行分片。DMP 将收集可用的分片器，并制定一个最优的分片计划，用于分片嵌入表（例如，EmbeddingBagCollection）
实际上对模型进行分片。这包括为每个嵌入表在适当的设备上分配内存。

DMP 接收了我们刚刚实验的所有内容，比如静态分片计划、分片器列表等。然而，它也有一些很好的默认设置，可以无缝地对 TorchRec 模型进行分片。在这个简单的示例中，由于我们有两个嵌入表和一个 GPU，TorchRec 会将两者都放在单个 GPU 上。

ebc

model = torchrec.distributed.DistributedModelParallel(ebc, device=torch.device("cuda"))

out = model(kjt)
out.wait()

model

WARNING:root:Could not determine LOCAL_WORLD_SIZE from environment, falling back to WORLD_SIZE.

DistributedModelParallel(
  (_dmp_wrapped_module): ShardedEmbeddingBagCollection(
    (lookups):
     GroupedPooledEmbeddingsLookup(
        (_emb_modules): ModuleList(
          (0): BatchedFusedEmbeddingBag(
            (_emb_module): SplitTableBatchedEmbeddingBagsCodegen()
          )
        )
      )
     (_input_dists):
     TwSparseFeaturesDist(
        (_dist): KJTAllToAll()
      )
     (_output_dists):
     TwPooledEmbeddingDist(
        (_dist): PooledEmbeddingsAllToAll()
      )
    (embedding_bags): ModuleDict(
      (product_table): Module()
      (user_table): Module()
    )
  )
)

分片最佳实践

目前，我们的配置仅在1个GPU（或等级）上进行分片，这很简单：只需将所有表放在1个GPU的内存中。然而，在实际生产用例中，嵌入表通常在数百个GPU上进行分片，采用不同的分片方法，如表级、行级和列级。确定适当的分片配置（以防止内存不足问题）非常重要，同时不仅要保持内存平衡，还要保持计算平衡，以实现最佳性能。

添加优化器

请记住，TorchRec模块针对大规模分布式训练进行了高度优化。其中一个重要的优化是关于优化器的。

TorchRec模块提供了一个无缝的API，用于融合训练中的反向传播和优化步骤，从而显著优化性能并减少内存使用，同时还可以为不同的模型参数分配不同的优化器。

优化器类

TorchRec 使用 CombinedOptimizer，它包含一组 KeyedOptimizers。一个 CombinedOptimizer 有效地简化了处理模型中各种子组的多个优化器。一个 KeyedOptimizer 扩展了 torch.optim.Optimizer 并且通过参数字典初始化并暴露这些参数。每个 EmbeddingBagCollection 中的 TBE 模块都会有它自己的 KeyedOptimizer，这些优化器会合并成一个 CombinedOptimizer。

TorchRec中的融合优化器

使用DistributedModelParallel时，优化器是融合的，这意味着优化器更新在反向传播过程中完成。这是TorchRec和FBGEMM中的一项优化，其中优化器嵌入梯度不会被具体化，而是直接应用于参数。这带来了显著的内存节省，因为嵌入梯度通常与参数本身的大小相同。

然而，您可以选择使优化器dense，这样就不会应用此优化，并允许您检查嵌入梯度或根据需要对其应用计算。在这种情况下，密集优化器将是您的带有优化器的标准PyTorch模型训练循环。

一旦通过DistributedModelParallel创建了优化器，你仍然需要管理一个优化器来处理与TorchRec嵌入模块无关的其他参数。要找到这些参数，请使用in_backward_optimizer_filter(model.named_parameters())。像处理普通的Torch优化器一样对这些参数应用优化器，并将其与model.fused_optimizer结合成一个CombinedOptimizer，你可以在训练循环中使用它来zero_grad和step。

向`EmbeddingBagCollection`添加优化器

我们将以两种方式完成此操作，这两种方式是等效的，但根据您的偏好提供选择：

通过sharder中的fused_params传递优化器参数。
通过apply_optimizer_in_backward，将优化器参数转换为fused_params，以传递给EmbeddingBagCollection或EmbeddingCollection中的TBE。

# Option 1: Passing optimizer kwargs through fused parameters
from torchrec.optim.optimizers import in_backward_optimizer_filter
from fbgemm_gpu.split_embedding_configs import EmbOptimType


# We initialize the sharder with
fused_params = {
    "optimizer": EmbOptimType.EXACT_ROWWISE_ADAGRAD,
    "learning_rate": 0.02,
    "eps": 0.002,
}

# Initialize sharder with ``fused_params``
sharder_with_fused_params = EmbeddingBagCollectionSharder(fused_params=fused_params)

# We'll use same plan and unsharded EBC as before but this time with our new sharder
sharded_ebc_fused_params = sharder_with_fused_params.shard(ebc, plan.plan[""], env, torch.device("cuda"))

# Looking at the optimizer of each, we can see that the learning rate changed, which indicates our optimizer has been applied correctly.
# If seen, we can also look at the TBE logs of the cell to see that our new optimizer is indeed being applied
print(f"Original Sharded EBC fused optimizer: {sharded_ebc.fused_optimizer}")
print(f"Sharded EBC with fused parameters fused optimizer: {sharded_ebc_fused_params.fused_optimizer}")

print(f"Type of optimizer: {type(sharded_ebc_fused_params.fused_optimizer)}")

from torch.distributed.optim import _apply_optimizer_in_backward as apply_optimizer_in_backward
import copy
# Option 2: Applying optimizer through apply_optimizer_in_backward
# Note: we need to call apply_optimizer_in_backward on unsharded model first and then shard it

# We can achieve the same result as we did in the previous
ebc_apply_opt = copy.deepcopy(ebc)
optimizer_kwargs = {"lr": 0.5}

for name, param in ebc_apply_opt.named_parameters():
    print(f"{name=}")
    apply_optimizer_in_backward(torch.optim.SGD, [param], optimizer_kwargs)

sharded_ebc_apply_opt = sharder.shard(ebc_apply_opt, plan.plan[""], env, torch.device("cuda"))

# Now when we print the optimizer, we will see our new learning rate, you can verify momentum through the TBE logs as well if outputted
print(sharded_ebc_apply_opt.fused_optimizer)
print(type(sharded_ebc_apply_opt.fused_optimizer))

# We can also check through the filter other parameters that aren't associated with the "fused" optimizer(s)
# Practically, just non TorchRec module parameters. Since our module is just a TorchRec EBC
# there are no other parameters that aren't associated with TorchRec
print("Non Fused Model Parameters:")
print(dict(in_backward_optimizer_filter(sharded_ebc_fused_params.named_parameters())).keys())

# Here we do a dummy backwards call and see that parameter updates for fused
# optimizers happen as a result of the backward pass

ebc_output = sharded_ebc_fused_params(kjt).wait().values()
loss = torch.sum(torch.ones_like(ebc_output) - ebc_output)
print(f"First Iteration Loss: {loss}")

loss.backward()

ebc_output = sharded_ebc_fused_params(kjt).wait().values()
loss = torch.sum(torch.ones_like(ebc_output) - ebc_output)
# We don't call an optimizer.step(), so for the loss to have changed here,
# that means that the gradients were somehow updated, which is what the
# fused optimizer automatically handles for us
print(f"Second Iteration Loss: {loss}")

Original Sharded EBC fused optimizer: : EmbeddingFusedOptimizer (
Parameter Group 0
    lr: 0.01
)
Sharded EBC with fused parameters fused optimizer: : EmbeddingFusedOptimizer (
Parameter Group 0
    lr: 0.02
)
Type of optimizer: <class 'torchrec.optim.keyed.CombinedOptimizer'>
/var/lib/workspace/intermediate_source/torchrec_intro_tutorial.py:876: DeprecationWarning:

`TorchScript` support for functional optimizers is deprecated and will be removed in a future PyTorch release. Consider using the `torch.compile` optimizer instead.

name='embedding_bags.product_table.weight'
name='embedding_bags.user_table.weight'
: EmbeddingFusedOptimizer (
Parameter Group 0
    lr: 0.5
)
<class 'torchrec.optim.keyed.CombinedOptimizer'>
Non Fused Model Parameters:
dict_keys([])
First Iteration Loss: 255.66006469726562
Second Iteration Loss: 245.43795776367188

推理

既然我们已经能够训练分布式嵌入，那么我们如何获取训练好的模型并对其进行优化以进行推理呢？推理通常对模型的性能和大小非常敏感。仅仅在Python环境中运行训练好的模型是非常低效的。推理环境和训练环境之间有两个关键区别：

量化: 推理模型通常会被量化，其中模型参数会失去精度以降低预测延迟并减少模型大小。例如，训练模型中的FP32（4字节）到每个嵌入权重的INT8（1字节）。考虑到嵌入表的巨大规模，这也是必要的，因为我们希望在推理时使用尽可能少的设备以最小化延迟。
C++环境: 推理延迟非常重要，因此为了确保充足的性能，模型通常在C++环境中运行，特别是在我们没有Python运行时的场景下，比如在设备上。

TorchRec 提供了将 TorchRec 模型转换为推理就绪状态的原语：

用于量化模型的API，使用FBGEMM TBE自动引入优化
用于分布式推理的分片嵌入
将模型编译为TorchScript （在C++中兼容）

在本节中，我们将介绍以下整个工作流程：

量化模型
分片量化模型
将分片量化模型编译为TorchScript

ebc

class InferenceModule(torch.nn.Module):
    def __init__(self, ebc: torchrec.EmbeddingBagCollection):
        super().__init__()
        self.ebc_ = ebc

    def forward(self, kjt: KeyedJaggedTensor):
        return self.ebc_(kjt)

module = InferenceModule(ebc)
for name, param in module.named_parameters():
    # Here, the parameters should still be FP32, as we are using a standard EBC
    # FP32 is default, regularly used for training
    print(name, param.shape, param.dtype)

ebc_.embedding_bags.product_table.weight torch.Size([4096, 64]) torch.float32
ebc_.embedding_bags.user_table.weight torch.Size([4096, 64]) torch.float32

量化

如上所示，普通的EBC包含嵌入表权重为FP32精度（每个权重32位）。在这里，我们将使用TorchRec推理库将模型的嵌入权重量化为INT8。

from torch import quantization as quant
from torchrec.modules.embedding_configs import QuantConfig
from torchrec.quant.embedding_modules import (
    EmbeddingBagCollection as QuantEmbeddingBagCollection,
)


quant_dtype = torch.int8


qconfig = QuantConfig(
    # dtype of the result of the embedding lookup, post activation
    # torch.float generally for compatibility with rest of the model
    # as rest of the model here usually isn't quantized
    activation=quant.PlaceholderObserver.with_args(dtype=torch.float),
    # quantized type for embedding weights, aka parameters to actually quantize
    weight=quant.PlaceholderObserver.with_args(dtype=quant_dtype),
)
qconfig_spec = {
    # Map of module type to qconfig
    torchrec.EmbeddingBagCollection: qconfig,
}
mapping = {
    # Map of module type to quantized module type
    torchrec.EmbeddingBagCollection: QuantEmbeddingBagCollection,
}


module = InferenceModule(ebc)

# Quantize the module
qebc = quant.quantize_dynamic(
    module,
    qconfig_spec=qconfig_spec,
    mapping=mapping,
    inplace=False,
)


print(f"Quantized EBC: {qebc}")

kjt = kjt.to("cpu")

qebc(kjt)

# Once quantized, goes from parameters -> buffers, as no longer trainable
for name, buffer in qebc.named_buffers():
    # The shapes of the tables should be the same but the dtype should be int8 now
    # post quantization
    print(name, buffer.shape, buffer.dtype)

Quantized EBC: InferenceModule(
  (ebc_): QuantizedEmbeddingBagCollection(
    (_kjt_to_jt_dict): ComputeKJTToJTDict()
    (embedding_bags): ModuleDict(
      (product_table): Module()
      (user_table): Module()
    )
  )
)
ebc_.embedding_bags.product_table.weight torch.Size([4096, 80]) torch.uint8
ebc_.embedding_bags.user_table.weight torch.Size([4096, 80]) torch.uint8

分片

在这里，我们对TorchRec量化模型进行分片。这是为了确保我们通过FBGEMM TBE使用高性能模块。在这里，我们使用一个设备以保持与训练的一致性（1个TBE）。

from torchrec import distributed as trec_dist
from torchrec.distributed.shard import _shard_modules


sharded_qebc = _shard_modules(
    module=qebc,
    device=torch.device("cpu"),
    env=trec_dist.ShardingEnv.from_local(
        1,
        0,
    ),
)


print(f"Sharded Quantized EBC: {sharded_qebc}")

sharded_qebc(kjt)

WARNING:root:Could not determine LOCAL_WORLD_SIZE from environment, falling back to WORLD_SIZE.
Sharded Quantized EBC: InferenceModule(
  (ebc_): ShardedQuantEmbeddingBagCollection(
    (lookups):
     InferGroupedPooledEmbeddingsLookup()
    (_output_dists): ModuleList()
    (embedding_bags): ModuleDict(
      (product_table): Module()
      (user_table): Module()
    )
    (_input_dist_module): ShardedQuantEbcInputDist()
  )
)

<torchrec.sparse.jagged_tensor.KeyedTensor object at 0x7f4ed828c310>

编译

现在我们有了优化的急切 TorchRec 推理模型。下一步是确保该模型可以在 C++ 中加载，因为目前它只能在 Python 运行时中运行。

在Meta推荐的编译方法是双重的：torch.fx 跟踪（生成模型的中间表示）并将结果转换为TorchScript，其中TorchScript与C++兼容。

from torchrec.fx import Tracer

tracer = Tracer(leaf_modules=["IntNBitTableBatchedEmbeddingBagsCodegen"])

graph = tracer.trace(sharded_qebc)
gm = torch.fx.GraphModule(sharded_qebc, graph)

print("Graph Module Created!")

print(gm.code)

scripted_gm = torch.jit.script(gm)
print("Scripted Graph Module Created!")

print(scripted_gm.code)

Graph Module Created!

torch.fx._symbolic_trace.wrap("torchrec_distributed_quant_embeddingbag_flatten_feature_lengths")
torch.fx._symbolic_trace.wrap("torchrec_fx_utils__fx_marker")
torch.fx._symbolic_trace.wrap("torchrec_distributed_quant_embedding_kernel__unwrap_kjt")
torch.fx._symbolic_trace.wrap("torchrec_distributed_embedding_lookup_embeddings_cat_empty_rank_handle_inference")

def forward(self, kjt : torchrec_sparse_jagged_tensor_KeyedJaggedTensor):
    flatten_feature_lengths = torchrec_distributed_quant_embeddingbag_flatten_feature_lengths(kjt);  kjt = None
    _fx_marker = torchrec_fx_utils__fx_marker('KJT_ONE_TO_ALL_FORWARD_BEGIN', flatten_feature_lengths);  _fx_marker = None
    split = flatten_feature_lengths.split([2])
    getitem = split[0];  split = None
    to = getitem.to(device(type='cuda', index=0), non_blocking = True);  getitem = None
    _fx_marker_1 = torchrec_fx_utils__fx_marker('KJT_ONE_TO_ALL_FORWARD_END', flatten_feature_lengths);  flatten_feature_lengths = _fx_marker_1 = None
    _unwrap_kjt = torchrec_distributed_quant_embedding_kernel__unwrap_kjt(to);  to = None
    getitem_1 = _unwrap_kjt[0]
    getitem_2 = _unwrap_kjt[1]
    getitem_3 = _unwrap_kjt[2];  _unwrap_kjt = getitem_3 = None
    _tensor_constant0 = self._tensor_constant0
    _tensor_constant1 = self._tensor_constant1
    bounds_check_indices = torch.ops.fbgemm.bounds_check_indices(_tensor_constant0, getitem_1, getitem_2, 1, _tensor_constant1, None);  _tensor_constant0 = _tensor_constant1 = bounds_check_indices = None
    _tensor_constant2 = self._tensor_constant2
    _tensor_constant3 = self._tensor_constant3
    _tensor_constant4 = self._tensor_constant4
    _tensor_constant5 = self._tensor_constant5
    _tensor_constant6 = self._tensor_constant6
    _tensor_constant7 = self._tensor_constant7
    _tensor_constant8 = self._tensor_constant8
    _tensor_constant9 = self._tensor_constant9
    int_nbit_split_embedding_codegen_lookup_function = torch.ops.fbgemm.int_nbit_split_embedding_codegen_lookup_function(dev_weights = _tensor_constant2, uvm_weights = _tensor_constant3, weights_placements = _tensor_constant4, weights_offsets = _tensor_constant5, weights_tys = _tensor_constant6, D_offsets = _tensor_constant7, total_D = 128, max_int2_D = 0, max_int4_D = 0, max_int8_D = 64, max_float16_D = 0, max_float32_D = 0, indices = getitem_1, offsets = getitem_2, pooling_mode = 0, indice_weights = None, output_dtype = 0, lxu_cache_weights = _tensor_constant8, lxu_cache_locations = _tensor_constant9, row_alignment = 16, max_float8_D = 0, fp8_exponent_bits = -1, fp8_exponent_bias = -1);  _tensor_constant2 = _tensor_constant3 = _tensor_constant4 = _tensor_constant5 = _tensor_constant6 = _tensor_constant7 = getitem_1 = getitem_2 = _tensor_constant8 = _tensor_constant9 = None
    embeddings_cat_empty_rank_handle_inference = torchrec_distributed_embedding_lookup_embeddings_cat_empty_rank_handle_inference([int_nbit_split_embedding_codegen_lookup_function], dim = 1, device = 'cuda:0', dtype = torch.float32);  int_nbit_split_embedding_codegen_lookup_function = None
    to_1 = embeddings_cat_empty_rank_handle_inference.to(device(type='cpu'));  embeddings_cat_empty_rank_handle_inference = None
    keyed_tensor = torchrec_sparse_jagged_tensor_KeyedTensor(keys = ['product', 'user'], length_per_key = [64, 64], values = to_1, key_dim = 1);  to_1 = None
    return keyed_tensor

/usr/local/lib/python3.10/dist-packages/torch/jit/_check.py:178: UserWarning:

The TorchScript type system doesn't support instance-level annotations on empty non-base types in `__init__`. Instead, either 1) use a type annotation in the class body, or 2) wrap the type in `torch.jit.Attribute`.

Scripted Graph Module Created!
def forward(self,
    kjt: __torch__.torchrec.sparse.jagged_tensor.KeyedJaggedTensor) -> __torch__.torchrec.sparse.jagged_tensor.KeyedTensor:
  _0 = __torch__.torchrec.distributed.quant_embeddingbag.flatten_feature_lengths
  _1 = __torch__.torchrec.fx.utils._fx_marker
  _2 = __torch__.torchrec.distributed.quant_embedding_kernel._unwrap_kjt
  _3 = __torch__.torchrec.distributed.embedding_lookup.embeddings_cat_empty_rank_handle_inference
  flatten_feature_lengths = _0(kjt, )
  _fx_marker = _1("KJT_ONE_TO_ALL_FORWARD_BEGIN", flatten_feature_lengths, )
  split = (flatten_feature_lengths).split([2], )
  getitem = split[0]
  to = (getitem).to(torch.device("cuda", 0), True, None, )
  _fx_marker_1 = _1("KJT_ONE_TO_ALL_FORWARD_END", flatten_feature_lengths, )
  _unwrap_kjt = _2(to, )
  getitem_1 = (_unwrap_kjt)[0]
  getitem_2 = (_unwrap_kjt)[1]
  _tensor_constant0 = self._tensor_constant0
  _tensor_constant1 = self._tensor_constant1
  ops.fbgemm.bounds_check_indices(_tensor_constant0, getitem_1, getitem_2, 1, _tensor_constant1)
  _tensor_constant2 = self._tensor_constant2
  _tensor_constant3 = self._tensor_constant3
  _tensor_constant4 = self._tensor_constant4
  _tensor_constant5 = self._tensor_constant5
  _tensor_constant6 = self._tensor_constant6
  _tensor_constant7 = self._tensor_constant7
  _tensor_constant8 = self._tensor_constant8
  _tensor_constant9 = self._tensor_constant9
  int_nbit_split_embedding_codegen_lookup_function = ops.fbgemm.int_nbit_split_embedding_codegen_lookup_function(_tensor_constant2, _tensor_constant3, _tensor_constant4, _tensor_constant5, _tensor_constant6, _tensor_constant7, 128, 0, 0, 64, 0, 0, getitem_1, getitem_2, 0, None, 0, _tensor_constant8, _tensor_constant9, 16)
  _4 = [int_nbit_split_embedding_codegen_lookup_function]
  embeddings_cat_empty_rank_handle_inference = _3(_4, 1, "cuda:0", 6, )
  to_1 = torch.to(embeddings_cat_empty_rank_handle_inference, torch.device("cpu"))
  _5 = ["product", "user"]
  _6 = [64, 64]
  keyed_tensor = __torch__.torchrec.sparse.jagged_tensor.KeyedTensor.__new__(__torch__.torchrec.sparse.jagged_tensor.KeyedTensor)
  _7 = (keyed_tensor).__init__(_5, _6, to_1, 1, None, None, )
  return keyed_tensor

结论

在本教程中，您已经从训练一个分布式推荐系统模型一直到使其准备好进行推理。TorchRec 仓库中有一个完整的示例，展示了如何将 TorchRec 的 TorchScript 模型加载到 C++ 中进行推理。

欲了解更多信息，请参阅我们的 dlrm 示例，其中包括使用个性化与推荐系统中的深度学习推荐模型中描述的方法在Criteo 1TB数据集上进行多节点训练。

脚本总运行时间： ( 0 分钟 0.767 秒)

Gallery generated by Sphinx-Gallery

TorchRec 简介

安装依赖

嵌入

推荐系统中的嵌入

PyTorch中的嵌入

TorchRec 功能概述

从`EmbeddingBag`到`EmbeddingBagCollection`

TorchRec 输入/输出数据类型

分布式训练和分片

分布式嵌入

分片

分片模块

计划器

规划器结果

使用`LazyAwaitable`进行GPU训练

分片 TorchRec 模块的剖析

优化嵌入查找

`DistributedModelParallel`

分片最佳实践

添加优化器

优化器类

TorchRec中的融合优化器

向`EmbeddingBagCollection`添加优化器

推理

量化

分片

编译

结论

TorchRec 简介

安装依赖

嵌入

推荐系统中的嵌入

PyTorch中的嵌入

TorchRec 功能概述

从EmbeddingBag到EmbeddingBagCollection

TorchRec 输入/输出数据类型

分布式训练和分片

分布式嵌入

分片

分片模块

计划器

规划器结果

使用LazyAwaitable进行GPU训练

分片 TorchRec 模块的剖析

优化嵌入查找

DistributedModelParallel

分片最佳实践

添加优化器

优化器类

TorchRec中的融合优化器

向EmbeddingBagCollection添加优化器

推理

量化

分片

编译

结论

从`EmbeddingBag`到`EmbeddingBagCollection`

使用`LazyAwaitable`进行GPU训练

`DistributedModelParallel`

向`EmbeddingBagCollection`添加优化器