Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/tensorboard/plugins/custom_scalar/metadata.py: 83%

1# Copyright 2017 The TensorFlow Authors. All Rights Reserved. 

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"""Information on the custom scalars plugin.""" 

16 

17 

18from tensorboard.compat.proto import summary_pb2 

19 

20# A special tag named used for the summary that stores the layout. 

21CONFIG_SUMMARY_TAG = "custom_scalars__config__" 

22 

23PLUGIN_NAME = "custom_scalars" 

24 

25 

26def create_summary_metadata(): 

27 """Create a `SummaryMetadata` proto for custom scalar plugin data. 

28 

29 Returns: 

30 A `summary_pb2.SummaryMetadata` protobuf object. 

31 """ 

32 return summary_pb2.SummaryMetadata( 

33 plugin_data=summary_pb2.SummaryMetadata.PluginData( 

34 plugin_name=PLUGIN_NAME 

35 ) 

36 )