tf.compat.v1.summary.image

Outputs a Summary protocol buffer with images.

tf.compat.v1.summary.image(
    name, tensor, max_outputs=3, collections=None, family=None
)

Migrate to TF2

For compatibility purposes, when invoked in TF2 where the outermost context is eager mode, this API will check if there is a suitable TF2 summary writer context available, and if so will forward this call to that writer instead. A "suitable" writer context means that the writer is set as the default writer, and there is an associated non-empty value for step (see tf.summary.SummaryWriter.as_default, tf.summary.experimental.set_step or alternatively tf.compat.v1.train.create_global_step). For the forwarded call, the arguments here will be passed to the TF2 implementation of tf.summary.image, and the return value will be an empty bytestring tensor, to avoid duplicate summary writing. This forwarding is best-effort and not all arguments will be preserved. Additionally:

  • The TF2 op does not do any of the normalization steps described above. Rather than rescaling data that's outside the expected range, it simply clips it.
  • The TF2 op just outputs the data under a single tag that contains multiple samples, rather than multiple tags (i.e. no "/0" or "/1" suffixes).

To migrate to TF2, please use tf.summary.image instead. Please check Migrating tf.summary usage to TF 2.0 for concrete steps for migration.

How to Map Arguments

TF1 Arg Name TF2 Arg Name Note
name name -
tensor data -
- step Explicit int64-castable monotonic step value. If omitted, this defaults to tf.summary.experimental.get_step().
max_outputs max_outputs -
collections Not Supported -
family Removed Please use tf.name_scope instead to manage summary name prefix.
- description Optional long-form str description for the summary. Markdown is supported. Defaults to empty.