Minor improvement of README #27
Conversation
yasahi-hpc
commented
Jan 23, 2024
yasahi-hpc
commented
- Improve Usage section
- Add disclaimer that we may change the code
More explanations
|
Hi @cedricchevalier19, may I have your review on README? Your comments are highly appreciated as usual. |
| @@ -6,8 +6,8 @@ UNOFFICIAL FFT interfaces for Kokkos C++ Performance Portability Programming Eco | |||
|
|
|||
| KokkosFFT implements local interfaces Kokkos and de facto standard FFT libraries, including fftw, cufft and hipfft. | |||
There was a problem hiding this comment.
Perhaps we can add a link to these FFT libraries?
| single MPI process without knowing about MPI. We are inclined to implement the numpy FFT interfaces based on Kokkos. | ||
| Here is the example for 1D case in python and KokkosFFT. | ||
| single MPI process without knowing about MPI. We are inclined to implement the [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html) interfaces based on [Kokkos](https://github.com/kokkos/kokkos). | ||
| A key concept is that "As easy as numpy, as fast as vendor libraries". Accordingly, our APIs follow the APIs by [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html) with minor differences. If something is wrong with runtime values, it will raise runtime errors. Here is the example for 1D real to complex transform with ```rfft``` in python and KokkosFFT. |
There was a problem hiding this comment.
s/APIs/API/g
it will raise runtime errors.
C++ exceptions? Be more precise.
There was a problem hiding this comment.
We have two errors: std::runtime_error and assert. Since this is README, I would like to make it more precise in docs, which is under development. Or do you think it is better to be precise in README?
| @@ -33,6 +33,8 @@ Kokkos::fence(); | |||
| KokkosFFT::rfft(execution_space(), x, x_hat); | |||
| ``` | |||
|
|
|||
| There are two major differences: ```execution_space``` argument and updating output as argument not returned. As imagined, KokkosFFT only accepts [Kokkos Views](https://kokkos.org/kokkos-core-wiki/API/core/View.html) as input data. The accessibilities of Views from ```execution_space``` is statically checked (compilation errors if not accessible). | |||
There was a problem hiding this comment.
updating output as argument not returned
Not very clear
Also try to define/link to execution_space.
There was a problem hiding this comment.
I will add a link to execution_space. How about rephrasing as
"output value is an argument of APIs (not returned from APIs)."
| Is is assumed that the Kokkos is installed under ```<lib_dir>/kokkos``` targeting Skylake with OpenMP backend. ```Kokkos_dir``` also needs to be set appropriately. Here is a recipe to install KokkosFFT under ```<lib_dir>/kokkosFFT```. | ||
|
|
There was a problem hiding this comment.
Why Skylake ? I do not see anything specific with this architecture.
There was a problem hiding this comment.
Simply because I am using Icelake in my environment. Any CPU is fine, just an example.
| @@ -6,8 +6,8 @@ UNOFFICIAL FFT interfaces for Kokkos C++ Performance Portability Programming Eco | |||
|
|
|||
| KokkosFFT implements local interfaces Kokkos and de facto standard FFT libraries, including fftw, cufft and hipfft. | |||
| "Local" means not using MPI, or running within a | |||
| single MPI process without knowing about MPI. We are inclined to implement the numpy FFT interfaces based on Kokkos. | |||
| Here is the example for 1D case in python and KokkosFFT. | |||
| single MPI process without knowing about MPI. We are inclined to implement the [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html) interfaces based on [Kokkos](https://github.com/kokkos/kokkos). | |||
There was a problem hiding this comment.
I do not think that we implement the numpy interface. numpy-like interface (adapted for Kokkos) seems more accurate.
There was a problem hiding this comment.
True. I will modify the sentence accordingly
|
@cedricchevalier19 Thanks a lot for your review! |
|
Closing. Modifications are made in PR (#36) |
