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 ParILUT #400

Merged
merged 21 commits into from
May 29, 2020
Merged

Add ParILUT #400

merged 21 commits into from
May 29, 2020

Conversation

upsj
Copy link
Member

@upsj upsj commented Nov 25, 2019

This PR adds ParILUT factorization support to Ginkgo.

Since this is a rather large PR, even though there are still a few parts missing, it might make sense to already start reviewing the kernel implementations.

TODO

  • Add core tests
  • Add benchmarks
  • Run benchmarks
  • Add more comments to complicated kernels
  • Add __restrict__ modifiers where appropriate
  • Integrate Array overallocation functionality (see array_dynamic_functionality)
  • Increase number of sweep iterations to avoid spurious test failures
  • Add full tests with core interface
  • Add templated tests
  • Format header files (depends on format the header of files #447)
  • Wait until the Array assignment operator gets updated (depends on Fix the view memory leak and array/view copy/move. #485)
  • Add ParICT for SPD matrices
  • Add ParICT tests
  • Add test for filter nullptr COO parameter

@upsj upsj added is:new-feature A request or implementation of a feature that does not exist yet. 1:ST:WIP This PR is a work in progress. Not ready for review. type:factorization This is related to the Factorizations labels Nov 25, 2019
@upsj upsj force-pushed the add_par_ilut branch 3 times, most recently from 42c3347 to 2a8ffad Compare December 2, 2019 11:25
@tcojean tcojean added mod:cuda This is related to the CUDA module. mod:openmp This is related to the OpenMP module. labels Dec 2, 2019
@upsj upsj force-pushed the add_par_ilut branch 3 times, most recently from 0b6fd90 to 90a86f1 Compare December 11, 2019 10:42
@upsj upsj force-pushed the add_par_ilut branch 2 times, most recently from 0a7b4c0 to 91703e4 Compare December 11, 2019 15:47
@upsj upsj added mod:hip This is related to the HIP module. mod:reference This is related to the reference module. labels Dec 17, 2019
@upsj upsj force-pushed the add_par_ilut branch 6 times, most recently from 365aab7 to b6a4c75 Compare January 13, 2020 00:25
@upsj upsj force-pushed the add_par_ilut branch 3 times, most recently from ffe5b91 to da56899 Compare January 24, 2020 11:05
@upsj upsj added 1:ST:ready-for-review This PR is ready for review and removed 1:ST:WIP This PR is a work in progress. Not ready for review. labels Feb 26, 2020
upsj and others added 18 commits May 28, 2020 15:19
This reverts commit 838c702.

For ParILUT, we do need this diagonal addition, since we do not
modify our system matrix internally.
for larger matrices, write them to a file instead
ValueType, then IndexType
Co-authored-by: Hartwig Anzt <[email protected]>
Co-authored-by: Pratik Nayak <[email protected]>
Co-authored-by: Fritz Goebel <[email protected]>
* ssss -> sampleselect
* remove remaining has_diagonal
* add header guards to par_ixt_common.hpp
* fix missing newlines
* update benchmark parameters
* add comments for abstract_spgeam

Co-authored-by: Pratik Nayak <[email protected]>
Co-authored-by: Fritz Goebel <[email protected]>
Co-authored-by: yhmtsai <[email protected]>
Only a single blank line between kernel implementation and instantiation

Co-authored-by: yhmtsai <[email protected]>
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. some minor format changes

core/factorization/par_ilut_kernels.hpp Show resolved Hide resolved
core/factorization/par_ilut_kernels.hpp Show resolved Hide resolved
core/factorization/par_ilut_kernels.hpp Show resolved Hide resolved
core/factorization/par_ilut_kernels.hpp Show resolved Hide resolved
Comment on lines +105 to +109
namespace par_ilut_factorization {

GKO_DECLARE_ALL_AS_TEMPLATES;

} // namespace par_ilut_factorization
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
namespace par_ilut_factorization {
GKO_DECLARE_ALL_AS_TEMPLATES;
} // namespace par_ilut_factorization
namespace par_ilut_factorization {
GKO_DECLARE_ALL_AS_TEMPLATES;
} // namespace par_ilut_factorization

Copy link
Member Author

Choose a reason for hiding this comment

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

We currently don't use two blank lines like this anywhere around GKO_DECLARE_ALL_AS_TEMPLATES

Comment on lines +114 to +118
namespace par_ilut_factorization {

GKO_DECLARE_ALL_AS_TEMPLATES;

} // namespace par_ilut_factorization
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
namespace par_ilut_factorization {
GKO_DECLARE_ALL_AS_TEMPLATES;
} // namespace par_ilut_factorization
namespace par_ilut_factorization {
GKO_DECLARE_ALL_AS_TEMPLATES;
} // namespace par_ilut_factorization

Comment on lines +124 to +126

GKO_DECLARE_ALL_AS_TEMPLATES;

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
GKO_DECLARE_ALL_AS_TEMPLATES;
GKO_DECLARE_ALL_AS_TEMPLATES;

Comment on lines +133 to +135

GKO_DECLARE_ALL_AS_TEMPLATES;

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
GKO_DECLARE_ALL_AS_TEMPLATES;
GKO_DECLARE_ALL_AS_TEMPLATES;

@upsj upsj added 1:ST:ready-to-merge This PR is ready to merge. and removed 1:ST:ready-for-review This PR is ready for review labels May 28, 2020
@sonarcloud
Copy link

sonarcloud bot commented May 28, 2020

SonarCloud Quality Gate failed.

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

71.9% 71.9% Coverage
22.7% 22.7% Duplication

warning The version of Java (1.8.0_121) you have used to run this analysis is deprecated and we will stop accepting it from October 2020. Please update to at least Java 11.
Read more here

@upsj upsj merged commit 617fb36 into develop May 29, 2020
@upsj upsj deleted the add_par_ilut branch May 29, 2020 10:54
@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
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. type:factorization This is related to the Factorizations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants