`returnn.frontend.array_`¶

Array (Tensor) functions

Parameters:

value – tensor, or scalar raw tensor or some other scalar value
dims
dtype
sparse_dim
feature_dim
shape – alias for dims, for some older code
name
device
keep_scalar_on_cpu – if the value is already on the CPU, keep it there, even if device is sth else
_backend

Returns:

tensor

Parameters:

value – tensor, or scalar raw tensor or some other scalar value
dims
dtype
sparse_dim
feature_dim
shape – alias for dims, for some older code
name
device
keep_scalar_on_cpu – if the value is already on the CPU, keep it there, even if device is sth else
_backend

Returns:

tensor

returnn.frontend.array_.copy(tensor: Tensor) → Tensor[source]¶

Parameters:: tensor
Returns:: copy of tensor. In eager-based frameworks, it is really a copy. In graph-based frameworks, it might be just a copied reference if it would be immutable. This is really only relevant when operating on tensors which can conceptually be mutated, such as variables (Parameter).

returnn.frontend.array_.cast(tensor: Tensor, dtype: str) → Tensor[source]¶

Parameters:

tensor
dtype

Returns:

tensor with the same data, but with a different dtype

returnn.frontend.array_.merge_dims(source: Tensor, *, dims: Sequence[Dim], out_dim: Dim | None = None) → Tuple[Tensor, Dim][source]¶

Merges a list of axes into a single one. (Flatten the dims.) E.g. input is (batch, width, height, dim) and dims=(width,height), then we get (batch, width*height, dim). Or input is (batch, time, height, dim) and axes=(height,dim), then we get (batch, time, height*dim).

rf.split_dims() is the reverse operation.

Parameters:

source
dims
out_dim

Returns:

tensor, out_dim

returnn.frontend.array_.split_dims(source: Tensor, *, axis: Dim, dims: Sequence[Dim], pad_to_multiples: bool | None = None, pad_value: float | int | None = None) → Tensor[source]¶

Splits one axis into multiple axes. E.g. if you know that your feature-dim is composed by a window, i.e. the input is (batch, time, window * feature), you can set axis=”F”, dims=(window, -1), and you will get the output (batch, time, window, feature).

If the split axis has a dynamic length, exactly one of the axes that we split into need to also have a dynamic length. You can e.g. use this to split the input dimension into smaller “chunks” of a fixed window size. E.g. you could have input (batch, time, feature) and set axis=”T”, dims=(-1, window), to get output (batch, split_time, window, feature). In this case, the exact sequence lengths are lost and everything is padded to multiples of the window size using the given padding value. Use ReinterpretDataLayer to receive back the original sequence lengths after merging.

Also see rf.merge_dims() which can undo this operation.

Parameters:

source
axis – e.g. “F”
dims – what the axis should be split into. e.g. (window, -1)
pad_to_multiples – If true, input will be padded to the next multiple of the product of the static dims, such that splitting is actually possible. By default this is done iff the axis has a dynamic size
pad_value – What pad value to use for pad_to_multiples

Returns:

source with axis replaced by dims

returnn.frontend.array_.reshape(source: Tensor, in_dims: Sequence[Dim], out_dims: Sequence[Dim]) → Tensor[source]¶

Wraps tf.reshape.

You should use split_dims() or merge_dims() when you want to split or merge dimensions. This here is for doing any other kind of reshape. This can be used for clever indexing, slicing, padding tricks.

Parameters:

source – e.g. (…, old_dims, …)
in_dims – the old dims which should be reshaped into new_dims. This should only cover those dims which should be reshaped, not all the dims of the source.
out_dims – the new dims which should be reshaped from old_dims. This is excluding any of the other dims in the source.

Returns:

e.g. (…, new_dims, …)

returnn.frontend.array_.split(source: Tensor, *, axis: Dim, out_dims: Sequence[Dim]) → Tuple[Tensor, ...][source]¶

Split the input on the specified axis (by default feature). Basically a wrapper around tf.split.

Parameters:

source – {…, axis}
axis – some static axis
out_dims – list of dims where sum(out_dims) == axis

Returns:

tuple of tensors, same amount as out_dims, with the same shape as source, but with the specified axis replaced by the out_dims

returnn.frontend.array_.expand_dim(source: Tensor, dim: Dim) → Tensor[source]¶

Expand the source by the given dimension.

Note that this is never needed for broadcasting. All broadcasting should always happen automatically.

This might be needed for convolution or concatenation.

returnn.frontend.array_.expand_dims(source: Tensor, dims: Sequence[Dim]) → Tensor[source]¶: Expand multiple dims, via expand_dim().

