🎨 Keep random seed in bounds

Author: shnizzedy

CPAC/pipeline/random_state/__init__.py

@@ -1,6 +1,6 @@
 '''Random state for C-PAC'''
-from .seed import random_seed, random_seed_flags, set_up_random_state, \
-                  set_up_random_state_logger
+from .seed import MAX_SEED, random_seed, random_seed_flags, \
+                  set_up_random_state, set_up_random_state_logger
 
-__all__ = ['random_seed', 'random_seed_flags', 'set_up_random_state',
-           'set_up_random_state_logger']
+__all__ = ['MAX_SEED', 'random_seed', 'random_seed_flags',
+           'set_up_random_state', 'set_up_random_state_logger']

CPAC/pipeline/random_state/seed.py

@@ -29,6 +29,7 @@
 from CPAC.utils.interfaces.ants import AI
 from CPAC.utils.monitoring.custom_logging import set_up_logger
 
+MAX_SEED = np.iinfo(np.int32).max
 _seed = {'seed': None}
 
 
@@ -45,10 +46,10 @@ def random_random_seed():
 
     Examples
     --------
-    >>> 0 < random_random_seed() <= np.iinfo(np.int32).max
+    >>> 0 < random_random_seed() <= MAX_SEED
     True
     '''
-    return random.randint(1, np.iinfo(np.int32).max)
+    return random.randint(1, MAX_SEED)
 
 
 def random_seed():
@@ -183,7 +184,7 @@ def set_up_random_state(seed):
             seed = random_random_seed()
         if (seed != 'random' and not (
             isinstance(seed, int) and
-            (0 < int(seed) <= np.iinfo(np.int32).max)
+            (0 < int(seed) <= MAX_SEED)
         )):
             raise ValueError('Valid random seeds are positive integers up to '
                              f'2147483647, "random", or None, not {seed}')

CPAC/pipeline/schema.py

@@ -17,11 +17,11 @@
 """Validation schema for C-PAC pipeline configurations"""
 # pylint: disable=too-many-lines
 from itertools import chain, permutations
-import numpy as np
 from voluptuous import All, ALLOW_EXTRA, Any, Capitalize, Coerce, \
                        ExactSequence, ExclusiveInvalid, In, Length, Lower, \
                        Match, Maybe, Optional, Range, Required, Schema
 from CPAC import docs_prefix
+from CPAC.pipeline.random_state.seed import MAX_SEED
 from CPAC.utils.datatypes import ListFromItem
 from CPAC.utils.utils import delete_nested_value, lookup_nested_value, \
                              set_nested_value
@@ -406,7 +406,7 @@ def _changes_1_8_0_to_1_8_1(config_dict):
             'num_participants_at_once': int,
             'random_seed': Maybe(Any(
                 'random',
-                All(int, Range(min=1, max=np.iinfo(np.int32).max)))),
+                All(int, Range(min=1, max=MAX_SEED)))),
             'observed_usage': {
                 'callback_log': Maybe(str),
                 'buffer': Number,

CPAC/registration/__init__.py

@@ -1,17 +1,18 @@
 from .registration import create_fsl_flirt_linear_reg, \
-                         create_fsl_fnirt_nonlinear_reg, \
-                         create_fsl_fnirt_nonlinear_reg_nhp, \
-                         create_register_func_to_anat, \
-                         create_register_func_to_anat_use_T2, \
-                         create_bbregister_func_to_anat, \
-                         create_wf_calculate_ants_warp
+                          create_fsl_fnirt_nonlinear_reg, \
+                          create_fsl_fnirt_nonlinear_reg_nhp, \
+                          create_register_func_to_anat, \
+                          create_register_func_to_anat_use_T2, \
+                          create_bbregister_func_to_anat, \
+                          create_wf_calculate_ants_warp
 
 from .output_func_to_standard import output_func_to_standard
 
-__all__ = ['create_fsl_flirt_linear_reg', \
-           'create_fsl_fnirt_nonlinear_reg', \
-           'create_fsl_fnirt_nonlinear_reg_nhp', \
-           'create_register_func_to_anat', \
-           'create_register_func_to_anat_use_T2', \
-           'create_bbregister_func_to_anat', \
-           'create_wf_calculate_ants_warp']
+__all__ = ['create_fsl_flirt_linear_reg',
+           'create_fsl_fnirt_nonlinear_reg',
+           'create_fsl_fnirt_nonlinear_reg_nhp',
+           'create_register_func_to_anat',
+           'create_register_func_to_anat_use_T2',
+           'create_bbregister_func_to_anat',
+           'create_wf_calculate_ants_warp',
+           'output_func_to_standard']

CPAC/registration/guardrails.py

@@ -194,12 +194,15 @@ def retry_registration_node(registered, registration_node):
     -------
     Node
     """
-    from CPAC.pipeline.random_state.seed import random_seed
+    from CPAC.pipeline.random_state.seed import MAX_SEED, random_seed
     seed = random_seed()
     if registered.endswith('-failed') and isinstance(seed, int):
         retry_node = registration_node.clone(
             name=f'{registration_node.name}-retry')
-        retry_node.seed = seed + 1
+        if seed < MAX_SEED:  # increment random seed
+            retry_node.seed = seed + 1
+        else:  # loop back to minumum seed
+            retry_node.seed = 1
         return retry_node
     return registration_node