def create_summary_metadata(display_name, description):
"""Create a `summary_pb2.SummaryMetadata` proto for scalar plugin data.
Returns:
A `summary_pb2.SummaryMetadata` protobuf object.
"""
content = plugin_data_pb2.ScalarPluginData(version=PROTO_VERSION)
metadata = summary_pb2.SummaryMetadata(
display_name=display_name,
summary_description=description,
plugin_data=summary_pb2.SummaryMetadata.PluginData(
plugin_name=PLUGIN_NAME, content=content.SerializeToString()))
return metadata
def parse_plugin_metadata(content):
"""Parse summary metadata to a Python object.
Arguments:
content: The `content` field of a `SummaryMetadata` proto
corresponding to the scalar plugin.
Returns:
A `ScalarPluginData` protobuf object.
"""
result = plugin_data_pb2.ScalarPluginData()
# 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
