program_translator.py 36.9 KB
Newer Older
1
# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15
#
# 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 print_function
16
import gast
17
import collections
18
import logging
19
import inspect
20
import six
21 22
import textwrap
import threading
23
import warnings
24
import weakref
25 26 27

import gast
from paddle.fluid import framework
28
from paddle.fluid import in_dygraph_mode
29
from paddle.fluid.dygraph import layers
30 31
from paddle.fluid.data_feeder import check_type
from paddle.fluid.layers.utils import flatten
32
from paddle.fluid.dygraph.base import param_guard
33
from paddle.fluid.dygraph.base import switch_to_static_graph
34
from paddle.fluid.dygraph.dygraph_to_static import DygraphToStaticAst
35 36
from paddle.fluid.dygraph.dygraph_to_static.error import ERROR_DATA
from paddle.fluid.dygraph.dygraph_to_static.error import attach_error_data
37
from paddle.fluid.dygraph.dygraph_to_static import logging_utils
38 39 40 41 42
from paddle.fluid.dygraph.dygraph_to_static.origin_info import attach_origin_info
from paddle.fluid.dygraph.dygraph_to_static.origin_info import create_and_update_origin_info_map
from paddle.fluid.dygraph.dygraph_to_static.origin_info import update_op_callstack_with_origin_info
from paddle.fluid.dygraph.dygraph_to_static.partial_program import partial_program_from
from paddle.fluid.dygraph.dygraph_to_static.utils import ast_to_func
43
from paddle.fluid.dygraph.dygraph_to_static.utils import ast_to_source_code
44
from paddle.fluid.dygraph.dygraph_to_static.utils import func_to_source_code
45
from paddle.fluid.dygraph.dygraph_to_static.utils import type_name
46
from paddle.fluid.dygraph.dygraph_to_static.utils import unwrap
47 48 49
from paddle.fluid.dygraph.dygraph_to_static.utils import make_hashable
from paddle.fluid.dygraph.dygraph_to_static.function_spec import FunctionSpec
from paddle.fluid.dygraph.dygraph_to_static.function_spec import get_buffers, get_parameters
50
from paddle.fluid.wrapped_decorator import signature_safe_contextmanager
51

52
__all__ = ['ProgramTranslator', 'convert_to_static']
53

54 55 56 57
# For each traced function, we set `max_traced_program_count` = 10 to consider caching performance.
# Once exceeding the threshold, we will raise warning to users to make sure the conversion is as expected.
MAX_TRACED_PROGRAM_COUNT = 10

58 59 60 61 62 63 64

class FunctionCache(object):
    """
    Caches the transformed functions to avoid redundant conversions of the same function.
    """

    def __init__(self):
65 66 67 68 69
        # Caches the converted static functions. {dygraph_func: static_func}
        self._converted_static_func_caches = dict()
        # Caches the converted ast node for same source code. {source_code: ast_root}
        self._code_to_ast_caches = dict()
        self._dygraph_to_static = DygraphToStaticAst()
70

71 72 73 74 75 76
    def convert_with_cache(self, func):
        """
        Returns the cached static function or converts it when first encounters the function.
        """
        # If hit cache, return it directly.
        static_func = self._converted_static_func_caches.get(func, None)
77 78

        if static_func is None:
79 80
            static_func = self._convert(func)
            self._converted_static_func_caches[func] = static_func
81 82 83

        return static_func

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    def _convert(self, func):
        """
        Converts dygraph function into static function. For two functions with same dedent code,
        the second function will reuse the transformed ast node of previous one.

        For example:
            # A.py
            def foo(x, y):
                z = x + y
                return z

            # B.py
            def foo(x, y):
                z = x + y
                return z

        If the conversion of A.foo happens after B.foo, it will reuse the transformed ast node of B.foo
        to speed up the conversion.
        """
        # Note: In Python2, it will raise OSError when inspect function
        # with decorator directly and function.__wrapped__ holds the actual function.
105
        func = unwrap(func)
106
        source_code = func_to_source_code(func)
107 108 109 110 111

        # TODO(liym27):
        #  Consider this case: source_code in self._code_to_ast_caches,
        #  but actually they are methods in different classes.
        #  Maybe use (__class__, source_code) as key
