分析 PyTorch XLA 工作负载

性能分析是一种分析和改进模型性能的方法。虽然还有很多其他内容，但有时将性能分析视为对设备（TPU）和主机（CPU）上运行的操作和代码部分进行时间测算会很有帮助。本指南简要介绍了如何对代码进行性能分析，以便进行训练或推理。如需详细了解如何分析生成的配置文件，请参阅以下指南。

• 在 TPU 虚拟机上调试 PyTorch XLA 性能 - 第 1 部分
• 在 TPU 虚拟机上调试 PyTorch XLA 性能 - 第 2 部分
• 在 TPU 虚拟机上调试 PyTorch XLA 性能 - 第 3 部分

开始使用

创建 TPU

1. 导出环境变量：

   $ export TPU_NAME=your_tpu_name
   $ export ZONE=us-central2-b
   $ export PROJECT_ID=project-id
   $ export ACCELERATOR_TYPE=v4-8
   $ export RUNTIME_VERSION=tpu-vm-v4-pt-2.0

   导出变量说明

   TPU name

   您要为 Cloud TPU 使用的名称。

   zone

   拟在其中创建 Cloud TPU 的区域。

   project ID

   您用于训练和分析模型的项目 ID。

   accelerator-type

   加速器类型用于指定您要创建的 Cloud TPU 的版本和大小。 如需详细了解每个 TPU 版本支持的加速器类型，请参阅 TPU 版本。

   version

   Cloud TPU 运行时版本。导出的变量中会显示默认值，但您也可以使用受支持的配置列表中的值。

2. 启动 TPU 资源

   $ gcloud compute tpus tpu-vm create ${TPU_NAME} \
   --zone us-central2-b \
   --accelerator-type ${ACCELERATOR_TYPE} \
   --version ${RUNTIME_VERSION} \
   --project $PROJECT_ID \
   --subnetwork=tpusubnet

3. 使用 gcloud scp 命令将代码移至 TPU 虚拟机上的主目录。例如：

   $ gcloud compute tpus tpu-vm scp my-code-file ${TPU_NAME}: --zone ${ZONE}

分析

注意 ：v4-8 包含 4 个 TPU 设备。每个 worker 仅会对 4 个可用设备中的 1 个设备进行 TPU 分析。我们很快就会支持为每个工作器对所有 4 个 TPU 设备进行性能分析。

您可以通过 capture_profile.py 手动捕获配置文件，也可以使用 torch_xla.debug.profiler API 在训练脚本中以编程方式捕获配置文件。

启动配置文件服务器

为了捕获配置文件，必须在训练脚本中运行配置文件服务器。使用您选择的端口号（例如 9012，如以下命令所示）启动服务器。

注意 ：您可以参阅此示例脚本，其中包含以下步骤。

import torch_xla.debug.profiler as xp
server = xp.start_server(9012)

服务器可以在 main 函数开头立即启动。

注意 ：如果您使用的是 Lightning 模块，请将 profiler="xla" 传递给 trainer，而不是启动服务器，系统会自动在端口 9012 上启动服务器。

现在，您可以按照以下部分中的说明捕获配置文件。该脚本会对一台 TPU 设备上发生的所有活动进行性能分析。

添加轨迹

如果您还想对宿主机上的操作进行性能分析，可以在代码中添加 xp.StepTrace 或 xp.Trace。这些函数会跟踪宿主机上的 Python 代码。（您可以将其视为测量在将“图”传递给 TPU 设备之前，在主机 (CPU) 上执行 Python 代码所需的时间。因此，它最适合用于分析跟踪开销）。您可以在代码处理批量数据的训练循环中添加此操作，例如：

for step, batch in enumerate(train_dataloader):
    with xp.StepTrace('Training_step', step_num=step): 
       ...

或使用以下代码封装代码的各个部分

 with xp.Trace('loss'): 
    loss = ...

重要提示： 请避免使用 xp.Trace 封装 xm.mark_step()。在这种情况下，代码会崩溃，并显示类似以下内容的错误消息： "RuntimeError: Expecting scope to be empty but it is train_loop." xp.StepTrace 不会出现此问题，因为它会在退出作用域时自动添加 xm.mark_step()。此外，使用 torchdynamo 时，您可能会收到此错误，因为 torchdynamo 可能会在内部调用 xm.mark_step。当前的解决方法是不要使用 xp.Trace。

