302 lines
12 KiB
Python
302 lines
12 KiB
Python
# copyright (c) 2021 PaddlePaddle Authors. All Rights Reserve.
|
|
#
|
|
# 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 typing import Tuple, List, Dict, Union, Callable, Any
|
|
|
|
from paddle import nn
|
|
from ....utils import logger
|
|
|
|
|
|
class Identity(nn.Layer):
|
|
def __init__(self):
|
|
super(Identity, self).__init__()
|
|
|
|
def forward(self, inputs):
|
|
return inputs
|
|
|
|
|
|
class TheseusLayer(nn.Layer):
|
|
def __init__(self, *args, **kwargs):
|
|
super(TheseusLayer, self).__init__()
|
|
self.res_dict = {}
|
|
self.res_name = self.full_name()
|
|
self.pruner = None
|
|
self.quanter = None
|
|
|
|
def _return_dict_hook(self, layer, input, output):
|
|
res_dict = {"logits": output}
|
|
# 'list' is needed to avoid error raised by popping self.res_dict
|
|
for res_key in list(self.res_dict):
|
|
# clear the res_dict because the forward process may change according to input
|
|
res_dict[res_key] = self.res_dict.pop(res_key)
|
|
return res_dict
|
|
|
|
def init_res(self,
|
|
stages_pattern,
|
|
return_patterns=None,
|
|
return_stages=None):
|
|
if return_patterns and return_stages:
|
|
msg = f"The 'return_patterns' would be ignored when 'return_stages' is set."
|
|
logger.warning(msg)
|
|
return_stages = None
|
|
|
|
if return_stages is True:
|
|
return_patterns = stages_pattern
|
|
# return_stages is int or bool
|
|
if type(return_stages) is int:
|
|
return_stages = [return_stages]
|
|
if isinstance(return_stages, list):
|
|
if max(return_stages) > len(stages_pattern) or min(
|
|
return_stages) < 0:
|
|
msg = f"The 'return_stages' set error. Illegal value(s) have been ignored. The stages' pattern list is {stages_pattern}."
|
|
logger.warning(msg)
|
|
return_stages = [
|
|
val for val in return_stages
|
|
if val >= 0 and val < len(stages_pattern)
|
|
]
|
|
return_patterns = [stages_pattern[i] for i in return_stages]
|
|
|
|
if return_patterns:
|
|
self.update_res(return_patterns)
|
|
|
|
def replace_sub(self, *args, **kwargs) -> None:
|
|
msg = "The function 'replace_sub()' is deprecated, please use 'upgrade_sublayer()' instead."
|
|
logger.error(DeprecationWarning(msg))
|
|
raise DeprecationWarning(msg)
|
|
|
|
def upgrade_sublayer(self,
|
|
layer_name_pattern: Union[str, List[str]],
|
|
handle_func: Callable[[nn.Layer, str], nn.Layer]
|
|
) -> Dict[str, nn.Layer]:
|
|
"""use 'handle_func' to modify the sub-layer(s) specified by 'layer_name_pattern'.
|
|
|
|
Args:
|
|
layer_name_pattern (Union[str, List[str]]): The name of layer to be modified by 'handle_func'.
|
|
handle_func (Callable[[nn.Layer, str], nn.Layer]): The function to modify target layer specified by 'layer_name_pattern'. The formal params are the layer(nn.Layer) and pattern(str) that is (a member of) layer_name_pattern (when layer_name_pattern is List type). And the return is the layer processed.
|
|
|
|
Returns:
|
|
Dict[str, nn.Layer]: The key is the pattern and corresponding value is the result returned by 'handle_func()'.
|
|
|
|
Examples:
|
|
|
|
from paddle import nn
|
|
import paddleclas
|
|
|
|
def rep_func(layer: nn.Layer, pattern: str):
|
|
new_layer = nn.Conv2D(
|
|
in_channels=layer._in_channels,
|
|
out_channels=layer._out_channels,
|
|
kernel_size=5,
|
|
padding=2
|
|
)
|
|
return new_layer
|
|
|
|
net = paddleclas.MobileNetV1()
|
|
res = net.replace_sub(layer_name_pattern=["blocks[11].depthwise_conv.conv", "blocks[12].depthwise_conv.conv"], handle_func=rep_func)
|
|
print(res)
|
|
# {'blocks[11].depthwise_conv.conv': the corresponding new_layer, 'blocks[12].depthwise_conv.conv': the corresponding new_layer}
|
|
"""
|
|
|
|
if not isinstance(layer_name_pattern, list):
|
|
layer_name_pattern = [layer_name_pattern]
|
|
|
|
hit_layer_pattern_list = []
|
|
for pattern in layer_name_pattern:
|
|
# parse pattern to find target layer and its parent
|
|
layer_list = parse_pattern_str(pattern=pattern, parent_layer=self)
|
|
if not layer_list:
|
|
continue
|
|
sub_layer_parent = layer_list[-2]["layer"] if len(
|
|
layer_list) > 1 else self
|
|
|
|
sub_layer = layer_list[-1]["layer"]
|
|
sub_layer_name = layer_list[-1]["name"]
|
|
sub_layer_index = layer_list[-1]["index"]
|
|
|
|
new_sub_layer = handle_func(sub_layer, pattern)
|
|
|
|
if sub_layer_index:
|
|
getattr(sub_layer_parent,
|
|
sub_layer_name)[sub_layer_index] = new_sub_layer
|
|
else:
|
|
setattr(sub_layer_parent, sub_layer_name, new_sub_layer)
|
|
|
|
hit_layer_pattern_list.append(pattern)
|
|
return hit_layer_pattern_list
|
|
|
|
def stop_after(self, stop_layer_name: str) -> bool:
|
|
"""stop forward and backward after 'stop_layer_name'.
|
|
|
|
Args:
|
|
stop_layer_name (str): The name of layer that stop forward and backward after this layer.
|
|
|
|
Returns:
|
|
bool: 'True' if successful, 'False' otherwise.
|
|
"""
|
|
|
|
layer_list = parse_pattern_str(stop_layer_name, self)
|
|
if not layer_list:
|
|
return False
|
|
|
|
parent_layer = self
|
|
for layer_dict in layer_list:
|
|
name, index = layer_dict["name"], layer_dict["index"]
|
|
if not set_identity(parent_layer, name, index):
|
|
msg = f"Failed to set the layers that after stop_layer_name('{stop_layer_name}') to IdentityLayer. The error layer's name is '{name}'."
|
|
logger.warning(msg)
|
|
return False
|
|
parent_layer = layer_dict["layer"]
|
|
|
|
return True
|
|
|
|
def update_res(
|
|
self,
|
|
return_patterns: Union[str, List[str]]) -> Dict[str, nn.Layer]:
|
|
"""update the result(s) to be returned.
|
|
|
|
Args:
|
|
return_patterns (Union[str, List[str]]): The name of layer to return output.
|
|
|
|
Returns:
|
|
Dict[str, nn.Layer]: The pattern(str) and corresponding layer(nn.Layer) that have been set successfully.
|
|
"""
|
|
|
|
# clear res_dict that could have been set
|
|
self.res_dict = {}
|
|
|
|
class Handler(object):
|
|
def __init__(self, res_dict):
|
|
# res_dict is a reference
|
|
self.res_dict = res_dict
|
|
|
|
def __call__(self, layer, pattern):
|
|
layer.res_dict = self.res_dict
|
|
layer.res_name = pattern
|
|
if hasattr(layer, "hook_remove_helper"):
|
|
layer.hook_remove_helper.remove()
|
|
layer.hook_remove_helper = layer.register_forward_post_hook(
|
|
save_sub_res_hook)
|
|
return layer
|
|
|
|
handle_func = Handler(self.res_dict)
|
|
|
|
hit_layer_pattern_list = self.upgrade_sublayer(
|
|
return_patterns, handle_func=handle_func)
|
|
|
|
if hasattr(self, "hook_remove_helper"):
|
|
self.hook_remove_helper.remove()
|
|
self.hook_remove_helper = self.register_forward_post_hook(
|
|
self._return_dict_hook)
|
|
|
|
return hit_layer_pattern_list
|
|
|
|
|
|
def save_sub_res_hook(layer, input, output):
|
|
layer.res_dict[layer.res_name] = output
|
|
|
|
|
|
def set_identity(parent_layer: nn.Layer,
|
|
layer_name: str,
|
|
layer_index: str=None) -> bool:
|
|
"""set the layer specified by layer_name and layer_index to Indentity.
|
|
|
|
Args:
|
|
parent_layer (nn.Layer): The parent layer of target layer specified by layer_name and layer_index.
|
|
layer_name (str): The name of target layer to be set to Indentity.
|
|
layer_index (str, optional): The index of target layer to be set to Indentity in parent_layer. Defaults to None.
|
|
|
|
Returns:
|
|
bool: True if successfully, False otherwise.
|
|
"""
|
|
|
|
stop_after = False
|
|
for sub_layer_name in parent_layer._sub_layers:
|
|
if stop_after:
|
|
parent_layer._sub_layers[sub_layer_name] = Identity()
|
|
continue
|
|
if sub_layer_name == layer_name:
|
|
stop_after = True
|
|
|
|
if layer_index and stop_after:
|
|
stop_after = False
|
|
for sub_layer_index in parent_layer._sub_layers[
|
|
layer_name]._sub_layers:
|
|
if stop_after:
|
|
parent_layer._sub_layers[layer_name][
|
|
sub_layer_index] = Identity()
|
|
continue
|
|
if layer_index == sub_layer_index:
|
|
stop_after = True
|
|
|
|
return stop_after
|
|
|
|
|
|
def parse_pattern_str(pattern: str, parent_layer: nn.Layer) -> Union[
|
|
None, List[Dict[str, Union[nn.Layer, str, None]]]]:
|
|
"""parse the string type pattern.
|
|
|
|
Args:
|
|
pattern (str): The pattern to discribe layer.
|
|
parent_layer (nn.Layer): The root layer relative to the pattern.
|
|
|
|
Returns:
|
|
Union[None, List[Dict[str, Union[nn.Layer, str, None]]]]: None if failed. If successfully, the members are layers parsed in order:
|
|
[
|
|
{"layer": first layer, "name": first layer's name parsed, "index": first layer's index parsed if exist},
|
|
{"layer": second layer, "name": second layer's name parsed, "index": second layer's index parsed if exist},
|
|
...
|
|
]
|
|
"""
|
|
|
|
pattern_list = pattern.split(".")
|
|
if not pattern_list:
|
|
msg = f"The pattern('{pattern}') is illegal. Please check and retry."
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
layer_list = []
|
|
while len(pattern_list) > 0:
|
|
if '[' in pattern_list[0]:
|
|
target_layer_name = pattern_list[0].split('[')[0]
|
|
target_layer_index = pattern_list[0].split('[')[1].split(']')[0]
|
|
else:
|
|
target_layer_name = pattern_list[0]
|
|
target_layer_index = None
|
|
|
|
target_layer = getattr(parent_layer, target_layer_name, None)
|
|
|
|
if target_layer is None:
|
|
msg = f"Not found layer named('{target_layer_name}') specifed in pattern('{pattern}')."
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
if target_layer_index and target_layer:
|
|
if int(target_layer_index) < 0 or int(target_layer_index) >= len(
|
|
target_layer):
|
|
msg = f"Not found layer by index('{target_layer_index}') specifed in pattern('{pattern}'). The index should < {len(target_layer)} and > 0."
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
target_layer = target_layer[target_layer_index]
|
|
|
|
layer_list.append({
|
|
"layer": target_layer,
|
|
"name": target_layer_name,
|
|
"index": target_layer_index
|
|
})
|
|
|
|
pattern_list = pattern_list[1:]
|
|
parent_layer = target_layer
|
|
return layer_list
|