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 support for distributed block-diagonal preconditioners. #1248

Merged
merged 17 commits into from
Feb 11, 2023

Conversation

pratikvn
Copy link
Member

@pratikvn pratikvn commented Dec 20, 2022

This PR is the first set of PRs enabling distributed preconditioning for our distributed solvers.

  • As discussed, everything is in the experimental namespace and in the distributed/ folder.
  • An example has been added to show the usage of the preconditioner.
  • Some minor fixes have also been done to mpi, the run and dispatch function and also moving some things into the experimental namespace (Some contributed by @MarcelKoch).
  • A distributed stream logger was also added, but this probably needs more discussion (By @MarcelKoch). Removed for now, as it is a separate thing, for which a new PR should be created.

TODO

  • Add tests.

@pratikvn pratikvn added type:preconditioner This is related to the preconditioners 1:ST:WIP This PR is a work in progress. Not ready for review. type:distributed-functionality labels Dec 20, 2022
@pratikvn pratikvn self-assigned this Dec 20, 2022
@ginkgo-bot ginkgo-bot added mod:core This is related to the core module. reg:build This is related to the build system. reg:example This is related to the examples. type:matrix-format This is related to the Matrix formats labels Dec 20, 2022
@upsj
Copy link
Member

upsj commented Dec 20, 2022

How does this compare to #1241?

@pratikvn
Copy link
Member Author

#1241 is a clone (with different naming) of what was there in a previous distributed preconditioner branch.

This PR takes a few initial commits from that distributed-schwarz, which adds the local block preconditioning into the Schwarz preconditioner class, which is what these general block preconditioners are called. This is also a extension of the Schwarz preconditioners from #1089, which was closed as we decided to do this directly for distributed.

@sonarcloud
Copy link

sonarcloud bot commented Dec 22, 2022

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 22 Code Smells

5.0% 5.0% Coverage
28.6% 28.6% Duplication

@pratikvn pratikvn added 1:ST:ready-for-review This PR is ready for review 1:ST:run-full-test and removed 1:ST:WIP This PR is a work in progress. Not ready for review. labels Dec 31, 2022
@MarcelKoch
Copy link
Member

If there are already other commits that build upon these changes (I guess for the overlapping stuff), then I would suggest going forward with this PR over #1241. Integrating the other changes should then be easier.

Copy link
Collaborator

@greole greole left a comment

Choose a reason for hiding this comment

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

Some minor comments from my side

core/distributed/helpers.hpp Outdated Show resolved Hide resolved
core/distributed/preconditioner/schwarz.cpp Outdated Show resolved Hide resolved
core/distributed/preconditioner/schwarz.cpp Show resolved Hide resolved
examples/distributed-preconditioned-solver/doc/intro.dox Outdated Show resolved Hide resolved
core/distributed/helpers.hpp Outdated Show resolved Hide resolved
examples/CMakeLists.txt Outdated Show resolved Hide resolved
examples/distributed-solver/distributed-solver.cpp Outdated Show resolved Hide resolved
include/ginkgo/core/distributed/preconditioner/schwarz.hpp Outdated Show resolved Hide resolved
@pratikvn
Copy link
Member Author

pratikvn commented Feb 1, 2023

format!

@pratikvn pratikvn force-pushed the dist-schwarz branch 3 times, most recently from eb3f02a to 4aa1f54 Compare February 1, 2023 16:22
@pratikvn
Copy link
Member Author

pratikvn commented Feb 1, 2023

This has been rebased and should be ready to review again.

@pratikvn pratikvn requested a review from a team February 1, 2023 16:25
@pratikvn pratikvn changed the title Add support for distributed diagonal block preconditioners. Add support for distributed block-diagonal preconditioners. Feb 2, 2023
Copy link
Member

@MarcelKoch MarcelKoch left a comment

Choose a reason for hiding this comment

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

I think it's missing an apply test.

include/ginkgo/core/distributed/preconditioner/schwarz.hpp Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 2, 2023

Codecov Report

Base: 91.39% // Head: 91.01% // Decreases project coverage by -0.39% ⚠️

Coverage data is based on head (de2adf6) compared to base (19b7249).
Patch coverage: 99.25% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1248      +/-   ##
===========================================
- Coverage    91.39%   91.01%   -0.39%     
===========================================
  Files          561      565       +4     
  Lines        47798    48005     +207     
