View source on GitHub |
Outputs a Summary
protocol buffer with a histogram.
tf.compat.v1.summary.histogram(
name, values, collections=None, family=None
)
Migrate to TF2
This API is not compatible with eager execution and tf.function
. 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 dashboard 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.
|