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.
Args
name
A name for the generated node. Will also serve as a series name in
TensorBoard.
values
A real numeric Tensor. Any shape. Values to use to
build the histogram.
collections
Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to [GraphKeys.SUMMARIES].
family
Optional; if provided, used as the prefix of the summary tag name,
which controls the tab name used for display on Tensorboard.
Returns
A scalar Tensor of type string. The serialized Summary protocol
buffer.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-11-04 UTC."],[],[],null,["# tf.compat.v1.summary.histogram\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.7.4/tensorflow/python/summary/summary.py#L196-L261) |\n\nOutputs a `Summary` protocol buffer with a histogram. \n\n tf.compat.v1.summary.histogram(\n name, values, collections=None, family=None\n )\n\n\u003cbr /\u003e\n\nMigrate to TF2\n--------------\n\n\u003cbr /\u003e\n\n| **Caution:** This API was designed for TensorFlow v1. Continue reading for details on how to migrate from this API to a native TensorFlow v2 equivalent. See the [TensorFlow v1 to TensorFlow v2 migration guide](https://www.tensorflow.org/guide/migrate) for instructions on how to migrate the rest of your code.\n\nThis API is not compatible with eager execution and [`tf.function`](../../../../tf/function). To migrate\nto TF2, please use [`tf.summary.histogram`](../../../../tf/summary/histogram) instead. Please check\n[Migrating tf.summary usage to\nTF 2.0](https://www.tensorflow.org/tensorboard/migrate#in_tf_1x) for concrete\nsteps for migration.\n\n#### How to Map Arguments\n\n| TF1 Arg Name | TF2 Arg Name | Note |\n|---------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `name` | - |\n| `values` | `data` | - |\n| - | `step` | Explicit int64-castable monotonic step value. If omitted, this defaults to [`tf.summary.experimental.get_step()`](../../../../tf/summary/experimental/get_step) |\n| - | `buckets` | Optional positive `int` specifying the histogram bucket number. |\n| `collections` | Not Supported | - |\n| `family` | Removed | Please use [`tf.name_scope`](../../../../tf/name_scope) instead to manage summary name prefix. |\n| - | `description` | Optional long-form `str` description for the summary. Markdown is supported. Defaults to empty. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nDescription\n-----------\n\nAdding a histogram summary makes it possible to visualize your data's\ndistribution in TensorBoard. You can see a detailed explanation of the\nTensorBoard histogram dashboard\n[here](https://www.tensorflow.org/get_started/tensorboard_histograms).\n\nThe generated\n[`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)\nhas one summary value containing a histogram for `values`.\n\nThis op reports an `InvalidArgument` error if any value is not finite.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `name` | A name for the generated node. Will also serve as a series name in TensorBoard. |\n| `values` | A real numeric `Tensor`. Any shape. Values to use to build the histogram. |\n| `collections` | Optional list of graph collections keys. The new summary op is added to these collections. Defaults to `[GraphKeys.SUMMARIES]`. |\n| `family` | Optional; if provided, used as the prefix of the summary tag name, which controls the tab name used for display on Tensorboard. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A scalar `Tensor` of type `string`. The serialized `Summary` protocol buffer. ||\n\n\u003cbr /\u003e"]]
View source on GitHub