Implement HyKKT Ruiz Scaling by adhamsi · Pull Request #317 · ORNL/ReSolve

adhamsi · 2025-06-23T21:34:58Z

Description

A module ruiz is added implementing the RuizScaler class to be used for HyKKT.

Closes #330.

Proposed changes

Implements RuizScaler and RuizScalerKernelImpl in CPU, HIP, and CUDA. Recreates the original test. RuizScaler methods take in matrix::Csr and vector::Vector object types to set the matrix and vector data and implements the scale method to perform the scaling in-place.

Checklist

All tests pass. Code tested on
- CPU backend
- CUDA backend
- HIP backend
Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
The new code follows Re::Solve style guidelines.
There are unit tests for the new code.
The new code is documented.
The feature branch is rebased with respect to the target branch.

Further comments

shakedregev

This is getting a segfault for CUDA. Also, fix merge conflicts.

shakedregev · 2025-06-27T14:42:44Z

Ruiz tests are working, but let's fix the perm tests that made it in here.

pelesh

It would be good to design more intuitive and easy to verify unit tests.
More extensive documentation is needed for the class methods.
Matrix/vector objects probably do not need to be unpacked except for passing input to GPU kernels.

resolve/hykkt/ruiz/RuizScalingKernelsCUDA.cu

resolve/hykkt/ruiz/RuizScalingKernelsHIP.hip

resolve/hykkt/ruiz/RuizScalingKernelImpl.hpp

resolve/hykkt/ruiz/RuizScalingKernelsCUDA.cu

tests/unit/hykkt/HykktRuizScalingTests.hpp

resolve/hykkt/ruiz/RuizScalingKernelsCUDA.cu

resolve/hykkt/ruiz/RuizScalingKernelsCPU.cpp

resolve/hykkt/ruiz/RuizScaler.cpp

shakedregev · 2025-07-02T20:26:13Z

Still need to fix the merge conflicts and compile with -D RESOLVE_USE_ASAN=ON to catch memory leaks. Then run the tests normally. If all of them pass, there's no leaks.

resolve/hykkt/ruiz/RuizScaler.cpp

pelesh

Adding couple of comments related to my earlier review.

resolve/hykkt/Permutation.hpp

resolve/hykkt/ruiz/RuizScaler.hpp

adhamsi · 2025-07-03T15:58:01Z

Still need to fix the merge conflicts and compile with -D RESOLVE_USE_ASAN=ON to catch memory leaks. Then run the tests normally. If all of them pass, there's no leaks.

Leaks have now been fixed.

superwhiskers

just some minor suggestions

superwhiskers · 2025-07-08T16:32:02Z

resolve/hykkt/ruiz/RuizScaling.hpp

+      vector::Vector* scaling_vector_;           // Scaling vector data for the current iteration
+      vector::Vector* aggregate_scaling_vector_; // Cumulative scaling vector


these two vectors don't seem like they need to be allocated on the heap

it doesn't seem like this was resolved?

resolve/hykkt/ruiz/RuizScaling.cpp

shakedregev

Long functions should have one argument on each line. Fix merge conflicts. Make sure only the first letter is capital in class names such as Cpu, Cuda, Hip.

adhamsi · 2025-07-09T13:24:37Z

Long functions should have one argument on each line. Fix merge conflicts. Make sure only the first letter is capital in class names such as Cpu, Cuda, Hip.

Can we have the clang formatter handle the long functions?

superwhiskers · 2025-07-09T14:11:34Z

it can, but only if we specified a line length limit, which is something @pelesh didn't want, so you have to manually add the break and then format it again, which will preserve your choice.

pelesh · 2025-07-09T15:16:06Z

Long functions should have one argument on each line. Fix merge conflicts. Make sure only the first letter is capital in class names such as Cpu, Cuda, Hip.

Can we have the clang formatter handle the long functions?

If you break after first function argument clang-format will do the rest for you. In most cases, the editor will do the alignment for you.

We don't enforce line length because we want to have better control of how we code mathematical expressions for readability.

…arams

Stale

shakedregev

Validate the values in J^T

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