112 113 114 115
        if source_code in self._code_to_ast_caches:
            root_wrapper = self._code_to_ast_caches[source_code]
        else:
            root = gast.parse(source_code)
116
            root = attach_origin_info(root, func)
117 118
            root_wrapper = self._dygraph_to_static.get_static_ast(root)
            self._code_to_ast_caches[source_code] = root_wrapper
119

120 121
        # Get static function from AST
        static_func, file_name = ast_to_func(root_wrapper.node, func)
122 123

        create_and_update_origin_info_map(root_wrapper.node, static_func)
124
        return static_func
125 126

    def exist(self, func):
127
        return func in self._converted_static_func_caches
128 129


130 131 132 133
_CACHE_LOCK = threading.Lock()
_FUNCTION_CACHE = FunctionCache()


134
def convert_to_static(function):
135
    """
136
    Transforms function of dygraph into static function using the cache mechanism.
137 138 139

    Args:
        function(callable): The function with dygraph layers that will be converted into static layers.
140 141
    """
    with _CACHE_LOCK:
142
        static_func = _FUNCTION_CACHE.convert_with_cache(function)
143 144 145
        return static_func


146 147 148 149
class CacheKey(object):
    """
    Cached key for ProgramCache.
    """
150

151
    __slots__ = ['function_spec', 'input_with_spec', 'class_instance']
152

153 154 155
    def __init__(self, function_spec, input_with_spec, class_instance):
        """
        Initializes a cache key.
156

157 158 159 160
        Args:
            functions_spec(FunctionSpec): a FunctionSpec instance of decorated function.
            input_with_spec(list[InputSpec]): actual inputs with some arguments replaced by InputSpec.
            class_instance(object): a instance of class `Layer`.
161
        """
162 163 164 165 166 167
        self.function_spec = function_spec
        self.input_with_spec = input_with_spec
        self.class_instance = class_instance

    @classmethod
    def from_func_and_args(cls, function_spec, args, kwargs, class_instance):
168
        """
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
        Generated a CacheKey instance by given inputs.

        Args:
            functions_spec(FunctionSpec): a FunctionSpec instance of decorated function.
            args(tuple): tuple of actual inputs arguments.
            kwargs(dict): dict of actual inputs keyword arguments.
            class_instance(object): a instance of class `Layer`.
        """
        # 1. filter `self` in args
        if args and isinstance(args[0], layers.Layer):
            args = args[1:]
        # 2. convert tensor and numpy array into InputSpec 
        _args, _kwargs = function_spec.unified_args_and_kwargs(args, kwargs)
        input_with_spec = function_spec.args_to_input_spec(_args, _kwargs)

        # 3. check whether hit the cache or build a new program for the input arguments
        return CacheKey(function_spec, input_with_spec, class_instance)

    def __hash__(self):
        error_msg = "Arguments to a `@paddle.jit.to_static` must be a hashable Python objects (or nested structures of these types)."
        return hash((id(self.function_spec),
                     make_hashable(self.input_with_spec, error_msg),
                     self.class_instance))

    def __eq__(self, other):
        return (type(self) is type(other)) and hash(self) == hash(other)

    def __neq__(self, other):
        return not self == other

    def __repr__(self):
        return "id(function_spec): {}, input_with_spec: {}, class_instance: {}".format(
            id(self.function_spec), self.input_with_spec, self.class_instance)


def unwrap_decorators(func):
    """
    Unwraps a decorated function and returns the decorator list and inner target.
    """
    decorators = []
    cur = func
    while True:
        if isinstance(cur, StaticLayer):
            decorators.append(cur)
            # Note: if `cur` is a method, keep it as bound method of class.
            instance = cur._class_instance
            if instance is not None:
                cur = cur.dygraph_function.__get__(instance)
217
            else:
218 219 220 221
                cur = cur.dygraph_function
        else:
            break
    return decorators, cur
222

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

class StaticLayer(object):
    """
    Wrapper class to Manage program conversion of decorated function.

    """

    def __init__(self, function, input_spec=None):
        """
        Initializes a `StaticLayer`.

        Args:
            function(callable): A function or method that will be converted into static program.
            input_spec(list[InputSpec]): list of InputSpec to specify the `shape/dtype/name` information for each input argument, default None.
        """
        # save the instance `self` while decorating a method of class.
        if inspect.ismethod(function):
            self._dygraph_function = getattr(function, '__func__')
            self._class_instance = getattr(function, '__self__')
        else:
            self._dygraph_function = function
            self._class_instance = None

        self._input_spec = input_spec
        self._function_spec = FunctionSpec(function, input_spec)
        self._program_cache = ProgramCache()
249
        self._descriptor_cache = weakref.WeakKeyDictionary()
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
        # Note: Hold a reference to ProgramTranslator for switching `enable_declarative`.
        self._program_trans = ProgramTranslator()

    def __get__(self, instance, owner):
        """
        Overrides this method to parse the class instance and call bound method correctly.

        For example:
            
            '''
            class Net(Layer):
                def __init__(self):
                    pass
                
                @paddle.jit.to_static
                def forward(self, x, y):
                    return x + y

            net = Net()
            out = net(x, y)
            '''
        
        In above case, `net(x, y)` will call `net.forward(x, y)` firstly that is a bound method
        of `Net` instance. After decorated by `@paddle.jit.to_static`, it will firstly to call `__get__`
        to parse the class instance correctly instead of the `StaticLayer` instance.
        """
276 277 278 279 280 281 282 283 284 285 286 287 288
        if instance not in self._descriptor_cache:
            if instance is None:
                return self
            # Note(Aurelius84): To construct new instance of StaticLayer when we
            # first encouter the bound function of layer and cache it.
            new_static_layer = self._clone()
            new_static_layer._class_instance = instance
            self._descriptor_cache[instance] = new_static_layer

        return self._descriptor_cache[instance]

    def _clone(self):
        return self.__class__(self._dygraph_function, self._input_spec)
289 290

    def __call__(self, *args, **kwargs):
291
        """
292 293 294 295 296 297 298 299
        Supports to call the returned instance with input `args` and `kwargs` directly.

        Args:
            *args(tuple): tuple of all input arguments from original decorated function.
            **kwargs(dict): dict of all input keyward arguments from original decorated function. 

        Return:
            Outputs of decorated function.
300
        """
301

302 303
        # 1. call dygraph function directly if not enable `declarative`
        if not self._program_trans.enable_declarative:
304 305
            logging_utils.warn(
                "The decorator '@paddle.jit.to_static' does NOT work when setting ProgramTranslator.enable=False. "
306 307 308
                "We will just return dygraph output.")
            return self._call_dygraph_function(*args, **kwargs)

309 310 311 312 313 314 315
        if not in_dygraph_mode() and self._program_trans.enable_declarative:
            raise RuntimeError(
                "Failed to run the callable object {} decorated by '@paddle.jit.to_static', "
                "because it does NOT in dynamic mode. Please disable the static mode to enter dynamic mode with the "
                "following API: paddle.disable_static().".format(
                    self.dygraph_function))

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
        # 2. trace ops from dygraph layers and cache the generated program.
        args, kwargs = self._function_spec.unified_args_and_kwargs(args, kwargs)
        try:
            concrete_program, partial_program_layer = self.get_concrete_program(
                *args, **kwargs)

            # 3. synchronize self.training attribute.
            if isinstance(self._class_instance, layers.Layer):
                partial_program_layer.training = self._class_instance.training

            # 4. return outputs.
            return partial_program_layer(args)
        except Exception as e:
            if not hasattr(e, ERROR_DATA):
                # runtime error
                attach_error_data(e, in_runtime=True)
            error_data = getattr(e, ERROR_DATA, None)
            if error_data:
                new_exception = error_data.create_exception()
                if six.PY3:
                    # NOTE(liym27):
                    # 1. Why `raise new_exception from None`?
                    #   In Python 3, by default, an new exception is raised with trace information of the caught exception.
                    #   This only raises new_exception and hides unwanted implementation details from tracebacks of the
                    #   caught exception.
                    # 2. Use exec to bypass syntax error checking in Python 2.

                    six.exec_("raise new_exception from None")
                else:
                    raise new_exception
346
            else:
347
                raise