===========================================
+ Hits         43684    43690       +6     
- Misses        4114     4315     +201     
Impacted Files Coverage Δ
core/distributed/preconditioner/schwarz.cpp 92.30% <92.30%> (ø)
...re/test/mpi/distributed/preconditioner/schwarz.cpp 100.00% <100.00%> (ø)
...ginkgo/core/distributed/preconditioner/schwarz.hpp 100.00% <100.00%> (ø)
test/mpi/distributed/preconditioner/schwarz.cpp 100.00% <100.00%> (ø)
omp/factorization/par_ilu_kernels.cpp 0.00% <0.00%> (-100.00%) ⬇️
test/factorization/par_ilu_kernels.cpp 0.00% <0.00%> (-89.66%) ⬇️
omp/factorization/factorization_kernels.cpp 0.00% <0.00%> (-79.46%) ⬇️
devices/machine_topology.cpp 77.77% <0.00%> (-4.94%) ⬇️
common/unified/solver/bicgstab_kernels.cpp 100.00% <0.00%> (ø)
reference/base/index_set_kernels.cpp 94.20% <0.00%> (+0.08%) ⬆️
... and 4 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@pratikvn pratikvn force-pushed the dist-schwarz branch 3 times, most recently from 8274219 to fc978a0 Compare February 9, 2023 14:15
Copy link
Collaborator

@greole greole left a comment

Choose a reason for hiding this comment

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

LGTM

@pratikvn pratikvn 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 Feb 9, 2023
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, I only have a few small things I would like to note

core/test/mpi/distributed/preconditioner/schwarz.cpp Outdated Show resolved Hide resolved
core/test/mpi/distributed/preconditioner/schwarz.cpp Outdated Show resolved Hide resolved
examples/distributed-solver/distributed-solver.cpp Outdated Show resolved Hide resolved
include/ginkgo/core/distributed/preconditioner/schwarz.hpp Outdated Show resolved Hide resolved
core/distributed/preconditioner/schwarz.cpp Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Feb 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 16 Code Smells

78.8% 78.8% Coverage
0.0% 0.0% Duplication

@pratikvn pratikvn merged commit 2870507 into develop Feb 11, 2023
@pratikvn pratikvn deleted the dist-schwarz branch February 11, 2023 12:27
tcojean added a commit that referenced this pull request Jun 16, 2023
Release 1.6.0 of Ginkgo.

The Ginkgo team is proud to announce the new Ginkgo minor release 1.6.0. This release brings new features such as:
- Several building blocks for GPU-resident sparse direct solvers like symbolic
  and numerical LU and Cholesky factorization, ...,
- A distributed Schwarz preconditioner,
- New FGMRES and GCR solvers,
- Distributed benchmarks for the SpMV operation, solvers, ...
- Support for non-default streams in the CUDA and HIP backends,
- Mixed precision support for the CSR SpMV,
- A new profiling logger which integrates with NVTX, ROCTX, TAU and VTune to
  provide internal Ginkgo knowledge to most HPC profilers!

and much more.

