tf.sequence_mask
Stay organized with collections
Save and categorize content based on your preferences.
Returns a mask tensor representing the first N positions of each cell.
tf.sequence_mask(
lengths,
maxlen=None,
dtype=tf.dtypes.bool,
name=None
)
Used in the notebooks
If lengths has shape [d_1, d_2, ..., d_n] the resulting tensor mask has
dtype dtype and shape [d_1, d_2, ..., d_n, maxlen], with
mask[i_1, i_2, ..., i_n, j] = (j < lengths[i_1, i_2, ..., i_n])
Examples:
tf.sequence_mask([1, 3, 2], 5) # [[True, False, False, False, False],
# [True, True, True, False, False],
# [True, True, False, False, False]]
tf.sequence_mask([[1, 3],[2,0]]) # [[[True, False, False],
# [True, True, True]],
# [[True, True, False],
# [False, False, False]]]
Args |
|---|
lengths
|
integer tensor, all its values <= maxlen.
|
maxlen
|
scalar integer tensor, size of last dimension of returned tensor.
Default is the maximum value in lengths.
|
dtype
|
output type of the resulting tensor.
|
name
|
name of the op.
|
Returns |
|---|
A mask tensor of shape lengths.shape + (maxlen,), cast to specified dtype.
|
Raises |
|---|
ValueError
|
if maxlen is not a scalar.
|
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-04-26 UTC."],[],[],null,["# tf.sequence_mask\n\n\u003cbr /\u003e\n\n|-------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/ops/array_ops.py#L4132-L4196) |\n\nReturns a mask tensor representing the first N positions of each cell.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.sequence_mask`](https://www.tensorflow.org/api_docs/python/tf/sequence_mask)\n\n\u003cbr /\u003e\n\n tf.sequence_mask(\n lengths,\n maxlen=None,\n dtype=../tf/dtypes#bool,\n name=None\n )\n\n### Used in the notebooks\n\n| Used in the tutorials |\n|----------------------------------------------------------------------------------------------------------------------|\n| - [TFP Release Notes notebook (0.13.0)](https://www.tensorflow.org/probability/examples/TFP_Release_Notebook_0_13_0) |\n\nIf `lengths` has shape `[d_1, d_2, ..., d_n]` the resulting tensor `mask` has\ndtype `dtype` and shape `[d_1, d_2, ..., d_n, maxlen]`, with \n\n mask[i_1, i_2, ..., i_n, j] = (j \u003c lengths[i_1, i_2, ..., i_n])\n\n#### Examples:\n\n tf.sequence_mask([1, 3, 2], 5) # [[True, False, False, False, False],\n # [True, True, True, False, False],\n # [True, True, False, False, False]]\n\n tf.sequence_mask([[1, 3],[2,0]]) # [[[True, False, False],\n # [True, True, True]],\n # [[True, True, False],\n # [False, False, False]]]\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-----------|--------------------------------------------------------------------------------------------------------------|\n| `lengths` | integer tensor, all its values \\\u003c= maxlen. |\n| `maxlen` | scalar integer tensor, size of last dimension of returned tensor. Default is the maximum value in `lengths`. |\n| `dtype` | output type of the resulting tensor. |\n| `name` | name of the op. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A mask tensor of shape `lengths.shape + (maxlen,)`, cast to specified dtype. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|------------------------------|\n| `ValueError` | if `maxlen` is not a scalar. |\n\n\u003cbr /\u003e"]]
View source on GitHub