348

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
    def _call_dygraph_function(self, *args, **kwargs):
        """
        Calls dygraph function directly and returns the outputs.

        Args:
            *args(tuple): tuple of all input arguments from original decorated function.
            **kwargs(dict): dict of all input keyward arguments from original decorated function. 

        Return:
            Outputs of dygraph function.
        """
        if self._class_instance is not None:
            dygraph_function = self._dygraph_function.__get__(
                self._class_instance)
        else:
            dygraph_function = self._dygraph_function

        return dygraph_function(*args, **kwargs)

    def get_concrete_program(self, *args, **kwargs):
        """
        Returns traced concrete program and inner executable partial layer.

        Args:
            *args(tuple): input arguments values or InputSpec
            **kwargs(dict) : input kwargs values.

        Returns:
            Traced ConcreteProgram and executable translated Layer.
        """
        # 1. unify args/kwargs and replace Tensor with InputSpec
        if len(args) != len(self._function_spec.args_name):
            args, kwargs = self._function_spec.unified_args_and_kwargs(args,
                                                                       kwargs)
        input_with_spec = self._function_spec.args_to_input_spec(args, kwargs)

        # 2. generate cache key
        cache_key = CacheKey(self._function_spec, input_with_spec,
                             self._class_instance)

        # 3. check whether hit the cache or build a new program for the input arguments
        concrete_program, partial_program_layer = self._program_cache[cache_key]
        return concrete_program, partial_program_layer

    def get_traced_count(self):
        """
        Returns the number of traced programs for the decorated function.
        """
        return len(self._program_cache)

    @property
    def code(self):
        """
        Returns the source code of transformed static function for debugging.
        """
        static_func = convert_to_static(self._dygraph_function)
        source_code = func_to_source_code(static_func)
        return source_code

    @property
    def dygraph_function(self):
        """
        Returns the original decorated function.
        """
        return self._dygraph_function

    @property
    def concrete_program(self):
        """
        Returns recent ConcreteProgram instance of decorated function.
A
Aurelius84 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440

        Examples:
            .. code-block:: python

                import paddle
                from paddle.jit import to_static
                from paddle.static import InputSpec

                paddle.disable_static()

                def foo(x, y):
                    z = x + y
                    return z
                
                # usage 1:
                decorated_foo = to_static(foo, input_spec=[InputSpec([10], name='x'), InputSpec([10], name='y')])
                print(decorated_foo.concrete_program)

                # usage 2:
                decorated_foo = to_static(foo)
                out_foo = decorated_foo(paddle.rand([10]), paddle.rand([10]))
                print(decorated_foo.concrete_program)
441 442 443 444 445 446
        """
        # if specific the `input_spec`, the length of program_cache will always 1,
        # else, return the last one.
        cached_program_len = len(self._program_cache)
        # If specific `input_spec`, apply convertion from dygraph layers into static Program.
        if cached_program_len == 0:
A
Aurelius84 已提交
447 448 449
            input_spec = self._function_spec.input_spec
            has_input_spec = (input_spec is not None and len(input_spec) > 0)
            if has_input_spec:
450 451
                concrete_program, _ = self.get_concrete_program(*input_spec)
                return concrete_program
452
            else:
A
Aurelius84 已提交
453 454 455
                raise ValueError(
                    "No valid transformed program for {}.\n\t    Please specific `input_spec` in `@paddle.jit.to_static` or feed input tensor to call the decorated function at once.\n".
                    format(self._function_spec))
456 457 458 459 460 461 462 463 464
        # If more than one programs have been cached, return the recent converted program by default.
        elif cached_program_len > 1:
            logging.warning(
                "Current {} has more than one cached programs: {}, the last traced progam will be return by default.".
                format(self._function_spec, cached_program_len))

        cache_key, (concrete_program,
                    partial_layer) = self._program_cache.last()
        return concrete_program
465

466 467 468 469 470 471 472 473 474 475 476
    @property
    def inputs(self):
        """
        Returns input tensors of recent converted static program.
        """
        concrete_program = self.concrete_program
        inputs = [
            var for var in flatten(concrete_program.inputs)
            if isinstance(var, framework.Variable)
        ]
        return inputs
477

478
    @property
479 480 481 482 483 484 485 486 487 488 489
    def outputs(self):
        """
        Returns output tensors of recent converted static program.
        """
        concrete_program = self.concrete_program
        outputs = [
            var for var in flatten(concrete_program.outputs)
            if isinstance(var, framework.Variable)
        ]

        return outputs
