# tf.strings.format

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/strings/format) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/ops/string_ops.py#L115-L175) |

Formats a string template using a list of tensors.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.strings.format`](https://www.tensorflow.org/api_docs/python/tf/strings/format)

<br />

    tf.strings.format(
        template, inputs, placeholder='{}', summarize=3, name=None
    )

Formats a string template using a list of tensors, abbreviating tensors by
only printing the first and last `summarize` elements of each dimension
(recursively). If formatting only one tensor into a template, the tensor does
not have to be wrapped in a list.

#### Example:

Formatting a single-tensor template:

    tensor = tf.range(5)
    tf.strings.format("tensor: {}, suffix", tensor)
    <tf.Tensor: shape=(), dtype=string, numpy=b'tensor: [0 1 2 3 4], suffix'>

Formatting a multi-tensor template:

    tensor_a = tf.range(2)
    tensor_b = tf.range(1, 4, 2)
    tf.strings.format("a: {}, b: {}, suffix", (tensor_a, tensor_b))
    <tf.Tensor: shape=(), dtype=string, numpy=b'a: [0 1], b: [1 3], suffix'>

<br />

<br />

<br />

| ## Args ||
|---|---|
| `template` | A string template to format tensor values into. |
| `inputs` | A list of `Tensor` objects, or a single Tensor. The list of tensors to format into the template string. If a solitary tensor is passed in, the input tensor will automatically be wrapped as a list. |
| `placeholder` | An optional `string`. Defaults to `{}`. At each placeholder occurring in the template, a subsequent tensor will be inserted. |
| `summarize` | An optional `int`. Defaults to `3`. When formatting the tensors, show the first and last `summarize` entries of each tensor dimension (recursively). If set to -1, all elements of the tensor will be shown. |
| `name` | A name for the operation (optional). |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A scalar `Tensor` of type `string`. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if the number of placeholders does not match the number of inputs. |

<br />