88 lines
3.4 KiB
Python
88 lines
3.4 KiB
Python
|
# Copyright 2016 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.
|
||
|
|
# ==============================================================================
|
||
|
|
"""Summary Operations."""
|
||
|
|
from __future__ import absolute_import
|
||
|
|
from __future__ import division
|
||
|
|
from __future__ import print_function
|
||
|
|
|
||
|
|
from tensorflow.core.framework import summary_pb2
|
||
|
|
from tensorflow.python.framework import constant_op
|
||
|
|
from tensorflow.python.framework import ops
|
||
|
|
from tensorflow.python.ops import gen_logging_ops
|
||
|
|
from tensorflow.python.ops import summary_op_util
|
||
|
|
# go/tf-wildcard-import
|
||
|
|
# pylint: disable=wildcard-import
|
||
|
|
from tensorflow.python.ops.gen_logging_ops import *
|
||
|
|
from tensorflow.python.util.tf_export import tf_export
|
||
|
|
# pylint: enable=wildcard-import
|
||
|
|
|
||
|
|
|
||
|
|
@tf_export("summary.tensor_summary")
|
||
|
|
def tensor_summary(name,
|
||
|
|
tensor,
|
||
|
|
summary_description=None,
|
||
|
|
collections=None,
|
||
|
|
summary_metadata=None,
|
||
|
|
family=None,
|
||
|
|
display_name=None):
|
||
|
|
"""Outputs a `Summary` protocol buffer with a serialized tensor.proto.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
name: A name for the generated node. If display_name is not set, it will
|
||
|
|
also serve as the tag name in TensorBoard. (In that case, the tag
|
||
|
|
name will inherit tf name scopes.)
|
||
|
|
tensor: A tensor of any type and shape to serialize.
|
||
|
|
summary_description: A long description of the summary sequence. Markdown
|
||
|
|
is supported.
|
||
|
|
collections: Optional list of graph collections keys. The new summary op is
|
||
|
|
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
|
||
|
|
summary_metadata: Optional SummaryMetadata proto (which describes which
|
||
|
|
plugins may use the summary value).
|
||
|
|
family: Optional; if provided, used as the prefix of the summary tag,
|
||
|
|
which controls the name used for display on TensorBoard when
|
||
|
|
display_name is not set.
|
||
|
|
display_name: A string used to name this data in TensorBoard. If this is
|
||
|
|
not set, then the node name will be used instead.
|
||
|
|
|
||
|
|
Returns:
|
||
|
|
A scalar `Tensor` of type `string`. The serialized `Summary` protocol
|
||
|
|
buffer.
|
||
|
|
"""
|
||
|
|
|
||
|
|
if summary_metadata is None:
|
||
|
|
summary_metadata = summary_pb2.SummaryMetadata()
|
||
|
|
|
||
|
|
if summary_description is not None:
|
||
|
|
summary_metadata.summary_description = summary_description
|
||
|
|
|
||
|
|
if display_name is not None:
|
||
|
|
summary_metadata.display_name = display_name
|
||
|
|
|
||
|
|
serialized_summary_metadata = summary_metadata.SerializeToString()
|
||
|
|
|
||
|
|
if summary_op_util.skip_summary():
|
||
|
|
return constant_op.constant("")
|
||
|
|
with summary_op_util.summary_scope(
|
||
|
|
name, family, values=[tensor]) as (tag, scope):
|
||
|
|
val = gen_logging_ops.tensor_summary_v2(
|
||
|
|
tensor=tensor,
|
||
|
|
tag=tag,
|
||
|
|
name=scope,
|
||
|
|
serialized_summary_metadata=serialized_summary_metadata)
|
||
|
|
summary_op_util.collect(val, collections, [ops.GraphKeys.SUMMARIES])
|
||
|
|
return val
|
||
|
|
|
||
|
|
ops.NotDifferentiable("TensorSummary")
|