490

491
    @property
492 493 494 495 496 497 498
    def main_program(self):
        """
        Returns recent converted static main program.
        """
        concrete_program = self.concrete_program
        main_program = concrete_program.main_program
        return main_program
499

500 501 502
    @property
    def program_cache(self):
        return self._program_cache
503

504 505 506
    @property
    def function_spec(self):
        return self._function_spec
507 508


509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
# Flag that indicates whether running code under `@declarative`
_in_declarative_mode_ = False


def in_declarative_mode():
    """
    Return a bool value that indicates whether running code under `@declarative`

    """
    return _in_declarative_mode_


@signature_safe_contextmanager
def _switch_declarative_mode_guard_(is_declarative=True):

    global _in_declarative_mode_
    original_val = _in_declarative_mode_
    _in_declarative_mode_ = is_declarative
    yield
    _in_declarative_mode_ = original_val


531
class ConcreteProgram(object):
532 533 534 535 536 537

    __slots__ = [
        'inputs', 'outputs', 'main_program', "startup_program", "parameters",
        "function"
    ]

538 539 540 541
    def __init__(self,
                 inputs,
                 outputs,
                 parameters,
542
                 function,
543
                 main_program,
544
                 startup_program=None):
545 546 547
        self.inputs = inputs
        self.outputs = outputs
        self.main_program = main_program
548
        self.startup_program = startup_program
549
        self.parameters = parameters
550
        self.function = function
551 552 553

    @staticmethod
    @switch_to_static_graph
554
    def from_func_spec(func_spec, input_spec, class_instance):
555
        """
556 557
        Builds the main_program with specialized inputs and returns outputs
        of program as fetch_list.
558 559 560 561

        Args:
            func_spec(FunctionSpec): A FunctionSpec instance for decorated function.
            input_spec(list[InputSpec]): 
562
        """
563
        # Transforms dygraph function into static function and caches it.
564
        dygraph_function = func_spec.dygraph_function
565
        static_func = convert_to_static(dygraph_function)
566

567 568
        main_program, startup_program = framework.Program(), framework.Program()
        # Note: The random seed should be synchronized into cached program
569
        # if set in `fluid.dygraph_guard` because some ops rely on it, such as
570
        # `fluid.layers.dropout`.
571
        main_program.random_seed = framework.default_main_program().random_seed
572 573
        startup_program.random_seed = framework.default_startup_program(
        ).random_seed
574

575
        with framework.program_guard(main_program, startup_program):
576 577
            with _switch_declarative_mode_guard_(is_declarative=True):
                # 1. Adds `fluid.data` layers for input if needed
578 579 580 581
                inputs = func_spec.to_static_inputs_with_spec(input_spec,
                                                              main_program)
                if class_instance:
                    inputs = tuple([class_instance] + list(inputs))
582

583
                # 2. Gets all ParamBases and buffered VarBases in the function
584 585 586
                all_parameters_and_buffers = list(
                    get_parameters(class_instance).values()) + list(
                        get_buffers(class_instance).values())
587 588

                # 3. Builds program only once and returns the output Variables.
589 590 591
                with param_guard(get_parameters(
                        class_instance, False)), param_guard(
                            get_buffers(class_instance, False)):
592 593 594 595 596 597 598
                    try:
                        outputs = static_func(*inputs)
                    except BaseException as e:
                        # NOTE: If e is raised in compile time, e should be attached to ERROR_DATA here.
                        attach_error_data(e)
                        raise

599 600 601
                if not isinstance(outputs,
                                  (tuple, list)) and outputs is not None:
                    outputs = [outputs]
602

603 604
        main_program = update_op_callstack_with_origin_info(main_program)

605 606 607
        return ConcreteProgram(
            inputs=inputs,
            outputs=outputs,
608
            parameters=all_parameters_and_buffers,
609
            function=dygraph_function,
610
            main_program=main_program,
611
            startup_program=startup_program)
612 613


614 615 616 617
class ProgramCache(object):
    """
    Wrapper class for the program functions defined by dygraph function.
    """
618

619
    def __init__(self):
620
        self._caches = collections.OrderedDict()
621

