1# Copyright 2020 Huawei Technologies Co., Ltd 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14# ============================================================================ 15"""Generate the explain event which conform to proto format.""" 16import time 17 18from ..summary_pb2 import Event, Explain 19 20 21def check_explain_proto(explain): 22 """ 23 Package the explain event. 24 25 Args: 26 explain (Explain): The object of summary_pb2.Explain. 27 """ 28 if not isinstance(explain, Explain): 29 raise TypeError(f'Plugin explainer expects a {Explain.__name__} value.') 30 31 if not explain.image_path and not explain.inference and not explain.metadata.label and not explain.benchmark: 32 raise ValueError('One of metadata, image path, inference or benchmark has to be filled in.') 33 34 35def package_explain_event(explain_str): 36 """ 37 Package the explain event. 38 39 Args: 40 explain_str (string): The serialize string of summary_pb2.Explain. 41 42 Returns: 43 Event, event object. 44 """ 45 event = Event() 46 event.wall_time = time.time() 47 event.explain.ParseFromString(explain_str) 48 return event.SerializeToString() 49