If you face an issue, please first check our [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues) and the [open issues list](https://github.com/ginkgo-project/ginkgo/issues) and if you do not find a solution, feel free to [open a new issue](https://github.com/ginkgo-project/ginkgo/issues/new/choose) or ask a question using the [github discussions](https://github.com/ginkgo-project/ginkgo/discussions).

Supported systems and requirements:
+ For all platforms, CMake 3.13+
+ C++14 compliant compiler
+ Linux and macOS
  + GCC: 5.5+
  + clang: 3.9+
  + Intel compiler: 2018+
  + Apple Clang: 14.0 is tested. Earlier versions might also work.
  + NVHPC: 22.7+
  + Cray Compiler: 14.0.1+
  + CUDA module: CUDA 9.2+ or NVHPC 22.7+
  + HIP module: ROCm 4.5+
  + DPC++ module: Intel OneAPI 2021.3+ with oneMKL and oneDPL. Set the CXX compiler to `dpcpp`.
+ Windows
  + MinGW: GCC 5.5+
  + Microsoft Visual Studio: VS 2019+
  + CUDA module: CUDA 9.2+, Microsoft Visual Studio
  + OpenMP module: MinGW.

### Version Support Changes
+ ROCm 4.0+ -> 4.5+ after [#1303](#1303)
+ Removed Cygwin pipeline and support [#1283](#1283)

### Interface Changes
+ Due to internal changes, `ConcreteExecutor::run` will now always throw if the corresponding module for the `ConcreteExecutor` is not build [#1234](#1234)
+ The constructor of `experimental::distributed::Vector` was changed to only accept local vectors as `std::unique_ptr` [#1284](#1284)
+ The default parameters for the `solver::MultiGrid` were improved. In particular, the smoother defaults to one iteration of `Ir` with `Jacobi` preconditioner, and the coarse grid solver uses the new direct solver with LU factorization. [#1291](#1291) [#1327](#1327)
+ The `iteration_complete` event gained a more expressive overload with additional parameters, the old overloads were deprecated. [#1288](#1288) [#1327](#1327)

### Deprecations
+ Deprecated less expressive `iteration_complete` event. Users are advised to now implement the function `void iteration_complete(const LinOp* solver, const LinOp* b, const LinOp* x, const size_type& it, const LinOp* r, const LinOp* tau, const LinOp* implicit_tau_sq, const array<stopping_status>* status, bool stopped)` [#1288](#1288)

### Added Features
+ A distributed Schwarz preconditioner. [#1248](#1248)
+ A GCR solver [#1239](#1239)
+ Flexible Gmres solver [#1244](#1244)
+ Enable Gmres solver for distributed matrices and vectors [#1201](#1201)
+ An example that uses Kokkos to assemble the system matrix [#1216](#1216)
+ A symbolic LU factorization allowing the `gko::experimental::factorization::Lu` and `gko::experimental::solver::Direct` classes to be used for matrices with non-symmetric sparsity pattern [#1210](#1210)
+ A numerical Cholesky factorization [#1215](#1215)
+ Symbolic factorizations in host-side operations are now wrapped in a host-side `Operation` to make their execution visible to loggers. This means that profiling loggers and benchmarks are no longer missing a separate entry for their runtime [#1232](#1232)
+ Symbolic factorization benchmark [#1302](#1302)
+ The `ProfilerHook` logger allows annotating the Ginkgo execution (apply, operations, ...) for profiling frameworks like NVTX, ROCTX and TAU. [#1055](#1055)
+ `ProfilerHook::created_(nested_)summary` allows the generation of a lightweight runtime profile over all Ginkgo functions written to a user-defined stream [#1270](#1270) for both host and device timing functionality [#1313](#1313)
+ It is now possible to enable host buffers for MPI communications at runtime even if the compile option `GINKGO_FORCE_GPU_AWARE_MPI` is set. [#1228](#1228)
+ A stencil matrices generator (5-pt, 7-pt, 9-pt, and 27-pt) for benchmarks [#1204](#1204)
+ Distributed benchmarks (multi-vector blas, SpMV, solver) [#1204](#1204)
+ Benchmarks for CSR sorting and lookup [#1219](#1219)
+ A timer for MPI benchmarks that reports the longest time [#1217](#1217)
+ A `timer_method=min|max|average|median` flag for benchmark timing summary [#1294](#1294)
+ Support for non-default streams in CUDA and HIP executors [#1236](#1236)
+ METIS integration for nested dissection reordering [#1296](#1296)
+ SuiteSparse AMD integration for fillin-reducing reordering [#1328](#1328)
+ Csr mixed-precision SpMV support [#1319](#1319)
+ A `with_loggers` function for all `Factory` parameters [#1337](#1337)

### Improvements
+ Improve naming of kernel operations for loggers [#1277](#1277)
+ Annotate solver iterations in `ProfilerHook` [#1290](#1290)
+ Allow using the profiler hooks and inline input strings in benchmarks [#1342](#1342)
+ Allow passing smart pointers in place of raw pointers to most matrix functions. This means that things like `vec->compute_norm2(x.get())` or `vec->compute_norm2(lend(x))` can be simplified to `vec->compute_norm2(x)` [#1279](#1279) [#1261](#1261)
+ Catch overflows in prefix sum operations, which makes Ginkgo's operations much less likely to crash. This also improves the performance of the prefix sum kernel [#1303](#1303)
+ Make the installed GinkgoConfig.cmake file relocatable and follow more best practices [#1325](#1325)

### Fixes
+ Fix OpenMPI version check [#1200](#1200)
+ Fix the mpi cxx type binding by c binding [#1306](#1306)
+ Fix runtime failures for one-sided MPI wrapper functions observed on some OpenMPI versions [#1249](#1249)
+ Disable thread pinning with GPU executors due to poor performance [#1230](#1230)
+ Fix hwloc version detection [#1266](#1266)
+ Fix PAPI detection in non-implicit include directories [#1268](#1268)
+ Fix PAPI support for newer PAPI versions: [#1321](#1321)
+ Fix pkg-config file generation for library paths outside prefix [#1271](#1271)
+ Fix various build failures with ROCm 5.4, CUDA 12, and OneAPI 6 [#1214](#1214), [#1235](#1235), [#1251](#1251)
+ Fix incorrect read for skew-symmetric MatrixMarket files with explicit diagonal entries [#1272](#1272)
+ Fix handling of missing diagonal entries in symbolic factorizations [#1263](#1263)
+ Fix segmentation fault in benchmark matrix construction [#1299](#1299)
+ Fix the stencil matrix creation for benchmarking [#1305](#1305)
+ Fix the additional residual check in IR [#1307](#1307)
+ Fix the cuSPARSE CSR SpMM issue on single strided vector when cuda >= 11.6 [#1322](#1322) [#1331](#1331)
+ Fix Isai generation for large sparsity powers [#1327](#1327)
+ Fix Ginkgo compilation and test with NVHPC >= 22.7 [#1331](#1331)
+ Fix Ginkgo compilation of 32 bit binaries with MSVC [#1349](#1349)
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. 1:ST:run-full-test mod:core This is related to the core module. reg:build This is related to the build system. reg:example This is related to the examples. type:distributed-functionality type:matrix-format This is related to the Matrix formats type:preconditioner This is related to the preconditioners
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants