[Compat] Update DispatchKey usage to `c10::DispatchKey` and replace dispatch_key_to_string with `c10::toString` by gouzil · Pull Request #78525 · PaddlePaddle/Paddle

gouzil · 2026-03-30T06:22:17Z

PR Category

Execute Infrastructure

PR Types

Devs

Description

移除 paddle/phi/api/include/compat/torch/library.h 下的 DispatchKey, 改用 c10::DispatchKey

是否引起精度变化

否

…patch_key_to_string with c10::toString

paddle-bot · 2026-03-30T06:22:25Z

你的PR提交成功，感谢你对开源项目的贡献!
请关注后续CI自动化测试结果，详情请参考Paddle-CI手册。
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

Copilot

Pull request overview

This PR aims to align the compat Torch library registration API with the upstream-style dispatch key type by switching from a local DispatchKey enum to c10::DispatchKey, and replacing the local dispatch_key_to_string() helper with c10::toString() for logging/printing.

Changes:

Add c10/core/DispatchKey.h include and switch operator implementation dispatch keys to c10::DispatchKey.
Replace dispatch_key_to_string(...) usages with c10::toString(...).
Remove the local DispatchKey enum and string conversion helper.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
paddle/phi/api/include/compat/torch/library.h	Switch operator registry dispatch-key storage to `c10::DispatchKey` and remove local `DispatchKey` enum/helper.
paddle/phi/api/include/compat/torch/library.cpp	Update logging/printing from `dispatch_key_to_string` to `c10::toString`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-30T06:25:37Z

paddle/phi/api/include/compat/torch/library.h

@@ -696,7 +680,7 @@ class PADDLE_API OperatorRegistry {
                       const std::string& schema);

  void register_implementation(const std::string& qualified_name,
-                               DispatchKey key,
+                               c10::DispatchKey key,
                               CppFunction&& func);


DispatchKey enum and dispatch_key_to_string() were removed, but this header still uses DispatchKey in multiple places (e.g., Library constructor/member, value_or(DispatchKey::CPU), and the TORCH_LIBRARY_IMPL macro uses torch::DispatchKey::k). As-is, this will not compile. Please either switch all remaining uses to c10::DispatchKey (and update DispatchKey::CPU etc), or introduce using DispatchKey = c10::DispatchKey; in namespace torch to keep the existing torch::DispatchKey references working (and update the .cpp definitions and tests accordingly).

Copilot · 2026-03-30T06:25:37Z

paddle/phi/api/include/compat/torch/library.h

 #include <type_traits>
 #include <unordered_map>
 #include <vector>
+#include "c10/core/DispatchKey.h"


Include style is inconsistent here: other external headers in this file use angle brackets (e.g., <c10/macros/Macros.h>), but DispatchKey.h is included with quotes. Prefer #include <c10/core/DispatchKey.h> to match the rest of the compat headers and avoid accidental relative-include resolution.

Suggested change

#include "c10/core/DispatchKey.h"

#include <c10/core/DispatchKey.h>

这个人家说的有道理，我们 compat 的统一用 <>

Copilot · 2026-03-30T06:25:37Z

paddle/phi/api/include/compat/torch/library.cpp

 void OperatorRegistry::register_implementation(
    const std::string& qualified_name, DispatchKey key, CppFunction&& func) {
  auto& op = get_or_create_operator(qualified_name);
  op.implementations[key] = std::move(func);
  VLOG(3) << "Registered implementation: " << qualified_name << " for "
-          << dispatch_key_to_string(key);
+          << c10::toString(key);
 }


OperatorRegistry::register_implementation definition still takes DispatchKey key, but the header now declares c10::DispatchKey key. This is an ODR/compile error. Update the .cpp signature (and any remaining DispatchKey uses in this translation unit) to match the header/type decision.

Copilot · 2026-03-30T06:25:37Z

paddle/phi/api/include/compat/torch/library.cpp

 // Library
 Library::Library(Kind kind,
                 const std::string& ns,
                 std::optional<DispatchKey> dispatch_key,
                 const char* file,
                 uint32_t line)
    : kind_(kind),
      ns_(ns),
      dispatch_key_(dispatch_key),
      file_(file),
      line_(line) {
  std::stringstream oss;
  oss << "Created Library: kind=" << kind_to_string(kind)
      << ", namespace=" << ns;
  if (dispatch_key) {
-    oss << ", dispatch_key=" << dispatch_key_to_string(*dispatch_key);
+    oss << ", dispatch_key=" << c10::toString(*dispatch_key);
  }


Library::Library(...) definition still uses std::optional<DispatchKey> for dispatch_key, but the PR is moving toward c10::DispatchKey and the header currently still references DispatchKey in several places. Once DispatchKey is removed/aliased, this will fail to compile. Please align the constructor parameter/member types with the chosen dispatch key type (e.g., std::optional<c10::DispatchKey> or torch::DispatchKey alias).

ShigureNyako

感谢这次清理。我检查了 diff、PR 当前 head，以及当前 CI 状态。

这个 PR 的目标很明确：把这条 compat torch 注册路径从本地的 DispatchKey 枚举 / dispatch_key_to_string() 辅助函数，迁移到 c10::DispatchKey / c10::toString()。

但就当前 head 而言，这次迁移还没有完成。paddle/phi/api/include/compat/torch/library.h 和 paddle/phi/api/include/compat/torch/library.cpp 在已修改 hunk 之外，仍然保留了多处 DispatchKey / torch::DispatchKey 的引用，因此这个补丁目前还没有做到内部一致，较大概率会破坏这条 compat 路径的编译。我已经在行内评论里列出了具体还残留的旧用法位置。

另外，在我审查时，required approval check 仍在等待指定 approver，PR template check 失败，主构建/测试任务也还在运行中。

ShigureNyako · 2026-03-30T06:31:34Z

paddle/phi/api/include/compat/torch/library.h

-  }
-}
-
 // Operator Registration


这里移除本地 DispatchKey 之后，仍有多处未修改的调用点继续引用旧类型，因此当前这组改动还没有做到内部一致。按 PR 当前 head，Library / TorchLibraryInit 仍然使用 std::optional<DispatchKey>，def() / impl() 仍然在做 value_or(DispatchKey::CPU)，TORCH_LIBRARY_IMPL 仍然会展开成 torch::DispatchKey::k，而且 library.cpp 里也依然保留了 register_implementation(..., DispatchKey) 和 Library(..., std::optional<DispatchKey>) 这样的旧签名。

除非你在 namespace torch 里补一个别名，或者在同一个 PR 里把这些剩余引用也一并改成 c10::DispatchKey，否则这条 compat 注册路径会编译不过。

我对比了一下 torch，发现他们都是使用 c10::DispatchKey, 我们在这里保留这个 namespace 不太合适

我对比了一下 torch，发现他们都是使用 c10::DispatchKey, 我们在这里保留这个 namespace 不太合适

同意要对齐到 c10::DispatchKey。但我复看了最新 head，当前只把 TORCH_LIBRARY_IMPL 宏和测试里的查找键改成了 c10::DispatchKey，torch::Library / detail::TorchLibraryInit / library.cpp 的签名和成员仍然是裸 DispatchKey。

具体还残留在 library.h:734/756/767/786/822 和 library.cpp:237/271。另外 compat c10/core/DispatchKey.h 当前并没有把 c10::DispatchKey re-export 到 namespace torch，这里只有 using c10::kAutograd，所以现在仍然和 upstream 不一致，也仍有编译风险。

我对比了一下 torch，发现他们都是使用 c10::DispatchKey, 我们在这里保留这个 namespace 不太合适

已复核最新 head。现在 library.h/.cpp、detail::TorchLibraryInit、Library 的构造参数与成员、TORCH_LIBRARY_IMPL 宏，以及测试里的 dispatch key 查找都已经统一到 c10::DispatchKey，同时 include 也改成了 <c10/core/DispatchKey.h>。这次实现已经和 PyTorch upstream 的对应路径对齐，我这边会把之前这条阻塞意见收口。

codecov-commenter · 2026-03-30T10:39:37Z

Codecov Report

❌ Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (develop@8309551). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
paddle/phi/api/include/compat/torch/library.cpp	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             develop   #78525   +/-   ##
==========================================
  Coverage           ?   83.33%           
==========================================
  Files              ?        2           
  Lines              ?        6           
  Branches           ?        0           
==========================================
  Hits               ?        5           
  Misses             ?        1           
  Partials           ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ShigureNyako

我按最新 head 和作者回复又复核了一轮，重点对照了 PyTorch upstream 的 torch/library.h。方向是对的：upstream 确实统一使用 c10::DispatchKey，_TORCH_LIBRARY_IMPL 也应传 c10::DispatchKey::k。本次新增提交已经把宏和测试里的查找键改到了这一路径，这部分与 upstream 一致。

但 migration 仍未完整收口，所以我这轮仍然不能通过。当前 PR head 中：

paddle/phi/api/include/compat/torch/library.h:734, 756, 767, 786, 822 还在使用裸 DispatchKey / DispatchKey::CPU
paddle/phi/api/include/compat/torch/library.cpp:237, 271 仍然使用裸 DispatchKey
同时 compat paddle/phi/api/include/compat/c10/core/DispatchKey.h:586-588 并没有把 DispatchKey re-export 到 namespace torch

而 upstream pytorch/torch/library.h 对应位置仍是 std::optional<c10::DispatchKey>（例如构造函数、member、detail::TorchLibraryInit），并在 _TORCH_LIBRARY_IMPL 中传 std::make_optional(c10::DispatchKey::k)。

因此当前实现仍然存在 API/类型不一致：宏和测试已经切到 c10::DispatchKey，但 torch::Library 这条 compat 注册路径内部还保留旧的裸类型名，兼容性与编译语义都没有真正与 PyTorch 对齐。请把这些剩余位置也统一改成 c10::DispatchKey（或者显式引入别名，但这会偏离 upstream 设计）。

CI 方面，最新 head 的 PR template / pre-commit 已通过；required approval check 仍未满足，主要 build/test 任务也还在运行。

…om a relative path to an absolute path

ShigureNyako

我复核了最新 head。之前指出的几处关键问题已经收口：

library.h/.cpp 中 Library、detail::TorchLibraryInit、register_implementation()、成员与默认值都已统一为 c10::DispatchKey
TORCH_LIBRARY_IMPL 已改为传 std::make_optional(c10::DispatchKey::k)
include 已统一为 <c10/core/DispatchKey.h>
测试也补到了运行时注册和 Library 带 dispatch key 的路径

我对照了 PyTorch upstream torch/library.h，当前这条 compat torch 注册路径在 DispatchKey 的类型与宏语义上已经对齐。CI 里除 approval 外，其余 required 流水线当前均为通过或运行中；就代码实现本身看，我这边通过。

SigureMo · 2026-04-02T16:34:52Z

paddle/phi/api/include/compat/torch/library.cpp

  op.implementations[key] = std::move(func);
  VLOG(3) << "Registered implementation: " << qualified_name << " for "
-          << dispatch_key_to_string(key);
+          << c10::toString(key);


/skip-reason 编译过了就不影响效果

…ispatch_key_to_string with `c10::toString` (PaddlePaddle#78525)

[Compat] Update DispatchKey usage to c10::DispatchKey and replace dis…

3d23d14

…patch_key_to_string with c10::toString

Copilot AI review requested due to automatic review settings March 30, 2026 06:22

paddle-bot bot added the contributor External developers label Mar 30, 2026

Copilot started reviewing on behalf of gouzil March 30, 2026 06:22 View session

gouzil requested review from SigureMo and Copilot and removed request for Copilot March 30, 2026 06:23

Copilot started reviewing on behalf of gouzil March 30, 2026 06:24 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

ShigureNyako suggested changes Mar 30, 2026

View reviewed changes

Update the usage of DispatchKey and replace it with c10::DispatchKey

5330e7c

ShigureNyako suggested changes Mar 30, 2026

View reviewed changes

gouzil added 3 commits March 30, 2026 20:14

Update the usage of DispatchKey and replace it with c10::DispatchKey

7480d3c

Modify the path inclusion, and change the reference of DispatchKey fr…

b9979f9

…om a relative path to an absolute path

add more test

4cbea5e

ShigureNyako approved these changes Apr 1, 2026

View reviewed changes

SigureMo reviewed Apr 2, 2026

View reviewed changes

SigureMo added the skip-ci: coverage label Apr 2, 2026

SigureMo approved these changes Apr 2, 2026

View reviewed changes

SigureMo merged commit 0ee9000 into PaddlePaddle:develop Apr 2, 2026
111 of 117 checks passed

gouzil mentioned this pull request Apr 4, 2026

Reduce the diff with the pytorch:main branch PFCCLab/paddlecodec#3

Open

liuhao2638 pushed a commit to liuhao2638/Paddle that referenced this pull request Apr 7, 2026

[Compat] Update DispatchKey usage to c10::DispatchKey and replace d…

eadbb73

…ispatch_key_to_string with `c10::toString` (PaddlePaddle#78525)

	#include "c10/core/DispatchKey.h"
	#include <c10/core/DispatchKey.h>

Conversation

gouzil commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Category

PR Types

Description

是否引起精度变化

Uh oh!

paddle-bot bot commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

SigureMo Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

ShigureNyako left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShigureNyako Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gouzil Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

ShigureNyako Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

ShigureNyako Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ShigureNyako left a comment

Choose a reason for hiding this comment

Uh oh!

ShigureNyako left a comment

Choose a reason for hiding this comment

Uh oh!

SigureMo Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gouzil commented Mar 30, 2026 •

edited

Loading

ShigureNyako left a comment •

edited

Loading

ShigureNyako Mar 30, 2026 •

edited

Loading

codecov-commenter commented Mar 30, 2026 •

edited

Loading