# tf.summary.text

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/summary/text) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorboard/tree/master/tensorboard/plugins/text/summary_v2.py) |

Write a text summary.

    tf.summary.text(
        name, data, step=None, description=None
    )

<br />

<br />

<br />

| ## Arguments ||
|---|---|
| `name` | A name for this summary. The summary tag used for TensorBoard will be this name prefixed by any active name scopes. |
| `data` | A UTF-8 string tensor value. |
| `step` | Explicit `int64`-castable monotonic step value for this summary. If omitted, this defaults to [`tf.summary.experimental.get_step()`](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/summary/experimental/get_step), which must not be None. |
| `description` | Optional long-form description for this summary, as a constant `str`. Markdown is supported. Defaults to empty. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| True on success, or false if no summary was emitted because no default summary writer was available. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if a default writer exists, but no step was provided and [`tf.summary.experimental.get_step()`](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/summary/experimental/get_step) is None. |

<br />