feature: rng primitive refactoring #3040

Alexandr-Solovev · 2025-01-10T13:50:35Z

Description

Add a comprehensive description of proposed changes

List associated issue number(s) if exist(s): #6 (for example)

Documentation PR (if needed): #1340 (for example)

Benchmarks PR (if needed): IntelPython/scikit-learn_bench#155 (for example)

PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

I have reviewed my changes thoroughly before submitting this pull request.
I have commented my code, particularly in hard-to-understand areas.
I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
I have added a respective label(s) to PR if I have a permission for that.
I have resolved any merge conflicts that might occur with the base branch.

Testing

I have run it locally and tested the changes extensively.
All CI jobs are green or I have provided justification why they aren't.
I have extended testing suite if new functionality was introduced in this PR.

Performance

I have measured performance for affected algorithms using scikit-learn_bench and provided at least summary table with measured data, if performance change is expected.
I have provided justification why performance has changed or why changes are not expected.
I have provided justification why quality metrics have changed or why changes are not expected.
I have extended benchmarking suite and provided corresponding scikit-learn_bench PR if new measurable functionality was introduced in this PR.

Alexandr-Solovev · 2025-01-10T13:52:07Z

/intelci: run

Alexandr-Solovev · 2025-01-13T12:31:46Z

/intelci: run

Alexandr-Solovev · 2025-01-22T09:33:37Z

/intelci: run

Alexandr-Solovev · 2025-01-22T12:25:39Z

/intelci: run

Alexandr-Solovev · 2025-01-22T15:11:03Z

/intelci: run

Alexandr-Solovev · 2025-01-22T20:53:43Z

/intelci: run

Alexandr-Solovev · 2025-01-23T13:11:52Z

/intelci: run

Alexandr-Solovev · 2025-01-23T13:19:57Z

/intelci: run

cpp/daal/src/algorithms/engines/mrg32k3a/mrg32k3a_batch_container.h

cpp/daal/src/algorithms/engines/mrg32k3a/mrg32k3a_batch_impl.h

cpp/daal/src/externals/service_rng_mkl.h

cpp/daal/src/externals/service_rng_openrng.h

cpp/daal/src/externals/service_rng_ref.h

cpp/oneapi/dal/backend/primitives/rng/dpc_engine_collection.hpp

Alexandr-Solovev · 2025-01-23T15:11:42Z

/intelci: run

Vika-F · 2025-01-24T08:30:39Z

cpp/oneapi/dal/backend/primitives/rng/dpc_engine.hpp

+/// @param[in] queue The SYCL queue used to manage device operations.
+/// @param[in] seed  The initial seed for the random number generator. Defaults to `777`.


Please move those to the constructor's description.

It would be also good to provide the descriptions to every public method, not only to the class.

cpp/oneapi/dal/backend/primitives/rng/dpc_engine.hpp

Vika-F · 2025-01-24T08:59:48Z

cpp/oneapi/dal/backend/primitives/rng/dpc_engine.hpp

