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 global random seed for deterministic tests #95

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

allrob23
Copy link

@allrob23 allrob23 commented Oct 3, 2024

Description

This PR introduces a global random seed set after imports in the test file. This change aims to make the tests more deterministic and easier to debug by ensuring consistent random behavior across test runs.

Current Issues (Before this PR):

The tests currently use random without setting a fixed seed, which causes several problems :

a. Flaky Tests: Tests sometimes pass and sometimes fail due to different random values;
b. Hard to Reproduce: When a test fails, it's difficult to reproduce the exact conditions;
c. Inconsistent CI/CD: Different CI runs may have different outcomes;
d. Time Wasted: Developers spend time debugging issues that are hard to replicate.

(Im not saying these problems are happening, but they can happen.)

Solution

Set a global random seed right after imports in the test file.

Benefits

a. Reproducibility: All test runs will use the same random values;
b. Easier Debugging: When a test fails, we can easily reproduce the issue;
c. Consistent CI/CD: Every CI run will have the same behavior;
d. Clear Intent: It's immediately obvious that we're using controlled randomness;
e. Time Saved: Less time spent on debugging non-deterministic test failures.

@t-bz
Copy link
Contributor

t-bz commented Oct 4, 2024

I support this change. As torch.rand() is used in one of the tests, I think we should either fix both seeds or limit the code to a single generator. The same change should also be applied to the keras model tests.

@allrob23
Copy link
Author

allrob23 commented Oct 8, 2024

@t-bz Setting the seed for torch.rand is a great idea. I’ve updated the PR to include torch.manual_seed(42) in all tests that use PyTorch. Additionally, I’ve applied a similar approach to the tests for Keras models

@pluflou
Copy link
Collaborator

pluflou commented Dec 20, 2024

Thanks for your contributions @allrob23. Could you rebase and fix the conflicts? There's been some changes to the codebase. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants