Files
paddlepaddle--paddle/python/paddle/jit/dy2static/convert_call_func.py
T
2026-07-13 12:40:42 +08:00

374 lines
11 KiB
Python

# Copyright (c) 2022 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import collections
import copy
import functools
import inspect
import logging
import os
import pdb # noqa: T100
import re
from typing import TYPE_CHECKING, Any
import numpy
from paddle.nn import Layer
from .convert_operators import (
convert_enumerate,
convert_len,
convert_print,
convert_range,
convert_zip,
)
from .logging_utils import TranslatorLogger
from .program_translator import (
StaticFunction,
convert_to_static,
unwrap_decorators,
)
from .utils import (
TransformOptions,
is_builtin,
is_paddle_func,
patch_method_guard,
)
if TYPE_CHECKING:
from collections.abc import Callable
from types import ModuleType
__all__ = []
translator_logger = TranslatorLogger()
def builtin_modules():
"""
Return builtin modules.
"""
modules = [
copy,
collections,
inspect,
logging,
numpy,
os,
pdb,
re,
]
try:
import six
modules.append(six)
except ImportError:
pass # do nothing
return modules
BUILTIN_LIKELY_MODULES = builtin_modules()
def add_ignore_module(modules: list[ModuleType]):
"""
Adds modules that ignore transcription
"""
global BUILTIN_LIKELY_MODULES
for module in modules:
if module not in BUILTIN_LIKELY_MODULES:
BUILTIN_LIKELY_MODULES.append(module)
@functools.lru_cache
def get_module_functions(module: ModuleType) -> list[Callable[..., Any]]:
visited = set()
def _try_get_members(module) -> list[tuple[str, Any]]:
try:
return inspect.getmembers(module)
except Exception:
return []
def _get_module_functions(module):
if module in visited:
return []
visited.add(module)
results = []
for _member_name, member in _try_get_members(module):
if callable(member):
results.append(member)
if inspect.ismodule(member):
results.extend(_get_module_functions(member))
return results
return _get_module_functions(module)
@functools.lru_cache
def get_module_defining_path(module: ModuleType) -> str | None:
def _remove_module_init_suffix(file_path: str) -> str:
return file_path.removesuffix("__init__.py")
if not hasattr(module, "__file__") or module.__file__ is None:
return None
return _remove_module_init_suffix(module.__file__)
def is_unsupported(func):
"""
Checks whether the func is supported by dygraph to static graph.
"""
builtin_module_paths = [
module_path
for module in BUILTIN_LIKELY_MODULES
if (module_path := get_module_defining_path(module)) is not None
]
# Skip module function by function defining path (For Python functions)
if hasattr(func, "__code__") and func.__code__.co_filename:
func_path = func.__code__.co_filename
if any(
func_path.startswith(module_path)
for module_path in builtin_module_paths
):
translator_logger.log(
2,
"Whitelist: %s is part of built-in module and does not have to be transformed.",
func,
)
return True
builtin_functions = [
func
for module in BUILTIN_LIKELY_MODULES
for func in get_module_functions(module)
]
# Skip module function by module members (For C/C++ binding functions)
for builtin_fn in builtin_functions:
if func is builtin_fn:
translator_logger.log(
2,
"Whitelist: %s is part of built-in module and does not have to be transformed.",
func,
)
return True
if is_paddle_func(func):
translator_logger.log(
2,
"Whitelist: %s is part of Paddle module and does not have to be transformed.",
func,
)
return True
return False
class StaticLayerWrapper:
def __init__(self, layer):
self.layer = layer
def __call__(self, *args, **kwargs):
with patch_method_guard(
self.layer, "forward", convert_call(self.layer.forward)
):
return self.layer(*args, **kwargs)
def convert_call(func):
"""
Converts a function call which needs to be transformed to static function.
Args:
func (callable): A callable function or method to convert.
Returns:
Callable: A converted function.
Examples:
.. code-block:: pycon
>>> # doctest: +SKIP('`paddle.jit.to_static` can not run in xdoctest')
>>> import paddle
>>> from paddle.jit.dy2static import Call
>>> paddle.enable_static()
>>> def dyfunc(x):
... if paddle.mean(x) < 0:
... x_v = x - 1
... else:
... x_v = x + 1
... return x_v
>>> new_func = Call(dyfunc)
>>> x = paddle.tensor.manipulation.fill_constant(shape=[3, 3], value=0, dtype='float64')
>>> x_v = new_func(x)
>>> exe = paddle.static.Executor(paddle.CPUPlace())
>>> out = exe.run(fetch_list=[x_v])
>>> print(out[0])
[[1. 1. 1.]
[1. 1. 1.]
[1. 1. 1.]]
"""
translator_logger.log(1, "Convert callable object: convert %s.", func)
func_self = None
converted_call = None
# Function in convert_call may be decorated by another `@to_static`,
# in this case, unwraps it into a raw method or function.
_, func = unwrap_decorators(func)
if not TransformOptions.check_fn_need_transform(
func, TransformOptions.ToStaticMode.AST
):
translator_logger.log(
2,
"%s is not converted when it is decorated by 'paddle.jit.not_to_static'.",
func,
)
return func
if is_builtin(func, "len"):
return convert_len
if is_builtin(func, "zip"):
return convert_zip
if is_builtin(func, "range"):
return convert_range
if is_builtin(func, "enumerate"):
return convert_enumerate
if is_builtin(func, "print"):
return convert_print
if is_builtin(func) or is_unsupported(func):
return func
if inspect.isgeneratorfunction(func):
# NOTE(xiongkun03): inspect.isfunction() will return True even though func is a generator function.
# If we don't deal generator function here, we will regard it as normal function and get errors in some
# occasion.
number_of_stars = 30
translator_logger.warn(
"\n\n"
+ "*" * number_of_stars
+ f"\nYour function:`{func.__name__}` doesn't support to transform to static function because it is a generator function, it will be run as-is."
+ "\n"
+ "*" * number_of_stars
+ "\n\n"
)
return func
if inspect.isfunction(func):
# TODO(liym27): If func is a lambda function, special conversion is needed.
if func.__name__ == '<lambda>':
return func
try:
# Note(Aurelius84): Because `@to_static` returns a class instance instead of
# a function. This will modify the value referring to itself in `__globals__`.
# For example:
#
# @to_static
# def foo(x):
# return x
#
# `foo` will be converted into a wrapper class, suppose as `StaticFunction`.
# And `foo.__globals__['foo']` will still return this `StaticFunction` instead of
# `foo` function. So `isinstance(fn, StaticFunction)` is added here.
_origfunc = inspect.unwrap(func)
global_functions = set()
for fn in _origfunc.__globals__.values():
if inspect.isfunction(fn):
global_functions.add(fn)
elif isinstance(fn, StaticFunction):
_, fn = unwrap_decorators(fn)
global_functions.add(fn)
elif inspect.isclass(fn):
if isinstance(
fn.__dict__.get(func.__name__, None), staticmethod
):
global_functions.add(
func
) # Add func to ensure that we will convert
if func in global_functions:
converted_call = convert_to_static(func)
func_self = getattr(func, '__self__', None)
else:
# NOTE:
# If func is not in __globals__, it does not need to be transformed
# because it has been transformed before.
translator_logger.warn(
"%s doesn't have to be transformed to static function because it has been transformed before, it will be run as-is.",
func,
)
converted_call = func
except AttributeError:
# NOTE:
# If func is not in __globals__, it does not need to be transformed
# because it has been transformed before.
converted_call = None
except OSError:
# NOTE:
# If func has been decorated, its source code can not be get
# so that it can not be transformed to static function.
converted_call = None
elif inspect.ismethod(func):
try:
converted_call = convert_to_static(func)
func_self = getattr(func, '__self__', None)
except OSError:
# NOTE: func may have been decorated.
converted_call = None
elif hasattr(func, '__class__') and callable(func.__class__):
if hasattr(func, 'forward') and isinstance(func, Layer):
return StaticLayerWrapper(func)
else:
try:
call_func = func.__class__.__call__
converted_call = convert_to_static(call_func)
func_self = func
except (OSError, TypeError):
# NOTE:
# If `func` is a class which is being initialized, for example `convert_call(Foo)()`,
# it doesn't need to be transformed
func_self = None if func_self else func_self
else:
raise NotImplementedError(
f"Callable {func} can not be transformed at present."
)
if converted_call is None:
translator_logger.warn(
"%s doesn't have to be transformed to static function, and it will be run as-is.",
func,
)
return func
if func_self is not None:
converted_call = functools.partial(converted_call, func_self)
return converted_call