tf.keras.ops.correlate

Compute the cross-correlation of two 1-dimensional tensors.

View aliases

Main aliases

tf.keras.ops.numpy.correlate

tf.keras.ops.correlate(
    x1, x2, mode='valid'
)

Args
x1	First 1-dimensional input tensor of length M.
x2	Second 1-dimensional input tensor of length N.
mode	Either valid, same or full. By default the mode is set to valid, which returns an output of length max(M, N) - min(M, N) + 1. same returns an output of length max(M, N). full mode returns the convolution at each point of overlap, with an output length of N+M-1

Returns
Output tensor, cross-correlation of x1 and x2.

Notes
Complex-valued inputs are currently not fully supported on the TensorFlow and PyTorch backends. When complex tensors are passed, they are cast to floating-point types and the imaginary component is discarded. This behavior is documented for clarity and may change in the future. See discussion in issue #21617.