Skip to content
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

Add ISAI reference implementation #489

Merged
merged 26 commits into from
Apr 21, 2020
Merged

Add ISAI reference implementation #489

merged 26 commits into from
Apr 21, 2020

Conversation

thoasm
Copy link
Member

@thoasm thoasm commented Mar 27, 2020

This PR adds a reference implementation of ISAI (Incomplete Sparse Approximate Inverse).

Currently, I am not using a Composition internally because it is unable to handle multiple right hand sides. I will look into it and probably change that in the upcomming PR for the CUDA, HIP and OMP executor implementation.

@thoasm thoasm added is:new-feature A request or implementation of a feature that does not exist yet. mod:core This is related to the core module. mod:reference This is related to the reference module. type:preconditioner This is related to the preconditioners 1:ST:ready-for-review This PR is ready for review labels Mar 27, 2020
@thoasm thoasm self-assigned this Mar 27, 2020
Copy link
Member

@upsj upsj left a comment

Choose a reason for hiding this comment

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

LGTM in general, I have some comments on the class design and code itself though.

reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Show resolved Hide resolved
core/preconditioner/isai.cpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
@yhmtsai yhmtsai mentioned this pull request Mar 27, 2020
@thoasm thoasm force-pushed the add_isai_reference branch from e2e4d2d to 6fbd864 Compare March 30, 2020 10:27
@thoasm
Copy link
Member Author

thoasm commented Apr 1, 2020

All problems should now be resolved and most of the comments from @upsj are addressed.
We might have to discuss the responsibilities further.

pratikvn
pratikvn previously approved these changes Apr 1, 2020
Copy link
Member

@pratikvn pratikvn left a comment

Choose a reason for hiding this comment

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

Very nice extensive testing! Only some minor things.

include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Apr 2, 2020

Codecov Report

Merging #489 into develop will decrease coverage by 0.14%.
The diff coverage is 85.61%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #489      +/-   ##
===========================================
- Coverage    88.54%   88.40%   -0.15%     
===========================================
  Files          262      268       +6     
  Lines        16652    16923     +271     
===========================================
+ Hits         14745    14960     +215     
- Misses        1907     1963      +56     
Impacted Files Coverage Δ
core/device_hooks/common_kernels.inc.cpp 0.00% <0.00%> (ø)
omp/matrix/csr_kernels.cpp 13.06% <ø> (ø)
omp/preconditioner/isai_kernels.cpp 0.00% <0.00%> (ø)
reference/matrix/csr_kernels.cpp 98.93% <ø> (ø)
core/preconditioner/isai.cpp 51.72% <51.72%> (ø)
include/ginkgo/core/preconditioner/isai.hpp 76.47% <76.47%> (ø)
core/test/preconditioner/isai.cpp 84.00% <84.00%> (ø)
reference/test/preconditioner/isai_kernels.cpp 94.20% <94.20%> (ø)
reference/preconditioner/isai_kernels.cpp 94.66% <94.66%> (ø)
include/ginkgo/core/base/lin_op.hpp 58.33% <0.00%> (-17.86%) ⬇️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c25c1e...57ee063. Read the comment docs.

@thoasm thoasm force-pushed the add_isai_reference branch from 65ee0f6 to a1f0a30 Compare April 3, 2020 08:33
yhmtsai
yhmtsai previously approved these changes Apr 3, 2020
Copy link
Member

@yhmtsai yhmtsai left a comment

Choose a reason for hiding this comment

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

LGTM. only minor format changes

core/preconditioner/isai_kernels.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Outdated Show resolved Hide resolved
reference/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
upsj
upsj previously approved these changes Apr 3, 2020
@tcojean
Copy link
Member

tcojean commented Apr 3, 2020

Here: https://github.com/ginkgo-project/ginkgo/blob/develop/include/ginkgo/core/base/dim.hpp#L100

What would make this undefined behavior? Is that not covered by 5.7.5 in the standard? The only issue would be bound checking, but we have the assert.
http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3690.pdf

Edit: my bad, I now see what you mean maybe. first_ does not point to an array hence indeed that is rather an edge case here. This is supposing that rest_ comes directly after first_ and that the only thing in each of the recursive first_ elements are these values with no extra data or storage in between...

@upsj
Copy link
Member

upsj commented Apr 3, 2020

I think the relevant part here would be § 9.2.13:

Nonstatic data members of a (non-union) class with the same access control (Clause 11) are allocated so that later members have higher addresses within a class object. The order of allocation of non-static data members with different access control is unspecified (Clause 11). Implementation alignment requirements might cause two adjacent members not to be allocated immediately after each other;

@tcojean
Copy link
Member

tcojean commented Apr 3, 2020

Yes indeed, with the code depending on first_ and rest_ (in fact each of the subsequent first_ in recursion) being laid out in a strict consecutive fashion, that is rather broken. Your section shows it clearly. I had completely forgotten this had been implemented like that...

@thoasm
Copy link
Member Author

thoasm commented Apr 3, 2020

I also did not know or forgot that we store and access the dimensions that way. I assume that the intel compiler saw a chance to optimize there (to only copy the first_ part), which caused the second dimension to never be initialized (valgrind also noted that there was a conditional jump on an uninitialized variable).

@thoasm thoasm force-pushed the add_isai_reference branch from 3c9fed0 to 86f90c4 Compare April 3, 2020 12:27
tcojean
tcojean previously approved these changes Apr 3, 2020
Copy link
Member

@tcojean tcojean left a comment

Choose a reason for hiding this comment

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

LGTM. Only some minor comments.

core/preconditioner/isai.cpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Show resolved Hide resolved
include/ginkgo/core/preconditioner/isai.hpp Show resolved Hide resolved
reference/test/preconditioner/isai_kernels.cpp Outdated Show resolved Hide resolved
Thomas Grützmacher and others added 13 commits April 21, 2020 03:57
- Fixed spelling mistakes in comments
- Renamed `generate_l` to `generate_l_inverse` to make intent clear
  (same for `generate_u`)
- Use correct dimension when copying row_ptrs
Co-Authored-By: Yuhsiang M. Tsai <[email protected]>
- Add more documentation to ISAI (where the inverses are stored)
- Removed unnecessary `I<T>` in reference tests
- Use `null_deleter` instead of hand-written lambda
ISAI is now separated into LowerIsai and UpperIsai, each handling only
one matrix (lower or upper triangular matrix respectively).
- Rename `system_matrix` to `approximate_inverse`
- Add test for parameter `skip_sorting`
Also, restrict the lambda argument for the trisystem pointer in the
reference module to `const`.
Making a comment more clear.
@thoasm thoasm force-pushed the add_isai_reference branch 2 times, most recently from 952cd59 to 5bd9354 Compare April 21, 2020 08:46
@thoasm thoasm force-pushed the add_isai_reference branch from 5bd9354 to ec2e406 Compare April 21, 2020 09:12
@thoasm
Copy link
Member Author

thoasm commented Apr 21, 2020

@yhmtsai Unfortunately, moving the CXXFLAGS flags to the GINKGO_COMPILER_FLAGS did not work, as you can see in the output the github workflow here.
A reason might be that we do not use GINKGO_COMPILER_FLAGS when building the tests, but that is just a guess.
I will revert the change and leave it as was (with cflags == "-O1"), so it passes all workflows properly.

The revert is necessary because it still caused issues for Windows.
@hartwiganzt
Copy link
Collaborator

hartwiganzt commented Apr 21, 2020

@thoasm ready to be merged?

@thoasm
Copy link
Member Author

thoasm commented Apr 21, 2020

@hartwig Now that all tests succeeded, yes, I will merge it.

@thoasm thoasm merged commit 8ec56dd into develop Apr 21, 2020
@thoasm thoasm deleted the add_isai_reference branch April 21, 2020 19:03
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tcojean tcojean mentioned this pull request Jun 23, 2020
tcojean added a commit that referenced this pull request Jul 7, 2020
The Ginkgo team is proud to announce the new minor release of Ginkgo version
1.2.0. This release brings full HIP support to Ginkgo, new preconditioners
(ParILUT, ISAI), conversion between double and float for all LinOps, and many
more features and fixes.

