Skip to content

Commit 00d9711

Browse files
Document complex dtype limitation in ops.correlate (#21984)
1 parent e819c74 commit 00d9711

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

keras/src/ops/numpy.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7802,6 +7802,15 @@ def correlate(x1, x2, mode="valid"):
78027802
78037803
Returns:
78047804
Output tensor, cross-correlation of `x1` and `x2`.
7805+
7806+
Notes:
7807+
Complex-valued inputs are currently not fully supported on the
7808+
TensorFlow and PyTorch backends. When complex tensors are passed,
7809+
they are cast to floating-point types and the imaginary component
7810+
is discarded.
7811+
7812+
This behavior is documented for clarity and may change in the
7813+
future. See discussion in issue #21617.
78057814
"""
78067815
if any_symbolic_tensors((x1, x2)):
78077816
return Correlate(mode=mode).symbolic_call(x1, x2)

0 commit comments

Comments
 (0)