update handling shape and axes of scipy interface#181
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the SciPy interface to use SciPy’s native helper (_init_nd_shape_and_axes) for handling shape and axes in N-D FFTs instead of NumPy’s _cook_nd_args, and clarifies the treatment of the overwrite_x parameter in docstrings. Additionally, minor modifications are made to the CHANGELOG and conda workflow to ensure consistency with dependency requirements.
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkl_fft/interfaces/_scipy_fft.py | Updated FFT function implementations to call _init_nd_shape_and_axes and removed redundant checks on overwrite_x; minor docstring adjustments applied. |
| CHANGELOG.md | Updated changelog notes to reflect the new behavior in the SciPy interface and aligned numpy interface wording. |
| .github/workflows/conda-package.yml | Adjusted commands for conda environment creation and package installation for better dependency handling. |
Files not reviewed (1)
- mkl_fft/_pydfti.pyx: Language not supported
Comments suppressed due to low confidence (1)
mkl_fft/interfaces/_scipy_fft.py:428
- [nitpick] The parameter 'overwrite_x' remains in the function signature but is not used. Consider updating the function docstring or parameter description to clarify that it is maintained for API compatibility and is ignored in the current implementation.
# Note: overwrite_x is not utilized
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
54d111d to
e99e642
Compare
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
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,
SciPy interface is updated to use the same function from SciPy for handling shape and axes in N-D FFTs (Currently it uses
_cook_nd_argsfunction which is from NumPy, in this PR, this function is replaced with_init_nd_shape_and_axeswhich is from SciPy)Although SciPy has
overwrite_xparameter for real-to-complex and complex-to-real FFTs, it has not been used internally. It has not been used inmkl_fftas well and it is not a limitation formkl_fftso docstring is updated accordingly.