forked from tensorflow/tensorboard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metadata.py
77 lines (65 loc) · 2.64 KB
/
metadata.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Copyright 2017 The TensorFlow 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.
# ==============================================================================
"""Information about histogram summaries."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from tensorboard.compat.proto import summary_pb2
from tensorboard.plugins.histogram import plugin_data_pb2
from tensorboard.util import tb_logging
logger = tb_logging.get_logger()
PLUGIN_NAME = "histograms"
# The most recent value for the `version` field of the
# `HistogramPluginData` proto.
PROTO_VERSION = 0
def create_summary_metadata(display_name, description):
"""Create a `summary_pb2.SummaryMetadata` proto for histogram plugin data.
Returns:
A `summary_pb2.SummaryMetadata` protobuf object.
"""
content = plugin_data_pb2.HistogramPluginData(version=PROTO_VERSION)
return summary_pb2.SummaryMetadata(
display_name=display_name,
summary_description=description,
plugin_data=summary_pb2.SummaryMetadata.PluginData(
plugin_name=PLUGIN_NAME, content=content.SerializeToString()
),
)
def parse_plugin_metadata(content):
"""Parse summary metadata to a Python object.
Arguments:
content: The `content` field of a `SummaryMetadata` proto
corresponding to the histogram plugin.
Returns:
A `HistogramPluginData` protobuf object.
"""
if not isinstance(content, bytes):
raise TypeError("Content type must be bytes")
if content == b"{}":
# Old-style JSON format. Equivalent to an all-default proto.
return plugin_data_pb2.HistogramPluginData()
else:
result = plugin_data_pb2.HistogramPluginData.FromString(content)
if result.version == 0:
return result
else:
logger.warn(
"Unknown metadata version: %s. The latest version known to "
"this build of TensorBoard is %s; perhaps a newer build is "
"available?",
result.version,
PROTO_VERSION,
)
return result