622 623 624 625 626
    def _build_once(self, cache_key):
        concrete_program = ConcreteProgram.from_func_spec(
            func_spec=cache_key.function_spec,
            input_spec=cache_key.input_with_spec,
            class_instance=cache_key.class_instance)
627
        return concrete_program, partial_program_from(concrete_program)
628

629
    def __getitem__(self, item):
630 631 632 633
        if not isinstance(item, CacheKey):
            raise ValueError('type(item) should be CacheKey, but received %s' %
                             type_name(item))

634 635
        if item not in self._caches:
            self._caches[item] = self._build_once(item)
636 637 638 639 640 641 642 643
            # Note: raise warnings if number of traced program is more than `max_tracing_count`
            current_tracing_count = len(self._caches)
            if current_tracing_count > MAX_TRACED_PROGRAM_COUNT:
                logging.warning(
                    "Current traced program number: {} > `max_tracing_count`:{}. Too much cached programs will bring expensive overhead. "
                    "The reason may be: (1) passing tensors with different shapes, (2) passing python objects instead of tensors.".
                    format(current_tracing_count, MAX_TRACED_PROGRAM_COUNT))

644
        return self._caches[item]
645

646
    def get_program(self, item):
647
        if not isinstance(item, CacheKey):
648 649
            raise ValueError(
                "Input item's type should be FunctionSpec, but received %s" %
650
                type_name(item))
651 652
        if item not in self._caches:
            raise RuntimeError(
653
                "Failed to find program for input item, please decorate input function by `@paddle.jit.to_static`."
654 655 656
            )
        return self._caches[item]

657 658 659 660 661 662
    def last(self):
        assert len(
            self._caches) >= 1, "No valid cached program in ProgramCache."
        key = next(reversed(self._caches.keys()))
        return key, self._caches[key]

663 664 665 666
    def __len__(self):
        return len(self._caches)

    def concrete_programs(self):
667
        return [cp for key, (cp, _) in six.iteritems(self._caches)]
668

669

670 671
def synchronized(func):
    func.__lock__ = threading.Lock()
672

673 674 675
    def lock_func(*args, **kwargs):
        with func.__lock__:
            return func(*args, **kwargs)
676

677
    return lock_func
678 679


680
class ProgramTranslator(object):
681
    """
682 683 684 685 686 687 688 689 690 691 692 693 694 695
    Class to translate dygraph function into static graph function. The object
    of this class is a singleton.

    Args:
        None.

    Returns:
        ProgramTranslator: the singleton object.

    Examples:
        .. code-block:: python

        import paddle.fluid as fluid

696
        # Two methods get same object because ProgramTranslator is a singleton
697 698 699
        fluid.dygraph.ProgramTranslator()
        fluid.dygraph.ProgramTranslator.get_instance()

700 701
    """

702
    _singleton_lock = threading.Lock()
703 704 705 706 707 708
    _instance = None

    @synchronized
    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = object.__new__(cls, *args, **kwargs)
709
            cls._instance._initialized = False
710 711 712 713 714
        return cls._instance

    @classmethod
    def get_instance(cls):
        if cls._instance is None:
715 716
            with cls._singleton_lock:
                cls._instance = cls()
717 718 719 720 721
        return cls._instance

    @classmethod
    def reset(cls):
        if cls._instance is not None:
722
            cls._instance._initialized = False
723 724
            cls._instance.__init__()

725
    def __init__(self):
726
        # To make sure that calls __init__ only once.
727
        if self._initialized:
728
            return
729 730
        self._initialized = True
        self._program_cache = ProgramCache()
731 732
        self.enable_declarative = True

733
    def enable(self, enable_declarative):
734 735 736 737 738
        """
        Enable or disable the converting from imperative to declarative by
        ProgramTranslator globally.

        Args:
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
            enable_declarative (bool): True or False to enable or disable declarative.

        Returns:
            None.

        Examples:
            .. code-block:: python

            import paddle.fluid as fluid
            import numpy as np

            @fluid.dygraph.jit.declarative
            def func(x):
                x = fluid.dygraph.to_variable(x)
                if fluid.layers.mean(x) > 0:
                    x_v = x - 1
                else:
                    x_v = x + 1
                return x_v

            prog_trans = fluid.dygraph.ProgramTranslator()
            prog_trans.enable(False)

            x = np.ones([1, 2])
L
liym27 已提交
763
            # The declarative is disabled so the func is run in dygraph
764 765
            with fluid.dygraph.guard():
                print(func(x).numpy()) # [[2. 2.]]
L
liym27 已提交
766

767
        """
