add README.md to interfaces
#179
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vtavana
force-pushed
the
add-readme-interfaces
branch
2 times, most recently
from
d09aa45 to
9af7ecc
Compare
vtavana
requested review from
ndgrigorian,
antonwolfy,
xaleryb and
ekomarova
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR extends the interfaces provided by mkl_fft by adding support for helper functions (fftfreq, fftshift, ifftshift, and rfftfreq) and updates the documentation and tests accordingly. It also refines the conda packaging workflow to ensure proper dependency installation.
- Added support for new FFT helper functions in both NumPy and SciPy interfaces.
- Introduced a dedicated README.md for the interfaces module and updated the root README and CHANGELOG.
- Adjusted tests and workflow definitions to match the new functionality and dependency requirements.
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkl_fft/tests/test_interfaces.py | Added tests to validate the existence of new FFT helper functions. |
| mkl_fft/interfaces/scipy_fft.py | Updated namespace imports and all to include new helper functions. |
| mkl_fft/interfaces/numpy_fft.py | Updated namespace imports and all to include new helper functions. |
| mkl_fft/interfaces/_scipy_fft.py | Removed legacy docstring and DftiBackend API definitions. |
| mkl_fft/interfaces/README.md | Added documentation for interfaces and usage examples. |
| README.md | Adjusted details and examples to reflect the new interfaces. |
| CHANGELOG.md | Updated change logs to reflect added functionality and modifications. |
| .github/workflows/conda-package.yml | Refined package creation and dependency installation commands. |
Files not reviewed (1)
- mkl_fft/_pydfti.pyx: Language not supported
Comments suppressed due to low confidence (1)
mkl_fft/interfaces/_scipy_fft.py:63
- The removal of the detailed module docstring and the DftiBackend class in _scipy_fft.py may break backward compatibility for users relying on these API endpoints. Please consider adding appropriate deprecation warnings or updating the documentation to clearly indicate this breaking change.
Removed DftiBackend class and associated module docstring
9af7ecc to
9facd2f
Compare
antonwolfy
approved these changes
May 15, 2025
Co-authored-by: Anton <100830759+antonwolfy@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR,
README.mdfile is updated and a newREADME.mdfile is added to interfaces module. resolves top-level documentation for inverse real needs clarification #49fftfreq,fftshift,ifftshift, andrfftfreqis added to both NumPy and SciPy interfaces by calling back on their original implementation in NumPy and SciPy. This is done for completeness as requested by fftshifts? #106mkl_fftas the backend for SciPy is only possible throughmkl_fft.interfaces.scipy_fftas explained in the examples. resolves Stable API for scipy FFT backend #170