+template <typename Type, typename Size, engine_method EngineType>
+void uniform(Size count, Type* dst, dpc_engine<EngineType>& engine_, Type a, Type b) {


Is it necessary to have Size as a template parameter?

Please provide descriptions to all those APIs. Because from the first glance it is not clear which of them are for CPU only.

Vika-F · 2025-01-24T09:16:29Z

cpp/oneapi/dal/backend/primitives/rng/dpc_engine_collection.hpp

+              seed_(seed) {
+        engines_.reserve(count_);
+        for (Size i = 0; i < count_; ++i) {
+            engines_.push_back(dpc_engine<EngineType>(queue, seed_));


This initialization looks meaningless for mt2203. Because different engine_idx should also be provided to have independent sequences of random numbers:
https://www.intel.com/content/www/us/en/docs/onemkl/developer-reference-dpcpp/2023-0/oneapi-mkl-rng-mt2203.html

Vika-F · 2025-01-24T09:24:06Z

cpp/oneapi/dal/backend/primitives/rng/dpc_engine_dpc.cpp

+#define INSTANTIATE_(F, Size, EngineType)                                \
+    template ONEDAL_EXPORT void uniform(sycl::queue& queue,              \
+                                        Size count_,                     \
+                                        F* dst,                          \
+                                        dpc_engine<EngineType>& engine_, \
+                                        F a,                             \
+                                        F b,                             \
+                                        const event_vector& deps);
+


It would be better to just add uniform_without_replacement and shuffle instantiations to this macro.
You'll not need INSTANTIATE_uniform_without_replacement_FLOAT and other similar macros then.

Alexandr-Solovev · 2025-01-24T09:24:42Z

/intelci: run

Vika-F · 2025-01-24T09:24:47Z

cpp/oneapi/dal/backend/primitives/rng/host_engine.hpp

@@ -0,0 +1,132 @@
+/*******************************************************************************
+* Copyright 2021 Intel Corporation


Suggested change

* Copyright 2021 Intel Corporation

* Copyright contributors to the oneDAL project

Vika-F · 2025-01-24T09:26:46Z

cpp/oneapi/dal/backend/primitives/rng/host_engine.hpp

+///
+/// @tparam EngineType The RNG engine type to be used. Defaults to `engine_method::mt2203`.
+///
+/// @param[in] seed  The initial seed for the random number generator. Defaults to `777`.


The came comment as for dpc_engine apply here: need to add descriptions to the methods and functions; need to fix rule of five.

Vika-F · 2025-01-24T09:28:30Z

cpp/oneapi/dal/backend/primitives/rng/test/rng_dpc.cpp

+
+        for (std::int64_t el = 0; el < arr_2_host.get_count(); el++) {
+            // Due to MKL inside generates floats on GPU and doubles on CPU, it makes sense to add minor eps.
+            REQUIRE(abs(val_arr_1_host_ptr[el] - val_arr_2_host_ptr[el]) < 0.1);


Looks like 0.1 is a too big difference.

inc 1

f9c8265

minor fixes

0ce01a6

minor fix

b6e5135

minor fix for macros

91929f3

Alexandr-Solovev added 2 commits January 22, 2025 04:42

add dpc files

50b34e6

minor fix

86d1a8e

Alexandr-Solovev changed the title ~~inc 1~~ feature: rng primitive refactoring Jan 22, 2025

Alexandr-Solovev added the dpc++ Issue/PR related to DPC++ functionality label Jan 22, 2025

fixes

7a31362

Alexandr-Solovev marked this pull request as ready for review January 22, 2025 20:53

Alexandr-Solovev requested review from Alexsandruss and samir-nasibli as code owners January 22, 2025 20:53

Merge branch 'uxlfoundation:main' into dev/asolovev_test_rng_incremental

e850e09

fix for bazel tests

418e741

Vika-F reviewed Jan 23, 2025

View reviewed changes

fix comments

3d44f9e

Vika-F reviewed Jan 24, 2025

View reviewed changes

cpp/oneapi/dal/backend/primitives/rng/dpc_engine.hpp Show resolved Hide resolved

Vika-F reviewed Jan 24, 2025

View reviewed changes

minor fixes and bazel test fixes for fp64

a0e6024

Vika-F reviewed Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: rng primitive refactoring #3040

feature: rng primitive refactoring #3040

Alexandr-Solovev commented Jan 10, 2025 •

edited

Loading

Alexandr-Solovev commented Jan 10, 2025

Alexandr-Solovev commented Jan 13, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 23, 2025

Alexandr-Solovev commented Jan 23, 2025

Alexandr-Solovev commented Jan 23, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025 •

edited

Loading

Alexandr-Solovev commented Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

Vika-F Jan 24, 2025

		/// @param[in] queue The SYCL queue used to manage device operations.
		/// @param[in] seed The initial seed for the random number generator. Defaults to `777`.

		template <typename Type, typename Size, engine_method EngineType>
		void uniform(Size count, Type* dst, dpc_engine<EngineType>& engine_, Type a, Type b) {

		@@ -0,0 +1,132 @@
		/*******************************************************************************
		* Copyright 2021 Intel Corporation

	* Copyright 2021 Intel Corporation
	* Copyright contributors to the oneDAL project

feature: rng primitive refactoring #3040

Are you sure you want to change the base?

feature: rng primitive refactoring #3040

Conversation

Alexandr-Solovev commented Jan 10, 2025 • edited Loading

Description

Alexandr-Solovev commented Jan 10, 2025

Alexandr-Solovev commented Jan 13, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 22, 2025

Alexandr-Solovev commented Jan 23, 2025

Alexandr-Solovev commented Jan 23, 2025

Alexandr-Solovev commented Jan 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vika-F Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Alexandr-Solovev commented Jan 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alexandr-Solovev commented Jan 10, 2025 •

edited

Loading

Vika-F Jan 24, 2025 •

edited

Loading