Skip to content

add README.md to interfaces #179

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add README.md to interfaces #179

wants to merge 1 commit into from

Conversation

vtavana
Copy link
Collaborator

@vtavana vtavana commented May 9, 2025

In this PR,

  1. Project README.md file is updated and a new README.md file is added to interfaces module. resolves top-level documentation for inverse real needs clarification #49
  2. support for fftfreq, fftshift, ifftshift, and rfftfreq is 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? #106
  3. With this PR, To set mkl_fft as the backend for SciPy is only possible through mkl_fft.interfaces.scipy_fft as explained in the examples. resolves Stable API for scipy FFT backend #170

@vtavana vtavana self-assigned this May 9, 2025
@vtavana vtavana force-pushed the add-readme-interfaces branch 2 times, most recently from d09aa45 to 9af7ecc Compare May 9, 2025 13:37
@vtavana vtavana marked this pull request as ready for review May 9, 2025 14:21
@Copilot Copilot AI review requested due to automatic review settings May 9, 2025 14:21
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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

@vtavana vtavana force-pushed the add-readme-interfaces branch from 9af7ecc to 9facd2f Compare May 10, 2025 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stable API for scipy FFT backend top-level documentation for inverse real needs clarification
1 participant