# tf.compat.v1.summary.text

<br />

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

Summarizes textual data.

    tf.compat.v1.summary.text(
        name, tensor, collections=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.

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`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/summary/SummaryWriter#as_default), `tf.summary.experimental.set_step` or
alternatively [`tf.compat.v1.train.create_global_step`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/compat/v1/train/create_global_step)). For the forwarded
call, the arguments here will be passed to the TF2 implementation of
[`tf.summary.text`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/summary/text), 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.text`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/summary/text) 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.

#### 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()`. |
| `collections` | Not Supported | - |
| - | `description` | Optional long-form `str` description for the summary. Markdown is supported. Defaults to empty. |

<br />

<br />

## Description

Text data summarized via this plugin will be visible in the Text Dashboard
in TensorBoard. The standard TensorBoard Text Dashboard will render markdown
in the strings, and will automatically organize 1d and 2d tensors into tables.
If a tensor with more than 2 dimensions is provided, a 2d subarray will be
displayed along with a warning message. (Note that this behavior is not
intrinsic to the text summary api, but rather to the default TensorBoard text
plugin.)

<br />

<br />

<br />

| ## Args ||
|---|---|
| `name` | A name for the generated node. Will also serve as a series name in TensorBoard. |
| `tensor` | a string-type Tensor to summarize. |
| `collections` | Optional list of ops.GraphKeys. The collections to add the summary to. Defaults to \[_ops.GraphKeys.SUMMARIES\] |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A TensorSummary op that is configured so that TensorBoard will recognize that it contains textual data. The TensorSummary is a scalar `Tensor` of type `string` which contains `Summary` protobufs. ||

<br />

<br />

<br />

<br />

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

<br />