tf.strings.format  |  TensorFlow v2.16.1 (original) (raw)

tf.strings.format

Stay organized with collections Save and categorize content based on your preferences.

Formats a string template using a list of tensors.

View aliases

Compat aliases for migration

SeeMigration guide for more details.

tf.compat.v1.strings.format

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'>
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 summarizeentries of each tensor dimension (recursively). If set to -1, all elements of the tensor will be shown.
name A name for the operation (optional).
Returns
A scalar Tensor of type string.
Raises
ValueError if the number of placeholders does not match the number of inputs.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates. Some content is licensed under the numpy license.

Last updated 2024-04-26 UTC.