Add FFT extension to the spec by steff456 · Pull Request #189 · data-apis/array-api

steff456 · 2021-06-04T05:57:17Z

This PR focuses on adding the FFT as an extension to the array spec.

The current APIs added in this PR are:

Standard FFT: fft, ifft, fftn, ifftn
Real FFT: rfft, irfft, rfftn, irfftn
Hermitian FFT: hfft, ihfft
Helper Routines: fftfreq, rfftfreq, fftshift, ifftshift
Update to rst and create function stubs

They follow the summary available at #159. Close#476.

rgommers

Thanks @steff456, this looks good overall, just some small comments.

leofang

Great work @steff456! Thanks for putting these together. Based on the recent discussion summarized in #159 (comment), could you remove all *fft2 APIs? Thanks.

leofang

Sorry for my late response @steff456...I just reviewed {i}fft and {i}fftn and left some comments. We should reorder the list so that each pair of transforms appears together (see my comment below). I'll try to resume tomorrow...😅

steff456 · 2021-07-19T14:58:41Z

@leofang I already made the changes, please let me know if there's something else we can improve here :)

leofang

Thank you, @steff456! I have reviewed fft/ifft/fftn/ifftn/rfft/irfft/rfftn/irfftn. I think C2C transforms (fft/ifft/fftn/ifftn) are in good shape now, but more work is needed for R2C/C2R transforms as the behavior is a bit messy and confusing. I hope we could find another pair of eyes to go over these.

I will try to finish the rest of reviews (hfft, fftfreq, etc) asap...

kgryte · 2022-08-22T17:00:49Z

@steff456 The table looks correct. Thanks for putting that together.

leofang

Sorry for delay. I reviewed all functions but rfftn and irfftn, as there are still errors to be ironed out in the R2C/C2R(-like) transforms. I also have a few proposals to simplify the standard, see my comments below.

Note that the input/output data types should be taken care, as noted in previous rounds of review, including:

input data type promotion when applicable (pending #478)
reject inconsistent input data types in R2C/C2R transforms

leofang · 2022-09-11T03:52:34Z

Another note: As discussed in a prior meeting it is preferable to add a note that the output dtype will be consistent with the input dtype (ex: we don't always promote to complex128 as NumPy currently does even if the input is in single precision), but I think if we word it correctly when addressing #478 this need should be automatically resolved.

leofang · 2022-10-05T17:48:39Z

Hi @steff456 Do you have local changes that you have not pushed? If not, may I edit in your branch directly?

steff456 · 2022-10-05T17:49:39Z

Hi @leofang, go ahead and make changes! Thanks a lot 😬

leofang · 2022-10-15T20:36:20Z

@kgryte @rgommers @peterbell10 @toslunar @steff456 @oleksandr-pavlyk This should be ready now. Any chance any of you can take a look? Otherwise, I'll self-merge before the next Array API meeting (Oct 20).

rgommers · 2022-10-16T09:26:44Z

Thanks @leofang! I had a quick browse, it looks like it is in good shape. I'll defer to @kgryte for a last in-depth look if he wants to.

steff456

This looks good to me! Thanks a lot for helping me with this PR @leofang and @kgryte 🎉

leofang · 2022-10-20T17:08:46Z

Announced in the meeting, let's merge. We can follow up with additional PRs if needed.

All addressed.

PR-URL: #720Closes: #717Closes: #718 Ref: #189 Co-authored-by: Leo Fang <leo80042@gmail.com> Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Leo Fang <leo80042@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Ralf Gommers <ralf.gommers@gmail.com>

Add all fft functions
2f2f290

steff456 self-assigned this Jun 4, 2021

rgommers added the API extension Adds new functions or objects to the API. label Jun 7, 2021

rgommers reviewed Jun 7, 2021
View reviewed changes

Comment threadspec/extensions/index.rst Outdated
Comment threadspec/extensions/fast_fourier_transform_functions.md Outdated
Comment threadspec/extensions/fast_fourier_transform_functions.md Outdated
Comment threadspec/extensions/fast_fourier_transform_functions.md Outdated

add consistency among the definitions and add some minor fixes
287e686

steff456 marked this pull request as ready for review June 8, 2021 19:22

steff456 requested a review from kgryte June 8, 2021 19:42

rgommers mentioned this pull request Jun 15, 2021
Related topic: NumPy array protocols #1
Closed

leofang requested changes Jun 24, 2021
View reviewed changes

steff456and others added 13 commits June 24, 2021 14:36

Remove *fft2 functions
07d0654

Fix config.yml
3a367b7

Add .circleci/config.yml
5265b6f

As example
8871a29

As example
65f050d

Add workflows
35e1cdb

add pwd
f375765

add ls
34beefe

Checkout
2718bfc

add --user
cebb3e3

sudo
ce6df71

add preview
3fc0ba0

change name
c363916

leofang requested changes Jul 14, 2021
View reviewed changes

rgommers mentioned this pull request Jul 14, 2021
Refactor the boilerplate text at the top of each API spec section #223
Closed

steff456 added 2 commits July 19, 2021 09:31

Fix merge
a1b6290

Add review changes
7e720c8

leofang mentioned this pull request Jul 22, 2021
Summary of FFT APIs #159
Closed

leofang requested changes Jul 22, 2021
View reviewed changes

asmeurer reviewed Jul 22, 2021
View reviewed changes

Comment threadspec/extensions/fourier_transform_functions.md Outdated

Add review comments
46e504a

kgryte mentioned this pull request Sep 8, 2022
RFC: specifying the shape of the transformed output in n-dimensional FFT APIs #476
Closed

leofang requested changes Sep 11, 2022
View reviewed changes

Apply suggestions from code review
be6330a

leofang self-requested a review October 5, 2022 17:58

leofang added 6 commits October 6, 2022 13:01

add round-trip note to relevant fft pairs
c030c0c

fix s & axes requirement
29da2cd

improve wording
c0c25a1

fix input dtype limit
fd66e44

Merge branch 'main' into add-fft-extension
812f6ac

add placeholder & address nits
211fa3a

toslunar reviewed Oct 17, 2022
View reviewed changes

Comment threadspec/API_specification/array_api/fourier_transform_functions.py Outdated

leofang self-assigned this Oct 17, 2022

leofang added 2 commits October 17, 2022 00:15

add missing return type annotation
e8e0f1b

Change "should" to "must" for R2C transforms
18bea15

steff456 commented Oct 17, 2022
View reviewed changes

leofang approved these changes Oct 20, 2022
View reviewed changes

leofang merged commit 8949817 into data-apis:mainOct 20, 2022

honno mentioned this pull request Oct 9, 2023
Fix documented dtype inputs for rfft-like functions #696
Closed

kgryte mentioned this pull request Jan 8, 2024
Clean up some wording in the fft extension #720
Merged

rgommers added the topic: FFT Fast Fourier transforms. label Jan 11, 2024

Uh oh!

Conversation

steff456 commented Jun 4, 2021• edited by leofang Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rgommers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leofang left a comment

Choose a reason for hiding this comment

Uh oh!

leofang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

steff456 commented Jul 19, 2021

Uh oh!

leofang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kgryte commented Aug 22, 2022

Uh oh!

leofang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leofang commented Sep 11, 2022

Uh oh!

leofang commented Oct 5, 2022

Uh oh!

steff456 commented Oct 5, 2022

Uh oh!

leofang commented Oct 15, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rgommers commented Oct 16, 2022

Uh oh!

Uh oh!

steff456 left a comment

Choose a reason for hiding this comment

Uh oh!

leofang commented Oct 20, 2022

Uh oh!

Reviewers

Assignees

steff456 commented Jun 4, 2021•
edited by leofang
Loading

leofang left a comment •
edited
Loading

leofang left a comment •
edited
Loading

leofang commented Oct 15, 2022•
edited
Loading