Skip to content

Document complex dtype limitation in ops.correlate #21984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hertschuh merged 1 commit into from
Jan 14, 2026
Merged

Document complex dtype limitation in ops.correlate #21984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions keras/src/ops/numpy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7734,6 +7734,15 @@ def correlate(x1, x2, mode="valid"):

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.
Copy link
Collaborator

@hertschuh hertschuh Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make it a link, it won't turn it to a link automatically:

[#21617](https://github.com/keras-team/keras/issues/21617)

Copy link
Contributor Author

@PES2UG23CS205 PES2UG23CS205 Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve updated the inline documentation to link the discussion: #21617

"""
if any_symbolic_tensors((x1, x2)):
return Correlate(mode=mode).symbolic_call(x1, x2)
Expand Down