returnn.frontend.array_.squeeze(source: Tensor, axis: Dim) → Tensor[source]¶: Removes the axis with dimension of extend 1 from the source.

Follows the same idea as RETURNN tf_util.windowed, using clever padding and reshaping.

Parameters:

source
spatial_dim
window_dim
window_left
window_right
padding – “same” or “valid”
pad_value
stride
use_mask – whether we should mask to make sure the zero padding is correct

Returns:

out, out_spatial_dim

returnn.frontend.array_.concat(*sources: Tuple[Tensor, Dim], allow_broadcast: bool = False, out_dim: Dim | None = None, handle_dynamic_dims: bool | None = None) → Tuple[Tensor, Dim][source]¶

Concatenates multiple sources in the specified dimension.

Also see stack().

Parameters:

sources – list of (tensor, dim) pairs. dim is the axis to concatenate on.
allow_broadcast – if True, the sources can have different dims, and the result will be broadcasted.
out_dim – reuse existing dim for the resulting concatenated dim, if given
handle_dynamic_dims

Returns:

concatenated tensor, out_dim

returnn.frontend.array_.concat_features(*sources: Tensor, allow_broadcast=False) → Tensor[source]¶: Concatenates multiple sources, using feature_dim of each source, so make sure that the feature_dim is correctly set.

Pad values left/right in the specified axes.

Parameters:

source
axes – which axes to add padding to
padding – list of (left, right) padding for each axis
out_dims – (optional) predefined out dims for each padded dim in axes. will automatically create if not given
mode – ‘constant’, ‘reflect’, ‘replicate’ or ‘circular’
value – (optional) value to pad with in “constant” mode
handle_dynamic_dims – True: when doing right padding on a dynamic dim, value will be added after the seq end, not at the end of the dimension. False: value will be added at the end of the dimension. By default, in behavior version >=21, this is True, in older versions, this is False.

Returns:

padded tensor, out_dims. out dims are for each dim in axes

returnn.frontend.array_.cum_concat_step(source: Tensor, *, prev_accum: Tensor, axis: Dim, out_spatial_dim: Dim | None = None) → Tuple[Tensor, Dim][source]¶

Concatenates all previous frames over a time-axis. See RETURNN CumConcatLayer for details.

Parameters:

source – same dims as prev_accum except for the accum axis
prev_accum – previous accumulated tensor, shape {…, axis}
axis – the axis to accumulate over
out_spatial_dim – if given, the spatial dim of the output will be this dim. axis+1.

Returns:

(accumulated, out_spatial_dim). accumulated shape {…, out_spatial_dim}, same shape as prev_accum with axis replaced by out_spatial_dim.

returnn.frontend.array_.stack(sources: Sequence[Tensor], *, out_dim: Dim | None = None) → Tuple[Tensor, Dim][source]¶

Stack the sources in a new dimension. All sources must have the same shape.

Parameters:

sources
out_dim – if given, use this as the new dim

Returns:

stacked tensor, out_dim

returnn.frontend.array_.masked_select(tensor: Tensor, *, mask: Tensor, dims: Sequence[Dim], out_dim: Dim | None = None) → Tuple[Tensor, Dim][source]¶

This will pack the tensor based on the mask. In TF, this is boolean_mask. The inverse of this is masked_scatter().

Related: pack_padded(), which uses sequence_mask() as the mask.

Parameters:

tensor
mask
dims – The same or a subset of the dims of mask. The order of the dims defines the packed format (in out_dim). If only a single dim is given, only this dim is packed, while all other dims are kept as is.
out_dim – packed dims into this dim. Automatically created if not given, and then returned.

Returns:

Tensor where all dims are removed and replaced by a new dim (out_dim). The new dim (out_dim) is also returned. If mask==True for all elements, the returned tensor would be simply the flattened input tensor.

returnn.frontend.array_.masked_scatter(source: Tensor, backup: Tensor | None = None, *, mask: Tensor, dims: Sequence[Dim], in_dim: Dim) → Tensor[source]¶

The inverse of masked_select().

Parameters:

source – [in_dim, F…]
backup – [dims…, F…] (or subset of those dims). zero if not given.
mask – [dims…] -> bool (e.g. [B,T])
dims – the order of the dims defines the format. those dims should be exactly the dims of the mask.
in_dim – the dim of the source which should be scattered into the mask.

Returns:

[dims…, F…]

returnn.frontend.array_.sequence_mask(dims: Dim | Sequence[Dim], *, device: str | None = None) → Tensor[source]¶

Parameters:

dims
device

Returns:

mask based on the sequence lengths

returnn.frontend.array_.pack_padded(source: Tensor, *, dims: Sequence[Dim], enforce_sorted: bool = False, out_dim: Dim | None = None) → Tuple[Tensor, Dim][source]¶