如果您使用的是 Lighting，则可以跳过添加轨迹，因为系统会在代码的某些部分自动执行此操作。不过，如果您想添加其他轨迹，可以将其插入训练循环中。

您将能够在初始编译后捕获设备活动；请等待模型开始其训练或推理步骤。

手动拍照

您可以使用 Pytorch XLA 代码库中的 capture_profile.py 脚本快速捕获配置文件。为此，您可以直接将捕获的配置文件复制到 TPU 虚拟机。以下命令会将其复制到主目录。

$ gcloud compute tpus tpu-vm ssh ${TPU_NAME} \
--zone us-central2-b \
--worker=all \
--command="wget https://raw.githubusercontent.com/pytorch/xla/master/scripts/capture_profile.py"

在训练运行期间，执行以下命令以捕获配置文件：

$ gcloud compute tpus tpu-vm ssh ${TPU_NAME} \
--zone us-central2-b \
--worker=all \
--command="python3 capture_profile.py --service_addr "localhost:9012" --logdir ~/profiles/ --duration_ms 2000"

此命令会将 .xplane.pb 文件保存在 logdir 中。您可以将日志记录目录 ~/profiles/ 更改为首选位置和名称。您也可以直接保存在 Cloud Storage 存储桶中。为此，请将 logdir 设置为 gs://your_bucket_name/。

程序化捕获

您可以通过在训练脚本中使用 torch_xla.debug.profiler.trace_detached API 来配置训练脚本，以自动触发配置文件，而不是通过触发脚本来手动捕获配置文件。

注意 ：trace_detached API 仅在每夜 build 或 2.2 版之后提供。如需在较低版本的 torch_xla 中以编程方式进行捕获，您可以复制该方法的正文以直接创建后台捕获线程。

例如，如需在特定的迭代和步骤自动捕获配置文件，您可以将训练脚本配置为使用 PROFILE_STEP、PROFILE_EPOCH 和 PROFILE_LOGDIR 环境变量：

import os
import torch_xla.debug.profiler as xp

# Within the training script, read the step and epoch to profile from the
# environment.
profile_step = int(os.environ.get('PROFILE_STEP', -1))
profile_epoch = int(os.environ.get('PROFILE_EPOCH', -1))
...

for epoch in range(num_epoch):
   ...
   for step, data in enumerate(epoch_dataloader):
      if epoch == profile_epoch and step == profile_step:
         profile_logdir = os.environ['PROFILE_LOGDIR']
         # Use trace_detached to capture the profile from a background thread
         xp.trace_detached('localhost:9012', profile_logdir)
      ...

这会将 .xplane.pb 文件保存到 PROFILE_LOGDIR 环境变量指定的目录中。

TensorBoard 中的分析

如需进一步分析配置文件，您可以在同一台机器或其他机器（推荐）上将 TensorBoard 与 TPU TensorBoard 插件
搭配使用。

如需在远程机器上运行 TensorBoard，请使用 SSH 连接到该机器并启用端口转发。例如，

$ ssh -L 6006:localhost:6006 remote server address

或

$ gcloud compute tpus tpu-vm ssh $TPU_NAME --zone=$ZONE --ssh-flag="-4 -L 6006:localhost:6006"

在远程机器上，安装所需的软件包并启动 TensorBoard（假设您在该机器上的 ~/profiles/ 下有配置文件）。如果您将配置文件存储在其他目录或 Cloud Storage 存储桶中，请务必正确指定路径，例如 gs://your_bucket_name/profiles。

(vm)$ pip install tensorflow-cpu tensorboard-plugin-profile 

(vm)$ tensorboard --logdir ~/profiles/ --port 6006

注意： 请务必将 .xplane 文件放在与您捕获配置文件时生成的嵌套结构相同的位置。例如： ~/profiles/plugins/profile/2023_04_10_21_40_22/localhost_9012.xplane.pb

注意： 如果您收到“重复的插件”错误，可能是因为 TensorBoard 中有多个软件包。卸载所有这些软件包，然后再次运行 pip install 命令。例如，您可能需要运行以下命令：

(vm)$ pip uninstall tensorflow tf-nightly tensorboard tb-nightly tbp-nightly

运行 TensorBoard

在本地浏览器中，前往 http://localhost:6006/，然后从下拉菜单中选择 PROFILE 以加载您的个人资料。

如需了解 TensorBoard 工具以及如何解读输出，请参阅 TPU 工具。