# tf.compat.v1.summary.scalar

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.7.4/tensorflow/python/summary/summary.py#L57-L111) |

Outputs a `Summary` protocol buffer containing a single scalar value.

    tf.compat.v1.summary.scalar(
        name, tensor, collections=None, family=None
    )

<br />

## Migrate to TF2

<br />

> [!CAUTION]
> **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.

This API is not compatible with eager execution or [`tf.function`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/function). To migrate
to TF2, please use [`tf.summary.scalar`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/scalar) instead. Please check
[Migrating tf.summary usage to
TF 2.0](https://www.tensorflow.org/tensorboard/migrate#in_tf_1x) for concrete
steps for migration. [`tf.summary.scalar`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/scalar) can also log training metrics in
Keras, you can check [Logging training metrics in
Keras](https://www.tensorflow.org/tensorboard/scalars_and_keras) for detials.

#### 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()`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/experimental/get_step). |
| `collections` | Not Supported | - |
| `family` | Removed | Please use [`tf.name_scope`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/name_scope) instead to manage summary name prefix. |
| - | `description` | Optional long-form `str` description for the summary. Markdown is supported. Defaults to empty. |

<br />

<br />

## Description

The generated Summary has a Tensor.proto containing the input Tensor.

<br />

<br />

<br />

| ## 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. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A scalar `Tensor` of type `string`. Which contains a `Summary` protobuf. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If tensor has the wrong shape or type. |

<br />