Features/1448 Refactor random module #1508

mrfh92 · 2024-06-03T13:38:52Z

Due Diligence

General:
- title of the PR is suitable to appear in the Release Notes
Implementation:
- unit tests: all split configurations tested
- unit tests: multiple dtypes tested
- documentation updated where needed

Description

Issue/s resolved: #1448

Changes proposed:

default RNG is now "Batchparallel", i.e. choose a global seed, get process-local seeds by "global seed + rank" on each MPI-rank, use torch's RNG with these local seeds
existing Threefry RNG can be used as user-specified option using set_state(...).

Type of change

should not break existing applications as far as they do not rely on strong reproducibility ensured by Threefry but not batchparallel RNG

Performance

likely to improve performance of random number generation compared to existing solution

Does this change modify the behaviour of other functions? If so, which?

yes, everything related to or using randomness in Heat

commented out check for size < 2*maxint32

…fast

mrfh92 · 2024-06-03T13:41:56Z

@ClaudiaComito @JuanPedroGHM @mtar @Markus-Goetz What do you think about the alternative approach to generate random arrays shown here for randn and rand? Does it do the job or are there any objections?

mrfh92 · 2024-06-03T13:49:33Z

(The error in the other random functions is due to the fact that the way of setting the seed in my new implementation interferes with setting the seed in the other functionality. This would have to be removed if we want to keep the new idea.)

… batchparallel RNG

mrfh92 · 2024-06-28T15:05:48Z

still to be done: figure out influence of proposed changes on other functions

github-actions · 2024-06-28T15:07:38Z

Thank you for the PR!

github-actions · 2024-06-28T15:15:24Z

Thank you for the PR!

github-actions · 2024-07-02T12:36:46Z

Thank you for the PR!

github-actions · 2024-07-02T12:36:58Z

Thank you for the PR!

…tead of default 1e-8) as otherwise the test fails

github-actions · 2024-07-02T14:18:45Z

Thank you for the PR!

codecov · 2024-07-02T14:48:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.04%. Comparing base (fea923b) to head (803a016).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1508      +/-   ##
==========================================
+ Coverage   92.00%   92.04%   +0.04%     
==========================================
  Files          83       83              
  Lines       12072    12109      +37     
==========================================
+ Hits        11107    11146      +39     
+ Misses        965      963       -2

