# StringNGrams

public final class **StringNGrams** Creates ngrams from ragged string data.


This op accepts a ragged tensor with 1 ragged dimension containing only
strings and outputs a ragged tensor with 1 ragged dimension containing ngrams
of that string, joined along the innermost axis.

<br />

### Public Methods

|---|---|
| static \<T extends Number\> [StringNGrams](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/StringNGrams)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/StringNGrams#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<java.lang.String>,%20org.tensorflow.Operand<T>,%20java.lang.String,%20java.util.List<java.lang.Long>,%20java.lang.String,%20java.lang.String,%20java.lang.Long,%20java.lang.Boolean))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<String\> data, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> dataSplits, String separator, List\<Long\> ngramWidths, String leftPad, String rightPad, Long padWidth, Boolean preserveShortSequences) Factory method to create a class wrapping a new StringNGrams operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\> | [ngrams](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/StringNGrams#ngrams())() The values tensor of the output ngrams ragged tensor. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [ngramsSplits](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/StringNGrams#ngramsSplits())() The splits tensor of the output ngrams ragged tensor. |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [StringNGrams](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/StringNGrams)\<T\>
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<String\> data, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> dataSplits, String separator, List\<Long\> ngramWidths, String leftPad, String rightPad, Long padWidth, Boolean preserveShortSequences)

Factory method to create a class wrapping a new StringNGrams operation.

##### Parameters

| scope | current scope |
| data | The values tensor of the ragged string tensor to make ngrams out of. Must be a 1D string tensor. |
| dataSplits | The splits tensor of the ragged string tensor to make ngrams out of. |
| separator | The string to append between elements of the token. Use "" for no separator. |
| ngramWidths | The sizes of the ngrams to create. |
| leftPad | The string to use to pad the left side of the ngram sequence. Only used if pad_width != 0. |
| rightPad | The string to use to pad the right side of the ngram sequence. Only used if pad_width != 0. |
| padWidth | The number of padding elements to add to each side of each sequence. Note that padding will never be greater than 'ngram_widths'-1 regardless of this value. If \`pad_width=-1\`, then add \`max(ngram_widths)-1\` elements. |
|---|---|

##### Returns

- a new instance of StringNGrams

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\>
**ngrams**
()

The values tensor of the output ngrams ragged tensor.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**ngramsSplits**
()

The splits tensor of the output ngrams ragged tensor.