Closed ftavella closed 9 months ago
We were thinking about adding a new input variable like
find_pin_oscillations(connectivity, samples, initial_conditions, hyperparameters=DEFAULT_HYPERPARAMETERS)
However, we want users to be able to define some of the hyperparams. We will need a function that combines what the user provides with the default values.
Functions affected by this change:
find_pin_oscillations
find_grn_oscillations
pin_hit_rate
grn_hit_rate
(NEW FUNCTION)calculate_oscillatory_status
The current implementation does not allow the user to select the following hyperparameters in
find_pin_oscillations
(find_grn_oscillations
):equilibration_time_multiplier
dimensionless_time
parameter_limits
sampling_scales
sampling_style
solver
abstol
reltol
maxiters
fft_multiplier
simulation_time_multiplier
freq_variation_threshold
power_threshold
amp_variation_threshold
Possible solution
Add a
hyperparameters
input tofind_pin_oscillations
where the user can pass a dictionary with hyperparameters of their choosing. If they are present in the dictionary, use the provided values. If not use the default hyperparameters. It might help defining a package-wideDEFAULT_HYPERPARAMETERS
dictionary that provides these values for the whole package.