Flag	Coverage Δ
unit	`92.04% <100.00%> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-07-05T07:33:41Z

Thank you for the PR!

heat/core/random.py

github-actions · 2024-07-11T13:19:07Z

Thank you for the PR!

github-actions · 2024-07-11T14:11:06Z

Thank you for the PR!

github-actions · 2024-07-15T07:25:07Z

Thank you for the PR!

mtar · 2024-07-15T11:24:49Z

few lines missing coverage

github-actions · 2024-07-15T12:16:41Z

Thank you for the PR!

mrfh92 · 2024-07-15T13:05:33Z

something strange happened with the codecov

github-actions · 2024-07-17T08:55:03Z

Thank you for the PR!

mrfh92 · 2024-07-18T13:38:49Z

@mtar now we have 100% coverage of patch

mtar

Looks fine to me 👌

mtar

Checks fail on older PyTorch versions < 2.0 with IndexError. Needs to be fixed or we merge it after the minimum version has been raised. See #1572

mrfh92 · 2024-07-19T08:03:07Z

@mtar I have created #1573 to solve this problem.

mtar · 2024-07-19T13:37:32Z

CI Bug after #1573 addressed in #1576

github-actions · 2024-07-19T13:56:02Z

Thank you for the PR!

mrfh92 · 2024-07-19T14:49:13Z

@mtar now it workes?

mrfh92 · 2024-07-22T07:24:09Z

@mtar thanks for reviewing 👍

mrfh92 and others added 3 commits April 19, 2024 14:24

Update random.py

aeee831

commented out check for size < 2*maxint32

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

edf77cb

added quick-and-dirty version of rand and randn: rand_fast and randn_…

8258d34

…fast

mrfh92 added PR talk ESAPCA relevant for the ESA-funded project "ESAPCA" labels Jun 3, 2024

mrfh92 self-assigned this Jun 3, 2024

mrfh92 added random enhancement New feature or request labels Jun 3, 2024

mrfh92 removed the PR talk label Jun 10, 2024

Hoppe and others added 2 commits June 28, 2024 16:59

refactoring of random module; Threefry becomes option, new default is…

5dbd7ab

… batchparallel RNG

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

1be81ad

Hoppe added 3 commits July 2, 2024 11:04

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

2970c6e

bugfixes after refactoring of random module

a2896dc

removed a print

629a054

enlarged tolerance in first test of test_fftn_ifftn to atol=1e-7 (ins…

08ec5e7

…tead of default 1e-8) as otherwise the test fails

mrfh92 requested a review from mtar July 3, 2024 13:17

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

d02b9f9

mrfh92 changed the title ~~Features/1448 random arrays of arbitrary size~~ Features/1448 Refactor random module Jul 8, 2024

ClaudiaComito added this to the 1.5.0 milestone Jul 8, 2024

mtar reviewed Jul 9, 2024

View reviewed changes

heat/core/random.py Outdated Show resolved Hide resolved

heat/core/random.py Outdated Show resolved Hide resolved

heat/core/random.py Outdated Show resolved Hide resolved

heat/core/random.py Outdated Show resolved Hide resolved

took @mtar's comments into account

14e5dbe

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

acb1ffe

mrfh92 requested a review from ClaudiaComito July 11, 2024 14:08

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

30db990

mrfh92 requested a review from mtar July 15, 2024 10:27

Hoppe added 2 commits July 15, 2024 14:02

small changes to improve coverage

42ecbe0

small bugfix related to previous changes

520ee89

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

6da046f

mtar approved these changes Jul 19, 2024

View reviewed changes

mtar requested changes Jul 19, 2024

View reviewed changes

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

19c175b

Merge branch 'main' into features/1448-random_arrays_of_arbitrary_size

803a016

mtar approved these changes Jul 22, 2024

View reviewed changes

mrfh92 merged commit b153d30 into main Jul 22, 2024
35 checks passed

mrfh92 deleted the features/1448-random_arrays_of_arbitrary_size branch July 22, 2024 07:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Features/1448 Refactor random module #1508

Features/1448 Refactor random module #1508

mrfh92 commented Jun 3, 2024 •

edited

Loading

mrfh92 commented Jun 3, 2024

mrfh92 commented Jun 3, 2024

mrfh92 commented Jun 28, 2024

github-actions bot commented Jun 28, 2024

github-actions bot commented Jun 28, 2024

github-actions bot commented Jul 2, 2024

github-actions bot commented Jul 2, 2024

github-actions bot commented Jul 2, 2024

codecov bot commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 5, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 15, 2024

mtar commented Jul 15, 2024

github-actions bot commented Jul 15, 2024

mrfh92 commented Jul 15, 2024

github-actions bot commented Jul 17, 2024

mrfh92 commented Jul 18, 2024

mtar left a comment

mtar left a comment •

edited

Loading

mrfh92 commented Jul 19, 2024

mtar commented Jul 19, 2024 •

edited

Loading

github-actions bot commented Jul 19, 2024

mrfh92 commented Jul 19, 2024

mrfh92 commented Jul 22, 2024

Features/1448 Refactor random module #1508

Features/1448 Refactor random module #1508

Conversation

mrfh92 commented Jun 3, 2024 • edited Loading

Due Diligence

Description

Changes proposed:

Type of change

Performance

Does this change modify the behaviour of other functions? If so, which?

mrfh92 commented Jun 3, 2024

mrfh92 commented Jun 3, 2024

mrfh92 commented Jun 28, 2024

github-actions bot commented Jun 28, 2024

github-actions bot commented Jun 28, 2024

github-actions bot commented Jul 2, 2024

github-actions bot commented Jul 2, 2024

github-actions bot commented Jul 2, 2024

codecov bot commented Jul 2, 2024 • edited Loading

Codecov Report

github-actions bot commented Jul 5, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 15, 2024

mtar commented Jul 15, 2024

github-actions bot commented Jul 15, 2024

mrfh92 commented Jul 15, 2024

github-actions bot commented Jul 17, 2024

mrfh92 commented Jul 18, 2024

mtar left a comment

Choose a reason for hiding this comment

mtar left a comment • edited Loading

Choose a reason for hiding this comment

mrfh92 commented Jul 19, 2024

mtar commented Jul 19, 2024 • edited Loading

github-actions bot commented Jul 19, 2024

mrfh92 commented Jul 19, 2024

mrfh92 commented Jul 22, 2024

mrfh92 commented Jun 3, 2024 •

edited

Loading

codecov bot commented Jul 2, 2024 •

edited

Loading

mtar left a comment •

edited

Loading

mtar commented Jul 19, 2024 •

edited

Loading