* Added the permutation class from hykkt, along with tests. * HyKKT GPU Permutation Kernels (Attempt 2) (#333) * Added the permutation class from hykkt, along with tests. * refactor with base class for perm kernels * add kernel handler to Permutation class to call appropriate functions * add workspace parameter to test * gpu implementations * add PermutationHandler * test for more rows than cols * add documentation for permutation * remove use of linalgworkspace and update permutation constructor * mapIndex test * update signatures * memory handling and cosmetic changes * all functions on host except mapIdx * signature and fix leak * Apply pre-commmit fixes * remove unused variables * remove unused files and members, fix build * Apply pre-commmit fixes * use resolve types * Apply pre-commmit fixes --------- Co-authored-by: shakedregev <[email protected]> Co-authored-by: adhamsi <[email protected]> * set devImpl to null if no GPU backend * Added the permutation class from hykkt, along with tests. * add ruiz scaler and handler * refactor the interfaces and use existing MemoryHandler for reset * update interface * allocate/deallocate scaling vectors * remove handler as middleman * add empty cpu implementation and cmakelists * fix cmakelists * cpu implementation * hip implementation * use resolve matrix and vector types * cuda implementation * ruiz scaling test * fix bugs in kernel implementations * comments in implementation files * fix imports and leak * update comments * Doxygen reference and rename class * use object pointers and update all usage * better ruiz test * merge conflict * remove unused MemoryHandler * change long function names, file name capitalization, remove unused params * include issue * Apply pre-commmit fixes * error handling in constructor if no gpu support available * fix comment * error handling in constructor * reset workspace after each test * Check for J_tr --------- Co-authored-by: shakedregev <[email protected]> Co-authored-by: adhamsi <[email protected]>

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

* Added the permutation class from hykkt, along with tests. * HyKKT GPU Permutation Kernels (Attempt 2) (#333) * Added the permutation class from hykkt, along with tests. * refactor with base class for perm kernels * add kernel handler to Permutation class to call appropriate functions * add workspace parameter to test * gpu implementations * add PermutationHandler * test for more rows than cols * add documentation for permutation * remove use of linalgworkspace and update permutation constructor * mapIndex test * update signatures * memory handling and cosmetic changes * all functions on host except mapIdx * signature and fix leak * Apply pre-commmit fixes * remove unused variables * remove unused files and members, fix build * Apply pre-commmit fixes * use resolve types * Apply pre-commmit fixes --------- Co-authored-by: shakedregev <[email protected]> Co-authored-by: adhamsi <[email protected]> * set devImpl to null if no GPU backend * Added the permutation class from hykkt, along with tests. * add ruiz scaler and handler * refactor the interfaces and use existing MemoryHandler for reset * update interface * allocate/deallocate scaling vectors * remove handler as middleman * add empty cpu implementation and cmakelists * fix cmakelists * cpu implementation * hip implementation * use resolve matrix and vector types * cuda implementation * ruiz scaling test * fix bugs in kernel implementations * comments in implementation files * fix imports and leak * update comments * Doxygen reference and rename class * use object pointers and update all usage * better ruiz test * merge conflict * remove unused MemoryHandler * change long function names, file name capitalization, remove unused params * include issue * Apply pre-commmit fixes * error handling in constructor if no gpu support available * fix comment * error handling in constructor * reset workspace after each test * Check for J_tr --------- Co-authored-by: shakedregev <[email protected]> Co-authored-by: adhamsi <[email protected]>

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

* Added the permutation class from hykkt, along with tests. * Implement HyKKT Ruiz Scaling (#317) * Implement the HyKKT Cholesky module (#350) * SpGEMM for HyKKT (#366) --------- Co-authored-by: superwhiskers <[email protected]> Co-authored-by: Nicholson Koukpaizan <[email protected]> Co-authored-by: Adham Ibrahim <[email protected]> Co-authored-by: kswirydo <[email protected]> Co-authored-by: shakedregev <[email protected]> Co-authored-by: Slaven Peles <[email protected]>

adhamsi marked this pull request as ready for review June 26, 2025 15:50

adhamsi force-pushed the adham/hykkt-ruiz branch from e98f39a to f8257d8 Compare June 26, 2025 20:08

shakedregev requested changes Jun 26, 2025

View reviewed changes

pelesh requested changes Jun 27, 2025

View reviewed changes

adhamsi force-pushed the adham/hykkt-ruiz branch from fde1d6f to a8e4039 Compare June 30, 2025 14:05

pelesh reviewed Jul 1, 2025

View reviewed changes

resolve/hykkt/ruiz/RuizScalingKernelsCUDA.cu Outdated Show resolved Hide resolved

pelesh reviewed Jul 1, 2025

View reviewed changes

resolve/hykkt/ruiz/RuizScalingKernelsCPU.cpp Outdated Show resolved Hide resolved

pelesh reviewed Jul 1, 2025

View reviewed changes

resolve/hykkt/ruiz/RuizScaler.cpp Outdated Show resolved Hide resolved

shakedregev marked this pull request as draft July 2, 2025 20:22

shakedregev force-pushed the hykkt-dev branch from 82c0843 to 2d49ed5 Compare July 2, 2025 20:44

pelesh reviewed Jul 2, 2025

View reviewed changes

resolve/hykkt/ruiz/RuizScaler.cpp Outdated Show resolved Hide resolved

pelesh previously requested changes Jul 2, 2025

View reviewed changes

resolve/hykkt/Permutation.hpp Outdated Show resolved Hide resolved

resolve/hykkt/ruiz/RuizScaler.hpp Outdated Show resolved Hide resolved

resolve/hykkt/ruiz/RuizScaler.hpp Outdated Show resolved Hide resolved

adhamsi force-pushed the hykkt-dev branch from 2d49ed5 to 744822f Compare July 3, 2025 19:09

adhamsi marked this pull request as ready for review July 7, 2025 17:23

superwhiskers requested changes Jul 8, 2025

View reviewed changes

shakedregev force-pushed the hykkt-dev branch from 744822f to c965ea1 Compare July 8, 2025 16:41

shakedregev previously requested changes Jul 8, 2025

View reviewed changes

adhamsi force-pushed the hykkt-dev branch from c965ea1 to 9719c89 Compare July 9, 2025 12:35

adhamsi force-pushed the adham/hykkt-ruiz branch from 56f6931 to 3642584 Compare July 9, 2025 12:38

adhamsi force-pushed the adham/hykkt-ruiz branch from f83aeaf to 988ffec Compare July 10, 2025 12:50

adhamsi marked this pull request as draft July 10, 2025 13:50

adhamsi force-pushed the adham/hykkt-ruiz branch from 1d89d24 to a02f7a7 Compare July 11, 2025 13:43

adhamsi marked this pull request as ready for review July 11, 2025 13:45

adhamsi requested a review from shakedregev July 11, 2025 13:59

adhamsi and others added 11 commits July 25, 2025 11:54

use object pointers and update all usage

73a054b

better ruiz test

5da033a

merge conflict

7a8f6fe

remove unused MemoryHandler

245f009

change long function names, file name capitalization, remove unused p…

1896b3f

…arams

include issue

3ada385

Apply pre-commmit fixes

54d8cb2

error handling in constructor if no gpu support available

4d692d6

fix comment

4817261

error handling in constructor

f5c1f08

reset workspace after each test

28024a8

adhamsi force-pushed the adham/hykkt-ruiz branch from 10b6743 to 28024a8 Compare July 25, 2025 15:55

Merge branch 'hykkt-dev' into adham/hykkt-ruiz

df066e3

shakedregev requested changes Jul 25, 2025

View reviewed changes

Check for J_tr

b6dffba

adhamsi force-pushed the hykkt-dev branch from 24a9378 to 03fb9d9 Compare July 25, 2025 19:01

shakedregev approved these changes Jul 25, 2025

View reviewed changes

shakedregev merged commit eb042f2 into hykkt-dev Jul 25, 2025
9 of 11 checks passed

shakedregev deleted the adham/hykkt-ruiz branch July 25, 2025 19:32

superwhiskers added a commit that referenced this pull request Jul 27, 2025

address the left over comments in #317

8ceabfc

superwhiskers mentioned this pull request Jul 27, 2025

address the remainder of the comments in #317 #349

Merged

9 tasks

shakedregev pushed a commit that referenced this pull request Jul 28, 2025

address the remainder of the comments in #317 (#349)

15785ef

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

nkoukpaizan pushed a commit that referenced this pull request Sep 4, 2025

address the remainder of the comments in #317 (#349)

3f577fc

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

shakedregev pushed a commit that referenced this pull request Nov 13, 2025

address the remainder of the comments in #317 (#349)

6f9f69c

* address the left over comments in #317 * Apply pre-commmit fixes --------- Co-authored-by: superwhiskers <[email protected]>

		vector::Vector* scaling_vector_; // Scaling vector data for the current iteration
		vector::Vector* aggregate_scaling_vector_; // Cumulative scaling vector

Comments

Conversation

adhamsi commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Proposed changes

Checklist

Further comments

Uh oh!

shakedregev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shakedregev commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shakedregev commented Jul 2, 2025

Uh oh!

Uh oh!

pelesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adhamsi commented Jul 3, 2025

Uh oh!

superwhiskers left a comment

Choose a reason for hiding this comment

Uh oh!

superwhiskers Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

superwhiskers Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shakedregev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adhamsi commented Jul 9, 2025

Uh oh!

superwhiskers commented Jul 9, 2025

Uh oh!

pelesh commented Jul 9, 2025

Uh oh!

shakedregev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adhamsi commented Jun 23, 2025 •

edited

Loading

shakedregev left a comment •

edited

Loading

shakedregev commented Jun 27, 2025 •

edited

Loading

shakedregev left a comment •

edited

Loading