Supported systems and requirements:
+ For all platforms, cmake 3.9+
+ Linux and MacOS
  + gcc: 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + clang: 3.9+
  + Intel compiler: 2017+
  + Apple LLVM: 8.0+
  + CUDA module: CUDA 9.0+
  + HIP module: ROCm 2.8+
+ Windows
  + MinGW and CygWin: gcc 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + Microsoft Visual Studio: VS 2017 15.7+
  + CUDA module: CUDA 9.0+, Microsoft Visual Studio
  + OpenMP module: MinGW or CygWin.


The current known issues can be found in the [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues).


# Additions
Here are the main additions to the Ginkgo library. Other thematic additions are listed below.
+ Add full HIP support to Ginkgo [#344](#344), [#357](#357), [#384](#384), [#373](#373), [#391](#391), [#396](#396), [#395](#395), [#393](#393), [#404](#404), [#439](#439), [#443](#443), [#567](#567)
+ Add a new ISAI preconditioner [#489](#489), [#502](#502), [#512](#512), [#508](#508), [#520](#520)
+ Add support for ParILUT and ParICT factorization with ILU preconditioners [#400](#400)
+ Add a new BiCG solver [#438](#438)
+ Add a new permutation matrix format [#352](#352), [#469](#469)
+ Add CSR SpGEMM support [#386](#386), [#398](#398), [#418](#418), [#457](#457)
+ Add CSR SpGEAM support [#556](#556)
+ Make all solvers and preconditioners transposable [#535](#535)
+ Add CsrBuilder and CooBuilder for intrusive access to matrix arrays [#437](#437)
+ Add a standard-compliant allocator based on the Executors [#504](#504)
+ Support conversions for all LinOp between double and float [#521](#521)
+ Add a new boolean to the CUDA and HIP executors to control DeviceReset (default off) [#557](#557)
+ Add a relaxation factor to IR to represent Richardson Relaxation [#574](#574)
+ Add two new stopping criteria, for relative (to `norm(b)`) and absolute residual norm [#577](#577)

### Example additions
+ Templatize all examples to simplify changing the precision [#513](#513)
+ Add a new adaptive precision block-Jacobi example [#507](#507)
+ Add a new IR example [#522](#522)
+ Add a new Mixed Precision Iterative Refinement example [#525](#525)
+ Add a new example on iterative trisolves in ILU preconditioning [#526](#526), [#536](#536), [#550](#550)

### Compilation and library changes
+ Auto-detect compilation settings based on environment [#435](#435), [#537](#537)
+ Add SONAME to shared libraries [#524](#524)
+ Add clang-cuda support [#543](#543)

### Other additions
+ Add sorting, searching and merging kernels for GPUs [#403](#403), [#428](#428), [#417](#417), [#455](#455)
+ Add `gko::as` support for smart pointers [#493](#493)
+ Add setters and getters for criterion factories [#527](#527)
+ Add a new method to check whether a solver uses `x` as an initial guess [#531](#531)
+ Add contribution guidelines [#549](#549)

# Fixes
### Algorithms
+ Improve the classical CSR strategy's performance [#401](#401)
+ Improve the CSR automatical strategy [#407](#407), [#559](#559)
+ Memory, speed improvements to the ELL kernel [#411](#411)
+ Multiple improvements and fixes to ParILU [#419](#419), [#427](#427), [#429](#429), [#456](#456), [#544](#544)
+ Fix multiple issues with GMRES [#481](#481), [#523](#523), [#575](#575)
+ Optimize OpenMP matrix conversions [#505](#505)
+ Ensure the linearity of the ILU preconditioner [#506](#506)
+ Fix IR's use of the advanced apply [#522](#522)
+ Fix empty matrices conversions and add tests [#560](#560)

### Other core functionalities
+ Fix complex number support in our math header [#410](#410)
+ Fix CUDA compatibility of the main ginkgo header [#450](#450)
+ Fix isfinite issues [#465](#465)
+ Fix the Array::view memory leak and the array/view copy/move [#485](#485)
+ Fix typos preventing use of some interface functions [#496](#496)
+ Fix the `gko::dim` to abide to the C++ standard [#498](#498)
+ Simplify the executor copy interface [#516](#516)
+ Optimize intermediate storage for Composition [#540](#540)
+ Provide an initial guess for relevant Compositions [#561](#561)
+ Better management of nullptr as criterion [#562](#562)
+ Fix the norm calculations for complex support [#564](#564)

### CUDA and HIP specific
+ Use the return value of the atomic operations in our wrappers [#405](#405)
+ Improve the portability of warp lane masks [#422](#422)
+ Extract thread ID computation into a separate function [#464](#464)
+ Reorder kernel parameters for consistency [#474](#474)
+ Fix the use of `pragma unroll` in HIP [#492](#492)

### Other
+ Fix the Ginkgo CMake installation files [#414](#414), [#553](#553)
+ Fix the Windows compilation [#415](#415)
+ Always use demangled types in error messages [#434](#434), [#486](#486)
+ Add CUDA header dependency to appropriate tests [#452](#452)
+ Fix several sonarqube or compilation warnings [#453](#453), [#463](#463), [#532](#532), [#569](#569)
+ Add shuffle tests [#460](#460)
+ Fix MSVC C2398 error [#490](#490)
+ Fix missing interface tests in test install [#558](#558)

# Tools and ecosystem
### Benchmarks
+ Add better norm support in the benchmarks [#377](#377)
+ Add CUDA 10.1 generic SpMV support in benchmarks [#468](#468), [#473](#473)
+ Add sparse library ILU in benchmarks [#487](#487)
+ Add overhead benchmarking capacities [#501](#501)
+ Allow benchmarking from a matrix list file [#503](#503)
+ Fix benchmarking issue with JSON and non-finite numbers [#514](#514)
+ Fix benchmark logger crashers with OpenMP [#565](#565)

### CI related
+ Improvements to the CI setup with HIP compilation [#421](#421), [#466](#466)
+ Add MacOSX CI support [#470](#470), [#488](#488)
+ Add Windows CI support [#471](#471), [#488](#488), [#510](#510), [#566](#566)
+ Use sanitizers instead of valgrind [#476](#476)
+ Add automatic container generation and update facilities [#499](#499)
+ Fix the CI parallelism settings [#517](#517), [#538](#538), [#539](#539)
+ Make the codecov patch check informational [#519](#519)
+ Add support for LLVM sanitizers with improved thread sanitizer support [#578](#578)

### Test suite
+ Add an assertion for sparsity pattern equality [#416](#416)
+ Add core and reference multiprecision tests support [#448](#448)
+ Speed up GPU tests by avoiding device reset [#467](#467)
+ Change test matrix location string [#494](#494)

### Other
+ Add Ginkgo badges from our tools [#413](#413)
+ Update the `create_new_algorithm.sh` script [#420](#420)
+ Bump copyright and improve license management [#436](#436), [#433](#433)
+ Set clang-format minimum requirement [#441](#441), [#484](#484)
+ Update git-cmake-format [#446](#446), [#484](#484)
+ Disable the development tools by default [#442](#442)
+ Add a script for automatic header formatting [#447](#447)
+ Add GDB pretty printer for `gko::Array` [#509](#509)
+ Improve compilation speed [#533](#533)
+ Add editorconfig support [#546](#546)
+ Add a compile-time check for header self-sufficiency [#552](#552)


# Related PR: #583
yhmtsai added a commit that referenced this pull request Jul 29, 2020
yhmtsai added a commit that referenced this pull request Aug 4, 2020
lksriemer pushed a commit to lksriemer/ginkgo that referenced this pull request Aug 22, 2020
tcojean pushed a commit that referenced this pull request Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1:ST:ready-to-merge This PR is ready to merge. is:new-feature A request or implementation of a feature that does not exist yet. mod:core This is related to the core module. mod:reference This is related to the reference module. type:preconditioner This is related to the preconditioners
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants