2018-02-24 11:34:05 +08:00
|
|
|
# Copyright (c) 2018 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.
|
|
|
|
|
|
|
|
|
|
import collections
|
2023-12-11 12:50:11 +08:00
|
|
|
from copy import deepcopy
|
2023-09-21 11:07:18 +08:00
|
|
|
|
2019-02-12 09:48:39 +08:00
|
|
|
from .wrapped_decorator import signature_safe_contextmanager
|
2018-02-24 11:34:05 +08:00
|
|
|
|
2023-09-22 12:32:23 +08:00
|
|
|
__all__ = []
|
2018-02-24 11:34:05 +08:00
|
|
|
|
|
|
|
|
|
2022-11-08 11:29:41 +08:00
|
|
|
class UniqueNameGenerator:
|
2018-02-24 11:34:05 +08:00
|
|
|
"""
|
|
|
|
|
Generate unique name with prefix.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
prefix(str): The generated name prefix. All generated name will be
|
|
|
|
|
started with this prefix.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(self, prefix=None):
|
|
|
|
|
self.ids = collections.defaultdict(int)
|
|
|
|
|
if prefix is None:
|
|
|
|
|
prefix = ""
|
|
|
|
|
self.prefix = prefix
|
|
|
|
|
|
|
|
|
|
def __call__(self, key):
|
2023-12-11 12:50:11 +08:00
|
|
|
return self.generate(key)
|
|
|
|
|
|
|
|
|
|
def generate(self, key):
|
2018-02-24 11:34:05 +08:00
|
|
|
"""
|
|
|
|
|
Generate unique names with prefix
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
key(str): The key of return string.
|
|
|
|
|
|
|
|
|
|
Returns(str): A unique string with the prefix
|
|
|
|
|
"""
|
|
|
|
|
tmp = self.ids[key]
|
|
|
|
|
self.ids[key] += 1
|
|
|
|
|
return self.prefix + "_".join([key, str(tmp)])
|
|
|
|
|
|
2023-12-11 12:50:11 +08:00
|
|
|
def generate_with_ignorable_key(self, key):
|
|
|
|
|
from .framework import _dygraph_tracer, in_dygraph_mode
|
|
|
|
|
|
|
|
|
|
if in_dygraph_mode():
|
|
|
|
|
return _dygraph_tracer()._generate_unique_name()
|
|
|
|
|
|
|
|
|
|
return self.generate(key)
|
|
|
|
|
|
|
|
|
|
def clone(self):
|
|
|
|
|
ret = UniqueNameGenerator(self.prefix)
|
|
|
|
|
ret.ids = deepcopy(self.ids)
|
|
|
|
|
return ret
|
|
|
|
|
|
2018-02-24 11:34:05 +08:00
|
|
|
|
2022-11-08 11:29:41 +08:00
|
|
|
class DygraphParameterNameChecker:
|
2020-01-11 20:24:31 +08:00
|
|
|
"""
|
|
|
|
|
Check whether the name of parameter is used.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
|
self._name_set = set()
|
|
|
|
|
|
|
|
|
|
def __call__(self, name):
|
|
|
|
|
'''
|
|
|
|
|
Check whether the name is used. If not used, insert into the _name_set.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
name(str): The name of parameter to check.
|
|
|
|
|
|
|
|
|
|
Returns(bool): If the name is in name_set, return True; Otherwise, return False.
|
|
|
|
|
|
|
|
|
|
'''
|
|
|
|
|
if name in self._name_set:
|
|
|
|
|
return True
|
|
|
|
|
else:
|
|
|
|
|
self._name_set.add(name)
|
|
|
|
|
return False
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
dygraph_parameter_name_checker = DygraphParameterNameChecker()
|
|
|
|
|
|
2018-02-24 11:34:05 +08:00
|
|
|
generator = UniqueNameGenerator()
|
|
|
|
|
|
|
|
|
|
|
2024-06-17 10:02:39 +08:00
|
|
|
def generate(key: str) -> str:
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2019-10-11 08:43:54 +08:00
|
|
|
Generate unique name with prefix key. Currently, Paddle distinguishes the
|
|
|
|
|
names of the same key by numbering it from zero. For example, when key=fc,
|
|
|
|
|
it continuously generates fc_0, fc_1, fc_2, etc.
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Args:
|
2019-10-11 08:43:54 +08:00
|
|
|
key(str): The prefix of generated name.
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Returns:
|
2019-05-28 10:36:22 +08:00
|
|
|
str: A unique string with the prefix key.
|
|
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Examples:
|
2019-10-11 08:43:54 +08:00
|
|
|
|
2026-02-12 08:58:22 +08:00
|
|
|
.. code-block:: pycon
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2023-09-11 11:58:05 +08:00
|
|
|
>>> import paddle
|
|
|
|
|
>>> name1 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> name2 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name1, name2)
|
|
|
|
|
fc_0 fc_1
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2018-02-24 12:51:24 +08:00
|
|
|
return generator(key)
|
2018-02-24 11:34:05 +08:00
|
|
|
|
|
|
|
|
|
2019-05-24 19:27:58 +08:00
|
|
|
# FIXME(zjl): The previous naming rule in static graph would
|
|
|
|
|
# cause memory leak in dygraph mode. It is because the previous
|
2019-06-18 11:33:52 +08:00
|
|
|
# naming rule would use `conv_0.tmp` as the key, and in dygraph
|
2019-05-24 19:27:58 +08:00
|
|
|
# mode, `conv_i` increases as batch increases. Thus, keys would
|
2022-06-05 10:58:58 +08:00
|
|
|
# increase in a way like `conv_0.tmp`, `conv_1.tmp`, ....
|
2019-05-24 19:27:58 +08:00
|
|
|
# Not find a better way to fix this bug in dygraph mode. In TF,
|
|
|
|
|
# variable name is meaningless in eager execution mode, and in
|
|
|
|
|
# PyTorch, there is no variable name at all. Maybe we should
|
|
|
|
|
# discard variable name in dygraph mode.
|
|
|
|
|
#
|
2019-06-18 11:33:52 +08:00
|
|
|
# Another concern is that save/load interfaces. Usually, user
|
2019-05-24 19:27:58 +08:00
|
|
|
# would save model in static graph mode, and load it in dygraph
|
|
|
|
|
# mode. Therefore, we keep the variable name of Parameter currently.
|
2022-06-05 10:58:58 +08:00
|
|
|
#
|
|
|
|
|
# Please fix me if a better method is found.
|
|
|
|
|
#
|
|
|
|
|
# NOTE(zhiqiu): use c++ unique_name_generator in dygraph mode,
|
2020-04-22 19:10:29 +08:00
|
|
|
# in order to keep name consistency.
|
2019-05-24 19:27:58 +08:00
|
|
|
def generate_with_ignorable_key(key):
|
2023-09-21 11:07:18 +08:00
|
|
|
from .framework import _dygraph_tracer, in_dygraph_mode
|
2022-10-23 20:01:27 +08:00
|
|
|
|
2023-05-22 20:56:38 +08:00
|
|
|
if in_dygraph_mode():
|
2020-04-22 19:10:29 +08:00
|
|
|
return _dygraph_tracer()._generate_unique_name()
|
2019-05-24 19:27:58 +08:00
|
|
|
|
|
|
|
|
return generator(key)
|
|
|
|
|
|
|
|
|
|
|
2020-01-11 20:24:31 +08:00
|
|
|
def switch(new_generator=None, new_para_name_checker=None):
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2019-10-11 08:43:54 +08:00
|
|
|
Switch the namespace of in current context to a new namespace. Though
|
2022-09-14 21:56:19 +08:00
|
|
|
:code:`switch()` and :code:`guard()` can both change namespace,
|
|
|
|
|
:code:`guard()` is recommended since it can manage the context better
|
2019-10-11 08:43:54 +08:00
|
|
|
together with :code:`with` statement.
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Args:
|
2019-10-11 08:43:54 +08:00
|
|
|
new_generator(UniqueNameGenerator, optional): A new UniqueNameGenerator, not
|
|
|
|
|
required normally. Default is None, which means switch to a new anonymous
|
|
|
|
|
namespace.
|
2020-01-11 20:24:31 +08:00
|
|
|
new_para_name_checker(DygraphParameterNameChecker, optional): A new DygraphParameterNameChecker,
|
2022-09-14 21:56:19 +08:00
|
|
|
not required normally. Default is None, which means switch to a new parameter name
|
2020-01-11 20:24:31 +08:00
|
|
|
checker.
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Returns:
|
2019-05-28 10:36:22 +08:00
|
|
|
UniqueNameGenerator: The previous UniqueNameGenerator.
|
2020-01-11 20:24:31 +08:00
|
|
|
DygraphParameterNameChecker: The previous DygraphParameterNameChecker
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Examples:
|
2019-10-11 08:43:54 +08:00
|
|
|
|
2026-02-12 08:58:22 +08:00
|
|
|
.. code-block:: pycon
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2023-09-11 11:58:05 +08:00
|
|
|
>>> import paddle
|
|
|
|
|
>>> name1 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> name2 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name1, name2)
|
|
|
|
|
fc_0 fc_1
|
|
|
|
|
|
2026-02-12 08:58:22 +08:00
|
|
|
>>> pre_generator, pre_dygraph_name_checker = paddle.utils.unique_name.switch() # switch to a new anonymous namespace.
|
2023-09-11 11:58:05 +08:00
|
|
|
>>> name2 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name2)
|
|
|
|
|
fc_0
|
|
|
|
|
|
2026-02-12 08:58:22 +08:00
|
|
|
>>> paddle.utils.unique_name.switch(pre_generator, pre_dygraph_name_checker) # switch back to pre_generator.
|
2023-09-11 11:58:05 +08:00
|
|
|
>>> name3 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name3)
|
|
|
|
|
fc_2
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2018-02-24 11:34:05 +08:00
|
|
|
global generator
|
2020-01-11 20:24:31 +08:00
|
|
|
old_generator = generator
|
|
|
|
|
global dygraph_parameter_name_checker
|
|
|
|
|
old_para_name_checker = dygraph_parameter_name_checker
|
2018-02-24 11:34:05 +08:00
|
|
|
if new_generator is None:
|
|
|
|
|
generator = UniqueNameGenerator()
|
|
|
|
|
else:
|
|
|
|
|
generator = new_generator
|
2020-01-11 20:24:31 +08:00
|
|
|
|
|
|
|
|
if new_para_name_checker is None:
|
|
|
|
|
dygraph_parameter_name_checker = DygraphParameterNameChecker()
|
|
|
|
|
else:
|
|
|
|
|
dygraph_parameter_name_checker = new_para_name_checker
|
|
|
|
|
return old_generator, old_para_name_checker
|
2018-02-24 11:34:05 +08:00
|
|
|
|
|
|
|
|
|
2019-02-12 09:48:39 +08:00
|
|
|
@signature_safe_contextmanager
|
2018-02-24 11:34:05 +08:00
|
|
|
def guard(new_generator=None):
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2019-10-11 08:43:54 +08:00
|
|
|
Change the namespace of unique name with :code:`with` statement. After calling it,
|
|
|
|
|
a new namespace in the context of :code:`with` will be created, and it will number
|
|
|
|
|
names from zero again when calling :code:`generate()` with same key.
|
|
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Args:
|
2019-10-11 08:43:54 +08:00
|
|
|
new_generator(str|bytes, optional): New name of global namespace. Note that str
|
2025-03-17 11:42:06 +08:00
|
|
|
in Python2 was split into str and bytes in Python3, so here are two
|
2022-09-14 21:56:19 +08:00
|
|
|
types. Default is None. If not None, new_generator will be added into
|
2019-10-11 08:43:54 +08:00
|
|
|
the prefix of unique name generated by :code:`generate()`.
|
2022-09-14 21:56:19 +08:00
|
|
|
|
2019-10-11 08:43:54 +08:00
|
|
|
Returns:
|
|
|
|
|
None.
|
|
|
|
|
|
2022-09-14 21:56:19 +08:00
|
|
|
Examples:
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2026-02-12 08:58:22 +08:00
|
|
|
.. code-block:: pycon
|
2019-05-28 10:36:22 +08:00
|
|
|
|
2023-09-11 11:58:05 +08:00
|
|
|
>>> import paddle
|
|
|
|
|
>>> with paddle.utils.unique_name.guard():
|
|
|
|
|
... name_1 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> with paddle.utils.unique_name.guard():
|
|
|
|
|
... name_2 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name_1, name_2)
|
|
|
|
|
fc_0 fc_0
|
|
|
|
|
|
|
|
|
|
>>> with paddle.utils.unique_name.guard('A'):
|
|
|
|
|
... name_1 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> with paddle.utils.unique_name.guard('B'):
|
|
|
|
|
... name_2 = paddle.utils.unique_name.generate('fc')
|
|
|
|
|
>>> print(name_1, name_2)
|
|
|
|
|
Afc_0 Bfc_0
|
2019-05-28 10:36:22 +08:00
|
|
|
"""
|
2022-10-19 15:54:41 +08:00
|
|
|
if isinstance(new_generator, str):
|
2018-02-24 11:34:05 +08:00
|
|
|
new_generator = UniqueNameGenerator(new_generator)
|
2022-10-19 15:54:41 +08:00
|
|
|
elif isinstance(new_generator, bytes):
|
2018-08-10 17:16:54 +08:00
|
|
|
new_generator = UniqueNameGenerator(new_generator.decode())
|
2020-01-11 20:24:31 +08:00
|
|
|
|
|
|
|
|
old_generator, old_para_name_checker = switch(new_generator)
|
2020-04-29 22:59:35 +08:00
|
|
|
try:
|
|
|
|
|
yield
|
|
|
|
|
finally:
|
|
|
|
|
switch(old_generator, old_para_name_checker)
|
