View source on GitHub
|
Summarizes textual data.
tf.compat.v1.summary.text(
name, tensor, collections=None
)
Migrate to TF2
This API is not compatible with eager execution or tf.function. To migrate
to TF2, please use tf.summary.text instead. Please check
Migrating tf.summary usage to
TF 2.0 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. |
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.)
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.
|
Raises | |
|---|---|
ValueError
|
If tensor has the wrong type. |