768 769
        check_type(enable_declarative, "enable_declarative", bool,
                   "ProgramTranslator.enable")
770
        self.enable_declarative = enable_declarative
771

772 773
    def get_output(self, dygraph_func, *args, **kwargs):
        """
774 775 776 777 778 779
        Returns the output dygraph VarBase for dygraph function. The dygraph
        function will be translated into static graph function so the under
        beneath numerical result will be calculated by declarative mode.

        Args:
            dygraph_func (callable): the dygraph function.
L
liym27 已提交
780
            *args, **kwargs : the input argument of dygraph_func.
781 782 783 784

        Returns:
            VarBase or tuple of VarBase: the dygraph VarBase containing digital
                result.
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801

        Examples:
            .. code-block:: python

                import paddle.fluid as fluid
                import numpy as np

                def func(x):
                    x = fluid.dygraph.to_variable(x)
                    if fluid.layers.mean(x) > 0:
                        x_v = x - 1
                    else:
                        x_v = x + 1
                    return x_v

                prog_trans = fluid.dygraph.ProgramTranslator()

802 803 804 805
                with fluid.dygraph.guard():
                    x = np.ones([1, 2])
                    x_v = prog_trans.get_output(func, x)
                    print(x_v.numpy()) # [[0. 0.]]
806

807
        """
808 809 810
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_output"
811
        if not self.enable_declarative:
812
            warnings.warn(
813 814
                "The ProgramTranslator.get_output doesn't work when setting ProgramTranslator.enable = False. "
                "We will just return dygraph output.")
815 816
            return dygraph_func(*args, **kwargs)

817 818 819 820 821
        function_spec = FunctionSpec(dygraph_func)
        cache_key = CacheKey.from_func_and_args(function_spec, args, kwargs,
                                                getattr(dygraph_func,
                                                        '__self__', None))
        _, partial_program_layer = self._program_cache[cache_key]
822 823

        if args and isinstance(args[0], layers.Layer):
824 825
            # Synchronize self.training attribute.
            partial_program_layer.training = args[0].training
826
            args = args[1:]
827 828 829 830 831 832 833 834 835
        try:
            return partial_program_layer(args)

        except BaseException as e:
            # NOTE:
            # 1. If e is raised in compile time, e should have been attached to ERROR_DATA before;
            # 2. If e raised in runtime, e should be attached to ERROR_DATA here.
            if not hasattr(e, ERROR_DATA):
                # runtime error
836
                attach_error_data(e, in_runtime=True)
837
            raise
838 839 840

    def get_func(self, dygraph_func):
        """
841 842 843 844 845 846 847 848 849 850 851
        Returns a callable function which converts imperative dygraph APIs of
        the input dygraph_func into declarative net-building APIs, which means
        it doesn't return immediate digital result as get_output does.
        Users should handle Program and Executor by themselves.

        Args:
            dygraph_func (callable): the dygraph function.

        Returns:
            callable: converting imperative dygraph APIs into declarative
            net-building APIs.
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871

        Examples:
            .. code-block:: python

                import paddle.fluid as fluid
                import numpy as np

                def func(x):
                    x = fluid.dygraph.to_variable(x)
                    if fluid.layers.mean(x) > 0:
                        x_v = x - 1
                    else:
                        x_v = x + 1
                    return x_v

                prog_trans = fluid.dygraph.ProgramTranslator()

                static_func = prog_trans.get_func(func)
                print(callable(static_func)) # True

872
        """
873 874 875
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_func"
876
        if not self.enable_declarative:
877
            warnings.warn(
878
                "The ProgramTranslator.get_func doesn't work when setting ProgramTranslator.enable=False. We will "
879
                "just return dygraph output.")
880
            return dygraph_func
881

882
        static_func = convert_to_static(dygraph_func)
883 884
        return static_func

