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 content == '{}' or content == b'{}':
# Old-style JSON format. Equivalent to an all-default proto.
return plugin_data_pb2.HistogramPluginData()
else:
result = plugin_data_pb2.HistogramPluginData()
# TODO(@jart): Instead of converting to bytes, assert that the input
# is a bytestring, and raise a ValueError otherwise...but only after
# converting `PluginData`'s `content` field to have type `bytes`
# instead of `string`.
result.ParseFromString(tf.compat.as_bytes(content))
if result.version == 0:
return result
else:
tf.logging.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
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
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
# No other versions known at this time, so no migrations to do.
return result