StringSplit

StringSplit - 20

Version

• name: StringSplit (GitHub)

• domain: main

• since_version: 20

• function: False

• support_level: SupportType.COMMON

• shape inference: True

This version of the operator has been available since version 20.

Summary

StringSplit splits a string tensor’s elements into substrings based on a delimiter attribute and a maxsplit attribute.

The first output of this operator is a tensor of strings representing the substrings from splitting each input string on the delimiter substring. This tensor has one additional rank compared to the input tensor in order to store the substrings for each input element (where the input tensor is not empty). Note that, in order to ensure the same number of elements are present in the final dimension, this tensor will pad empty strings as illustrated in the examples below. Consecutive delimiters are not grouped together and are deemed to delimit empty strings, except if the delimiter is unspecified or is the empty string (“”). In the case where the delimiter is unspecified or the empty string, consecutive whitespace characters are regarded as a single separator and leading or trailing whitespace is removed in the output.

The second output tensor represents the number of substrings generated. maxsplit can be used to limit the number of splits performed - after the maxsplitth split if the string is not fully split, the trailing suffix of input string after the final split point is also added. For elements where fewer splits are possible than specified in maxsplit, it has no effect.

Attributes

• delimiter - STRING :

  Delimiter to split on. If left unset or set to the empty string (“”), the input is split on consecutive whitespace.

• maxsplit - INT :

  Maximum number of splits (from left to right). If left unset (or if the number of possible splits are less than maxsplit), it will make as many splits as possible. Note that the maximum possible number of substrings returned with maxsplit specified is maxsplit+1 since the remaining suffix after the maxsplitth split is included in the output.

Inputs

• X (heterogeneous) - T1:

  Tensor of strings to split.

Outputs

• Y (heterogeneous) - T2:

  Tensor of substrings representing the outcome of splitting the strings in the input on the delimiter. Note that to ensure the same number of elements are present in the final rank, this tensor will pad any necessary empty strings.

• Z (heterogeneous) - T3:

  The number of substrings generated for each input element.

Type Constraints

• T1 in ( tensor(string) ):

  The input must be a UTF-8 string tensor

• T2 in ( tensor(string) ):

  Tensor of substrings.

• T3 in ( tensor(int64) ):

  The number of substrings generated.