 View source on |
Outputs a Summary protocol buffer with a histogram.
tf.compat.v1.summary.histogram(
name, values, 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.histogram, 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.
To migrate to TF2, please use tf.summary.histogram 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 | - |
values | data | - |
| - | step | Explicit int64-castable monotonic step value. If omitted, this defaults to tf.summary.experimental.get_step() |
| - | buckets | Optional positive int specifying the histogram bucket number. |
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. |
Description
Adding a histogram summary makes it possible to visualize your data's distribution in TensorBoard. You can see a detailed explanation of the TensorBoard histogram dasard here.
The generated Summary has one summary value containing a histogram for values.
This op reports an InvalidArgument error if any value is not finite.
Returns | |
|---|---|
A scalar Tensor of type string. The serialized Summary protocol buffer. |