program_translator.py 37.4 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
from paddle.fluid.dygraph.dygraph_to_static import error
36
from paddle.fluid.dygraph.dygraph_to_static import logging_utils
37 38 39 40 41
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
42
from paddle.fluid.dygraph.dygraph_to_static.utils import ast_to_source_code
43
from paddle.fluid.dygraph.dygraph_to_static.utils import func_to_source_code
44
from paddle.fluid.dygraph.dygraph_to_static.utils import type_name
45
from paddle.fluid.dygraph.dygraph_to_static.utils import unwrap
46 47 48
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
49
from paddle.fluid.wrapped_decorator import signature_safe_contextmanager
50

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

53 54 55 56
# 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

57 58 59 60 61 62 63

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

    def __init__(self):
64 65 66 67 68
        # 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()
69

70 71 72 73 74 75
    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)
76 77

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

        return static_func

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    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.
104
        func = unwrap(func)
105
        source_code = func_to_source_code(func)
106 107 108 109 110

        # 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
111 112 113 114
        if source_code in self._code_to_ast_caches:
            root_wrapper = self._code_to_ast_caches[source_code]
        else:
            root = gast.parse(source_code)
115
            root = attach_origin_info(root, func)
116 117
            root_wrapper = self._dygraph_to_static.get_static_ast(root)
            self._code_to_ast_caches[source_code] = root_wrapper
118

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

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

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


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


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

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


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

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

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

156 157 158 159
        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`.
160
        """
161 162 163 164 165 166
        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):
167
        """
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
        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)
216
            else:
217 218 219 220
                cur = cur.dygraph_function
        else:
            break
    return decorators, cur
221

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

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()
248
        self._descriptor_cache = weakref.WeakKeyDictionary()
249
        # Note: Hold a reference to ProgramTranslator for switching `enable_to_static`.
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
        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.
        """
275 276 277 278 279 280 281 282 283 284 285 286 287
        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)
288 289

    def __call__(self, *args, **kwargs):
290
        """
291 292 293 294 295 296 297 298
        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.
299
        """
300

301
        # 1. call dygraph function directly if not enable `declarative`
302
        if not self._program_trans.enable_to_static:
303
            logging_utils.warn(
304 305 306
                "The decorator '@paddle.jit.to_static' does NOT work when setting ProgramTranslator.enable to False. "
                "We will just return dygraph output. If you would like to get static graph output, please call API "
                "ProgramTranslator.enable(True)")
307 308
            return self._call_dygraph_function(*args, **kwargs)

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

316 317
        # 2. trace ops from dygraph layers and cache the generated program.
        args, kwargs = self._function_spec.unified_args_and_kwargs(args, kwargs)
318

319 320 321 322 323 324 325 326 327
        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.
328 329 330 331 332 333 334
            try:
                return partial_program_layer(args)
            except Exception as e:
                if not hasattr(e, error.ERROR_DATA):
                    # runtime error
                    error.attach_error_data(e, in_runtime=True)
                    raise
335
        except Exception as e:
336
            error_data = getattr(e, error.ERROR_DATA, None)
337
            if error_data:
338
                error_data.raise_new_exception()
339
            else:
340 341 342 343
                logging_utils.warn(
                    "Please file an issue at 'https://github.com/PaddlePaddle/Paddle/issues'"
                    " if you can't handle this {} yourself.".format(type(e)))
                raise e
344

345 346 347 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
    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 已提交
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

        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)
437 438 439 440 441 442
        """
        # 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 已提交
443 444 445
            input_spec = self._function_spec.input_spec
            has_input_spec = (input_spec is not None and len(input_spec) > 0)
            if has_input_spec:
446 447
                concrete_program, _ = self.get_concrete_program(*input_spec)
                return concrete_program
448
            else:
A
Aurelius84 已提交
449 450 451
                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))
452 453 454 455 456 457 458 459 460
        # 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
461

462 463 464 465 466 467 468 469 470 471 472
    @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
473

474
    @property
475 476 477 478 479 480 481 482 483 484 485
    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
486

487
    @property
488 489 490 491 492 493 494
    def main_program(self):
        """
        Returns recent converted static main program.
        """
        concrete_program = self.concrete_program
        main_program = concrete_program.main_program
        return main_program
495

496 497 498
    @property
    def program_cache(self):
        return self._program_cache
499

500 501 502
    @property
    def function_spec(self):
        return self._function_spec
503 504


505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
# 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


527
class ConcreteProgram(object):
528 529 530 531 532 533

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

534 535 536 537
    def __init__(self,
                 inputs,
                 outputs,
                 parameters,
538
                 function,
539
                 main_program,
540
                 startup_program=None):
541 542 543
        self.inputs = inputs
        self.outputs = outputs
        self.main_program = main_program
544
        self.startup_program = startup_program
545
        self.parameters = parameters
546
        self.function = function
547 548 549

    @staticmethod
    @switch_to_static_graph
550
    def from_func_spec(func_spec, input_spec, class_instance):
551
        """
552 553
        Builds the main_program with specialized inputs and returns outputs
        of program as fetch_list.
554 555 556 557

        Args:
            func_spec(FunctionSpec): A FunctionSpec instance for decorated function.
            input_spec(list[InputSpec]): 
558
        """
559
        # Transforms dygraph function into static function and caches it.
560
        dygraph_function = func_spec.dygraph_function
561
        static_func = convert_to_static(dygraph_function)
562

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

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

579
                # 2. Gets all ParamBases and buffered VarBases in the function
580 581 582
                all_parameters_and_buffers = list(
                    get_parameters(class_instance).values()) + list(
                        get_buffers(class_instance).values())
583 584

                # 3. Builds program only once and returns the output Variables.
585 586 587
                with param_guard(get_parameters(
                        class_instance, False)), param_guard(
                            get_buffers(class_instance, False)):
588 589 590 591
                    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.
592
                        error.attach_error_data(e)
593 594
                        raise

595 596 597
                if not isinstance(outputs,
                                  (tuple, list)) and outputs is not None:
                    outputs = [outputs]
598

599 600
        main_program = update_op_callstack_with_origin_info(main_program)

601 602 603
        return ConcreteProgram(
            inputs=inputs,
            outputs=outputs,
604
            parameters=all_parameters_and_buffers,
605
            function=dygraph_function,
606
            main_program=main_program,
607
            startup_program=startup_program)
608 609


610 611 612 613
class ProgramCache(object):
    """
    Wrapper class for the program functions defined by dygraph function.
    """
614

615
    def __init__(self):
616
        self._caches = collections.OrderedDict()
617

618 619 620 621 622
    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)
623
        return concrete_program, partial_program_from(concrete_program)
624

625
    def __getitem__(self, item):
626 627 628 629
        if not isinstance(item, CacheKey):
            raise ValueError('type(item) should be CacheKey, but received %s' %
                             type_name(item))

630 631
        if item not in self._caches:
            self._caches[item] = self._build_once(item)
632 633 634 635 636 637 638 639
            # 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))

640
        return self._caches[item]
641

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

653 654 655 656 657 658
    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]

659 660 661 662
    def __len__(self):
        return len(self._caches)

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

665

666 667
def synchronized(func):
    func.__lock__ = threading.Lock()
668

669 670 671
    def lock_func(*args, **kwargs):
        with func.__lock__:
            return func(*args, **kwargs)
672

673
    return lock_func
674 675


676
class ProgramTranslator(object):
677
    """
678 679 680 681 682 683 684 685 686 687 688 689 690 691
    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

692
        # Two methods get same object because ProgramTranslator is a singleton
693 694 695
        fluid.dygraph.ProgramTranslator()
        fluid.dygraph.ProgramTranslator.get_instance()

696 697
    """

698
    _singleton_lock = threading.Lock()
699 700 701 702 703 704
    _instance = None

    @synchronized
    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = object.__new__(cls, *args, **kwargs)
705
            cls._instance._initialized = False
706 707 708 709 710
        return cls._instance

    @classmethod
    def get_instance(cls):
        if cls._instance is None:
711 712
            with cls._singleton_lock:
                cls._instance = cls()
713 714 715 716 717
        return cls._instance

    @classmethod
    def reset(cls):
        if cls._instance is not None:
718
            cls._instance._initialized = False
719 720
            cls._instance.__init__()

721
    def __init__(self):
722
        # To make sure that calls __init__ only once.
723
        if self._initialized:
724
            return
725 726
        self._initialized = True
        self._program_cache = ProgramCache()
727
        self.enable_to_static = True
728

729
    def enable(self, enable_to_static):
730 731 732 733 734
        """
        Enable or disable the converting from imperative to declarative by
        ProgramTranslator globally.

        Args:
735
            enable_to_static (bool): True or False to enable or disable declarative.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

        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 已提交
759
            # The declarative is disabled so the func is run in dygraph
760 761
            with fluid.dygraph.guard():
                print(func(x).numpy()) # [[2. 2.]]
L
liym27 已提交
762

763
        """
764
        check_type(enable_to_static, "enable_to_static", bool,
765
                   "ProgramTranslator.enable")
766
        self.enable_to_static = enable_to_static
767

768 769
    def get_output(self, dygraph_func, *args, **kwargs):
        """
770 771 772 773 774 775
        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 已提交
776
            *args, **kwargs : the input argument of dygraph_func.
777 778 779 780

        Returns:
            VarBase or tuple of VarBase: the dygraph VarBase containing digital
                result.
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797

        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()

798 799 800 801
                with fluid.dygraph.guard():
                    x = np.ones([1, 2])
                    x_v = prog_trans.get_output(func, x)
                    print(x_v.numpy()) # [[0. 0.]]
802

803
        """
804 805 806
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_output"
807
        if not self.enable_to_static:
808
            warnings.warn(
809 810 811 812
                "The ProgramTranslator.get_output doesn't work when setting ProgramTranslator.enable to False. "
                "We will just return dygraph output. "
                "Please call ProgramTranslator.enable(True) if you would like to get static output."
            )
813
            return dygraph_func(*args, **kwargs)
814
        try:
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
            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]

            if args and isinstance(args[0], layers.Layer):
                # Synchronize self.training attribute.
                partial_program_layer.training = args[0].training
                args = args[1:]
            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.ERROR_DATA):
                    # runtime error
                    error.attach_error_data(e, in_runtime=True)
                raise
835
        except BaseException as e:
836 837 838 839 840 841 842 843
            error_data = getattr(e, error.ERROR_DATA, None)
            if error_data:
                error_data.raise_new_exception()
            else:
                logging_utils.warn(
                    "Please file an issue at 'https://github.com/PaddlePaddle/Paddle/issues'"
                    " if you can't handle this {} yourself.".format(type(e)))
                raise e
844 845 846

    def get_func(self, dygraph_func):
        """
847 848 849 850 851 852 853 854 855 856 857
        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.
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877

        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

878
        """
879 880 881
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_func"
882
        if not self.enable_to_static:
883
            warnings.warn(
884 885 886
                "The ProgramTranslator.get_func doesn't work when setting ProgramTranslator.enable to False. We will "
                "just return dygraph output. Please call ProgramTranslator.enable(True) if you would like to get static output."
            )
887
            return dygraph_func
888

889
        static_func = convert_to_static(dygraph_func)
890 891
        return static_func

892 893
    def get_program(self, dygraph_func, *args, **kwargs):
        """
894
        Returns the translated static program and input/output variables from
895 896 897 898 899 900 901 902 903 904 905 906 907
        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.
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927

        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])
928
                # ['feed_0'] the feed input variable name representing x
929 930 931
                print([o.name for o in outputs])
                # ['_generated_var_4'] the fetch output variable name representing x_v        

932
        """
933 934 935
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_program"
936
        if not self.enable_to_static:
937
            warnings.warn(
938 939 940 941
                "The ProgramTranslator.get_program doesn't work when setting ProgramTranslator.enable to False."
                "We will just return dygraph output. "
                "Please call ProgramTranslator.enable(True) if you would like to get static output."
            )
942
            return dygraph_func(*args, **kwargs)
943

944 945 946 947 948 949
        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]

950 951 952 953 954 955 956 957 958 959
        # 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)
        ]

960 961
        return concrete_program.main_program, \
               concrete_program.startup_program, \
962 963
               input_vars, \
               output_vars
964

965 966
    def get_code(self, dygraph_func):
        """
967 968 969 970 971 972
        Returns the translated static function string code from dygraph function.

        Args:
            dygraph_func (callable): the dygraph function.

        Returns:
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
            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'>

994
        """
995 996 997
        assert callable(
            dygraph_func
        ), "Input dygraph_func is not a callable in ProgramTranslator.get_code"
998
        # Gets AST from dygraph function
999 1000 1001

        unwrap_func = unwrap(dygraph_func)
        raw_code = inspect.getsource(unwrap_func)
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
        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

1013
    def get_program_cache(self):
1014
        """
1015 1016 1017 1018 1019 1020 1021 1022 1023
        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
1024

1025 1026 1027 1028 1029
                import paddle.fluid as fluid

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

1030
        """
1031
        return self._program_cache