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

Make preconditioners transposable #535

Merged
merged 9 commits into from
Jun 17, 2020
Merged

Conversation

upsj
Copy link
Member

@upsj upsj commented May 14, 2020

This PR makes all of our preconditioners and solvers transposable. For composite preconditioners, this works by adding a transposed_type alias to all transposable LinOps, so we can convert between LowerTrs/Isai and UpperTrs/Isai

TODO:

  • Add tests
  • Implement Jacobi transpose

Fixes #477

@upsj upsj added type:preconditioner This is related to the preconditioners 1:ST:WIP This PR is a work in progress. Not ready for review. labels May 14, 2020
@upsj upsj self-assigned this May 14, 2020
@upsj upsj added this to the Ginkgo 1.2.0 milestone May 14, 2020
@codecov
Copy link

codecov bot commented May 15, 2020

Codecov Report

Merging #535 into develop will decrease coverage by 0.02%.
The diff coverage is 81.15%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #535      +/-   ##
===========================================
- Coverage    84.14%   84.12%   -0.03%     
===========================================
  Files          296      296              
  Lines        19838    20296     +458     
===========================================
+ Hits         16693    17073     +380     
- Misses        3145     3223      +78     
Impacted Files Coverage Δ
core/base/combination.cpp 45.94% <0.00%> (-48.50%) ⬇️
core/base/composition.cpp 72.30% <0.00%> (-23.62%) ⬇️
core/device_hooks/common_kernels.inc.cpp 0.00% <0.00%> (ø)
core/test/matrix/coo.cpp 98.41% <ø> (ø)
core/test/matrix/sellp.cpp 98.27% <ø> (ø)
include/ginkgo/core/base/combination.hpp 73.33% <ø> (ø)
include/ginkgo/core/base/composition.hpp 72.00% <ø> (ø)
include/ginkgo/core/base/utils.hpp 38.00% <0.00%> (-18.00%) ⬇️
include/ginkgo/core/matrix/csr.hpp 13.46% <ø> (ø)
include/ginkgo/core/matrix/dense.hpp 72.41% <ø> (ø)
... and 57 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 4ac2b43...b1f10a8. Read the comment docs.

@upsj upsj force-pushed the transposable_preconditioners branch 2 times, most recently from 18ff8ae to 9c53d6d Compare May 15, 2020 17:04
@upsj upsj force-pushed the transposable_preconditioners branch from 9c53d6d to 177e0d8 Compare June 7, 2020 21:59
@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 Jun 7, 2020
@upsj upsj force-pushed the transposable_preconditioners branch from fdeebb0 to 299860c Compare June 8, 2020 07:54
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.

Should permute_and_transpose_block in block_jacobi generation be permute_and_conj_transpose_block?

core/solver/cg.cpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/jacobi.hpp Outdated Show resolved Hide resolved
include/ginkgo/core/preconditioner/jacobi.hpp Show resolved Hide resolved
core/solver/lower_trs.cpp Outdated Show resolved Hide resolved
omp/test/preconditioner/jacobi_kernels.cpp Outdated Show resolved Hide resolved
@upsj upsj force-pushed the transposable_preconditioners branch from 299860c to 8318f8a Compare June 10, 2020 13:50
@upsj upsj force-pushed the transposable_preconditioners branch from 8318f8a to 3ed2dba Compare June 10, 2020 14:00
@upsj upsj requested a review from yhmtsai June 10, 2020 14:06
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

omp/test/preconditioner/jacobi_kernels.cpp Outdated Show resolved Hide resolved
cuda/test/preconditioner/jacobi_kernels.cpp Outdated Show resolved Hide resolved
cuda/test/preconditioner/jacobi_kernels.cpp Show resolved Hide resolved
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.

LGTM!

@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 Jun 16, 2020
Copy link
Member

@thoasm thoasm left a comment

Choose a reason for hiding this comment

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

LGTM, mostly nits about formating.

core/base/combination.cpp Outdated Show resolved Hide resolved
core/preconditioner/isai.cpp Show resolved Hide resolved
core/preconditioner/jacobi.cpp Show resolved Hide resolved
core/preconditioner/jacobi.cpp Show resolved Hide resolved
reference/test/preconditioner/ilu.cpp Outdated Show resolved Hide resolved
reference/test/preconditioner/jacobi_kernels.cpp Outdated Show resolved Hide resolved
reference/test/preconditioner/jacobi_kernels.cpp Outdated Show resolved Hide resolved
reference/test/solver/upper_trs_kernels.cpp Show resolved Hide resolved
upsj and others added 9 commits June 17, 2020 09:17
except for Jacobi, that one requires a bit more work
This only tests the core implementation since
there are no kernels involved

Also fixes a (recurring) bug with typeid
Co-authored-by: yhmtsai <[email protected]>
use stricter test tolerances

Co-authored-by: Yuhsiang M. Tsai <[email protected]>
formatting and code style

Co-authored-by: Thomas Grützmacher <[email protected]>
@upsj upsj force-pushed the transposable_preconditioners branch from b7c6320 to b1f10a8 Compare June 17, 2020 07:37
@sonarcloud
Copy link

sonarcloud bot commented Jun 17, 2020

SonarCloud Quality Gate failed.

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

69.2% 69.2% Coverage
21.2% 21.2% 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 ba6f99a into develop Jun 17, 2020
@upsj upsj deleted the transposable_preconditioners branch June 17, 2020 10:45
@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. type:preconditioner This is related to the preconditioners
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BiCG does not work with preconditioners
4 participants