Like pack_padded_sequence. Usually the sequences are padded when they have different lengths. Packing means to only store the non-padded frames. This uses masked_select() internally based on the mask of non-masked frames.

See pad_packed() for the inverse operation.

Parameters:

source
dims – dims in source to pack. the order defines the format. first dim is major, etc. if there are no padded frames, e.g. dims=[B,T] would just result in the [B*T,…] reshaped tensor.
enforce_sorted – seqs in the dims are reordered (stable sort) such that longest seqs come first.
out_dim

Returns:

packed tensor, new packed dim

returnn.frontend.array_.pad_packed(source: Tensor, *, in_dim: Dim, dims: Sequence[Dim]) → Tensor[source]¶: Inverse of pack_padded(), i.e. unpack the sequence, i.e. pad it back to the original length.

returnn.frontend.array_.gather(source: Tensor, *, indices: Tensor | int, axis: Dim | None = None, clip_to_valid: bool = False) → Tensor[source]¶

Gathers slices on a specified axis from the source using indices. If the source is of the shape [B,D,F1], and indices of shape [B,F2], this will yield output of the shape [B,F2,F1] where

output[b,f2,f1] = source[b,indices[b,f2],f1]

(if D is the axis to gather from). In general, all shared axes of the input and the positions will be considered as batch-axes.

The indices argument can also be an int. In this case, this simply gives source[indices] on the specified axis.

scatter() is the inverse.

Parameters:

source – [batch_dims…, axis, feature_dims…]
indices – [batch_dims…, indices_dims…] indices used to select the slices of the source from. If another tensor, must be of type int32 or int64. Can also specify a constant int. Batch dims are automatically determined as the common dims of source and indices.
axis – The axis into which we gather the indices into. If not given, indices must be a tensor and the sparse_dim will be used.
clip_to_valid – if True, the indices will be clipped to the valid range of the input Also taking seq lengths into account.

Returns:

[batch_dims…, indices_dims…, feature_dims…] gathered values

Scatters into new zero-tensor. If entries in indices are duplicated, with mode=="sum", the corresponding values in source will be added together (scatter_add in PyTorch), or otherwise it will take the respective reduction.

scatter is the inverse of gather().

(segment_sum can be implemented via this.)

Parameters:

source – [batch_dims…, indices_dim(s)…, feature_dims…]
indices – [batch_dims…, indices_dim(s)…] -> out_dim
indices_dim
mode – “sum”, “max”, “min”, “logsumexp”, “logmeanexp”, “argmax”. (Note: If you ever need mean, argmin, etc, please open an issue/PR.)
fill_value
out_dim – The indices target dim. If not given, will be automatically determined as the sparse_dim from indices. If multiple out dims, use indices into the merged out dims, and then we use rf.split_dims() afterwards.
use_mask

Returns:

[batch_dims…, out_dim(s)…, feature_dims…]

returnn.frontend.array_.scatter_argmax(source: Tensor, *, indices: Tensor, indices_dim: Dim | Sequence[Dim], invalid_idx: int = -1, out_dim: Dim | Sequence[Dim] | None = None) → Tensor[source]¶

Get the index in src which has the max value for each index in index.

This is like scatter() with mode="argmax".

Parameters:

source – [batch_dims…, indices_dim(s)…, feature_dims…]
indices – [batch_dims…, indices_dim(s)…] -> out_dim
indices_dim
invalid_idx – in case some of the output entries are never set (via indices), this will be used as the value.
out_dim – The indices target dim.

Returns:

[batch_dims…, out_dim(s)…, feature_dims…]

Scatters into new zero-tensor. If entries in indices are duplicated, the corresponding values in source will be log-sum-exp’ed together. This is like scatter() with mode="logsumexp".

Parameters:

source – [batch_dims…, indices_dim(s)…, feature_dims…]
indices – [batch_dims…, indices_dim(s)…] -> out_dim
indices_dim
fill_value
out_dim – The indices target dim. If not given, will be automatically determined as the sparse_dim from indices. If multiple out dims, use indices into the merged out dims, and then we use rf.split_dims() afterwards.

Returns:

[batch_dims…, out_dim(s)…, feature_dims…]

Scatters into new zero-tensor. If entries in indices are duplicated, the corresponding values in source will be log-mean-exp’ed together. This is like scatter() with mode="logmeanexp".

Parameters:

source – [batch_dims…, indices_dim(s)…, feature_dims…]
indices – [batch_dims…, indices_dim(s)…] -> out_dim
indices_dim
fill_value
out_dim – The indices target dim. If not given, will be automatically determined as the sparse_dim from indices. If multiple out dims, use indices into the merged out dims, and then we use rf.split_dims() afterwards.

Returns:

[batch_dims…, out_dim(s)…, feature_dims…]

Slicing on the input, i.e. x[start:end:step] in some axis.

If size is given, it takes out a slice-range like x[start:start + size].

This function allows a non-scalar start points.

Parameters:

source
axis
start
end
step – we only support a positive step here. If you want to flip the sequence, use reverse_sequence(), maybe with handle_dynamic_dims=False.
size
out_dim

Returns:

tensor, out_dim

returnn.frontend.array_.shift_right(source: Tensor, *, axis: Dim, pad_value: int | float | complex | number | ndarray | bool | str | Tensor, amount: int = 1) → Tensor[source]¶: shift right by amount, pad left with left_pad

returnn.frontend.array_.shift_left(source: Tensor, *, axis: Dim, pad_value: int | float | complex | number | ndarray | bool | str | Tensor, amount: int = 1) → Tensor[source]¶: shift left by amount, pad right with right_pad

returnn.frontend.array_.reverse_sequence(tensor: Tensor, *, axis: Dim, handle_dynamic_dims: bool = True) → Tensor[source]¶

Similar as tf.reverse_sequence, or Torch flip (but taking seq lengths into account).

Parameters:

tensor
axis
handle_dynamic_dims – if True, the dynamic dims will be handled correctly, i.e. a padded seq “a b c <pad>” will be reversed to “c b a <pad>”. If False, the dynamic dims will be handled as if they are static, i.e. a padded seq “a b c <pad>” will be reversed to “<pad> c b a”.

Returns:

reversed tensor, same dims

Wraps tf.where, which is SwitchLayer in RETURNN.

Returns:: true_ if cond else false_, elemwise.

returnn.frontend.array_.sort(source: Tensor, *, axis: Dim, descending: bool = False, stable: bool = True) → Tuple[Tensor, Tensor, Dim][source]¶

Sorts the source tensor along the given axis.

See also top_k(). top_k() with k=axis.get_size_tensor() is equivalent to this function.

Parameters:

source – {other_dims…, axis}
axis – The axis to sort along.
descending – If True, sort in descending order, otherwise in ascending order.
stable – If True, use a stable sorting algorithm (not reordering equal elements). Note that many frameworks (Torch, TensorFlow) have stable=False by default. stable=False can be faster.

Returns:

sorted tensor, indices tensor, out_dim. both tensors have the shape {other_dims…, out_dim}, i.e. axis replaced by out_dim. indices tensor has sparse_dim set to axis.

returnn.frontend.array_.search_sorted(sorted_seq: Tensor, values: Tensor, *, axis: Dim, side: str = 'left', out_dtype: str = 'int32') → Tensor[source]¶

Parameters:

sorted_seq – [SharedDims…,axis], sequence of numbers, sorted low to high in the given axis.
values – [SharedDims…,OtherDims…], sequence of numbers to search for in sorted_seq.
axis
side – “left” or “right”
out_dtype

Returns:

[SharedDims…,OtherDims…] -> axis, indices in axis in sorted_seq such that sorted_seq[i-1] < value <= sorted_seq[i] if side==”left”, sorted_seq[i-1] <= value < sorted_seq[i] if side==”right”.

Converts a sparse tensor to a dense one.

This is a more generic variant of “one_hot”.

Note that usually this is not needed as most other functions should handle sparse tensors just fine and much more efficiently than they would be with dense tensors.

returnn.frontend.array_.one_hot(source: Tensor) → Tensor[source]¶

one_hot. special case of sparse_to_dense().

Note that usually this is not needed as most other functions should handle sparse tensors just fine and much more efficiently than they would be with dense tensors.

returnn.frontend.array_.top_k_mask(values: Tensor, *, axis: Dim, k: int | Tensor) → Tensor[source]¶

Top-k filtering.

Parameters:

values – {other_dims…, axis}
axis
k – the number of top values to keep

Returns:

mask {other_dims…, axis} of the top-k values

returnn.frontend.array_.top_p_mask(probs: Tensor, *, axis: Dim, p: float | Tensor, one_more: bool = True) → Tensor[source]¶

Top-p filtering, e.g. as used in Nucleus sampling (https://arxiv.org/abs/1904.09751).

Parameters:

probs – {probs_dims…, axis}
axis
p – the probability mass to keep
one_more – if True (default), keep also the first token above the threshold. (It’s enabled by default to follow the behavior of the original implementation.)

Returns:

mask {probs_dims…, axis} of the top-p tokens. sum(probs[mask]) <= p, or slightly more if one_more is True.

returnn.frontend.array_¶

`returnn.frontend.array_`¶