885 886
    def get_program(self, dygraph_func, *args, **kwargs):
        """
887
        Returns the translated static program and input/output variables from
888 889 890 891 892 893 894 895 896 897 898 899 900
        dygraph function. The users can use the program to run by executor.

        Args:
            dygraph_func (callable): the dygraph function.
            *args, **kwargs : the input argument of dygraph_func.

        Returns:
            tuple of (main_program, startup_program, inputs, outputs) whose
            types are (Program, Program, list of Variable, list of Variable).
            main_program: the converted main program.
            startup_program: the converted startup program.
            inputs: list of input Variables which need to be fed.
            outputs: list of output Variables which users can fetch.
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920

        Examples:
            .. code-block:: python

                import paddle.fluid as fluid
                import numpy as np

                def func(x):
                    x = fluid.dygraph.to_variable(x)
                    if fluid.layers.mean(x) > 0:
                        x_v = x - 1
                    else:
                        x_v = x + 1
                    return x_v

                prog_trans = fluid.dygraph.ProgramTranslator()

                x = np.ones([1, 2])
                main_prog, start_prog, inputs, outputs = prog_trans.get_program(func, x)
                print([i.name for i in inputs])
921
                # ['feed_0'] the feed input variable name representing x
922 923 924
                print([o.name for o in outputs])
                # ['_generated_var_4'] the fetch output variable name representing x_v        

925
        """
926 927 928
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_program"
929
        if not self.enable_declarative:
930
            warnings.warn(
931 932
                "The ProgramTranslator.get_program doesn't work when setting ProgramTranslator.enable=False."
                "We will just return dygraph output.")
933
            return dygraph_func(*args, **kwargs)
934

935 936 937 938 939 940
        function_spec = FunctionSpec(dygraph_func)
        cache_key = CacheKey.from_func_and_args(function_spec, args, kwargs,
                                                getattr(dygraph_func,
                                                        '__self__', None))
        concrete_program, partial_program_layer = self._program_cache[cache_key]

941 942 943 944 945 946 947 948 949 950
        # Note: concrete_program hold all input/output infos include non-Variable
        input_vars = [
            var for var in concrete_program.inputs
            if isinstance(var, framework.Variable)
        ]
        output_vars = [
            var for var in concrete_program.outputs
            if isinstance(var, framework.Variable)
        ]

951 952
        return concrete_program.main_program, \
               concrete_program.startup_program, \
953 954
               input_vars, \
               output_vars
955

956 957
    def get_code(self, dygraph_func):
        """
958 959 960 961 962 963
        Returns the translated static function string code from dygraph function.

        Args:
            dygraph_func (callable): the dygraph function.

        Returns:
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
            str: the string code of translated static function.

        Examples:
            .. code-block:: python

            import paddle.fluid as fluid
            import numpy as np

            def func(x):
                x = fluid.dygraph.to_variable(x)
                if fluid.layers.mean(x) > 0:
                    x_v = x - 1
                else:
                    x_v = x + 1
                return x_v

            prog_trans = fluid.dygraph.ProgramTranslator()

            code = prog_trans.get_code(func)
            print(type(code)) # <class 'str'>

985
        """
986 987 988
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_code"
989
        # Gets AST from dygraph function
990 991 992

        unwrap_func = unwrap(dygraph_func)
        raw_code = inspect.getsource(unwrap_func)
993 994 995 996 997 998 999 1000 1001 1002 1003
        code = textwrap.dedent(raw_code)
        root = gast.parse(code)

        # Transform AST
        dygraph_to_static = DygraphToStaticAst()
        root_wrapper = dygraph_to_static.get_static_ast(root)

        # Get source_code
        source_code = ast_to_source_code(root_wrapper.node)
        return source_code

1004
    def get_program_cache(self):
1005
        """
1006 1007 1008 1009 1010 1011 1012 1013 1014
        Returns the ProgramCache instance. This method is used by PaddlePaddle
        developers to manage program cache in ProgramTranslator. Normal users
        don't have to call this method.

        Returns:
            ProgramCache: ProgramCache instance of ProgramTranslator.

        Examples:
            .. code-block:: python
1015

1016 1017 1018 1019 1020
                import paddle.fluid as fluid

                prog_trans = fluid.dygraph.ProgramTranslator()
                prog_cache = prog_trans.get_program_cache()

1021
        """
1022
        return self._program_cache