Function enable_torch_proxy

python/paddle/compat/proxy.py:449–500

Enable the PyTorch compat by adding the TorchProxyMetaFinder to sys.meta_path. This allows importing 'torch' modules that are actually proxies to PaddlePaddle. Args: scope (str or Iterable[str], optional): Specific module or modules to enable PyTorch compat for. If

(
    *,
    scope: _ScopeType = None,
    blocked_modules: _ScopeType = None,
    backend: Literal["torch"] = "torch",
    silent: bool = False,
)

def enable_torch_proxy(
    *,
    scope: _ScopeType = None,
    blocked_modules: _ScopeType = None,
    backend: Literal["torch"] = "torch",
    silent: bool = False,
) -> None:
    """
    Enable the PyTorch compat by adding the TorchProxyMetaFinder to sys.meta_path.
    This allows importing 'torch' modules that are actually proxies to PaddlePaddle.

    Args:
        scope (str or Iterable[str], optional): Specific module or modules to enable
            PyTorch compat for. If None, enables PyTorch compat globally. Defaults to None.
        blocked_modules (str or Iterable[str], optional): Specific module or modules to
            exclude from PyTorch compat. Defaults to None.
        backend (str, optional): The backend to enable compat for. Currently only
            "torch" is supported. Defaults to "torch".
        silent (bool, optional): If True, suppresses warnings about scope changes.
            Defaults to False.

    Example:
        .. code-block:: pycon
            :name: enable-compat-in-global-scope

            >>> import paddle
            >>> paddle.enable_compat()  # Enable torch compat globally
            >>> import torch  # type: ignore[import-not-found] # This will import paddle as torch
            >>> assert torch.sin is paddle.sin
            >>> paddle.disable_compat()  # Disable torch compat

        .. code-block:: pycon
            :name: enable-compat-in-specific-scope

            >>> import paddle
            >>> paddle.enable_compat(scope={"triton"})  # Enable torch compat for 'triton' module only
            >>> import triton  # type: ignore[import-untyped] # All `import torch` inside `triton` will proxy to paddle
            >>> try:
            ...     import torch  # type: ignore[import-not-found] # This will raise ModuleNotFoundError
            ... except ModuleNotFoundError:
            ...     print("PyTorch compat is not enabled globally.")
            >>> paddle.disable_compat()  # Disable torch compat
    """
    assert backend == "torch", f"Unsupported backend: {backend}"
    blocked_modules = _parse_scope(blocked_modules)
    if blocked_modules is not None:
        extend_torch_proxy_blocked_modules(blocked_modules)
    scope = _parse_scope(scope)
    _register_compat_override()
    _swap_torch_modules_to_cache()
    _modify_scope_of_torch_proxy(scope, silent=silent)
    sys.meta_path.insert(0, TORCH_PROXY_FINDER)


def disable_torch_proxy() -> None: