tf.summary.scalar
Stay organized with collections
Save and categorize content based on your preferences.
Outputs a Summary
protocol buffer containing a single scalar value.
tf.summary.scalar(
name, tensor, collections=None, family=None
)
The generated Summary has a Tensor.proto containing the input Tensor.
Args |
name
|
A name for the generated node. Will also serve as the series name in
TensorBoard.
|
tensor
|
A real numeric Tensor containing a single value.
|
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 . Which contains a Summary protobuf.
|
Raises |
ValueError
|
If tensor has the wrong shape or type.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.summary.scalar\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| [TensorFlow 2 version](/api_docs/python/tf/summary/scalar) | [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/summary.py#L57-L84) |\n\nOutputs a `Summary` protocol buffer containing a single scalar value.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.summary.scalar`](/api_docs/python/tf/compat/v1/summary/scalar)\n\n\u003cbr /\u003e\n\n tf.summary.scalar(\n name, tensor, collections=None, family=None\n )\n\nThe generated Summary has a Tensor.proto containing the input Tensor.\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 the series name in TensorBoard. |\n| `tensor` | A real numeric Tensor containing a single value. |\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`. Which contains a `Summary` protobuf. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|----------------------------------------|\n| `ValueError` | If tensor has the wrong shape or type. |\n\n\u003cbr /\u003e"]]