Diamond项目在M1 Mac上运行时的PyTorch版本兼容性问题分析

问题背景

在机器学习项目开发中，硬件兼容性是一个常见挑战。Diamond项目作为一个基于PyTorch的开源项目，在M1 Mac设备上运行时遇到了一个典型的版本兼容性问题。本文将深入分析该问题的技术细节和解决方案。

问题现象

当开发者在M1 Mac设备上使用PyTorch 2.0.1版本运行Diamond项目的csgo分支时，执行命令PYTORCH_ENABLE_MPS_FALLBACK=1 python src/play.py会遇到以下错误：

RuntimeError: don't know how to restore data location of torch.storage.UntypedStorage (tagged with mps:0)

这个错误表明PyTorch在尝试恢复存储数据位置时遇到了问题，特别是当数据被标记为使用MPS(Metal Performance Shaders)后端时。

技术分析

MPS后端简介

MPS是Apple为自家芯片(M1/M2等)提供的Metal Performance Shaders后端，它允许PyTorch利用Apple Silicon芯片的GPU加速能力。与传统的CUDA后端不同，MPS是专门为Apple设备优化的计算后端。

存储位置恢复问题

错误信息中提到的torch.storage.UntypedStorage是PyTorch中用于管理原始存储数据的基础类。当PyTorch尝试从检查点(checkpoint)加载模型时，它需要恢复每个张量的存储位置(CPU、GPU/MPS等)。

在PyTorch 2.0.1版本中，对于标记为mps:0(即第一个MPS设备)的存储数据，恢复机制存在缺陷，导致无法正确识别和处理这种存储位置。

解决方案

经过验证，将PyTorch升级到2.4.1版本可以解决这个问题。这表明：

1. 这是一个已知的兼容性问题，在后续PyTorch版本中已修复
2. Apple Silicon支持在PyTorch的后续版本中得到了持续改进

最佳实践建议

对于在Apple Silicon设备上使用PyTorch的开发者，建议：

1. 保持PyTorch版本更新：Apple Silicon支持是一个相对较新的功能，新版本通常会修复许多兼容性问题
2. 理解MPS限制：MPS后端虽然强大，但与CUDA并非100%兼容，某些操作可能不支持
3. 使用回退机制：PYTORCH_ENABLE_MPS_FALLBACK=1环境变量允许在不支持MPS的操作中回退到CPU，这是一个有用的调试工具
4. 测试不同版本：在项目开发初期，应该在不同PyTorch版本上进行充分测试，特别是当目标平台包括Apple Silicon设备时

结论

这个案例展示了硬件特定加速后端与深度学习框架之间的兼容性挑战。通过及时更新框架版本，开发者可以避免许多类似的兼容性问题。对于Diamond项目而言，维护团队已经通过升级依赖要求解决了这个问题，这体现了良好项目维护实践的重要性。