Flip the order of `set_params()` arguments for `BatchSimulate`

[ntolley]

Currently, BatchSimulate and Optimizer require a set_params() function which accepts a Network object, and a dictionary called param_values which is used to update different parameter values in the network during batch simulation or optimization.

The BatchSimulate class expects the function to be:

def set_params(param_values, net):

Whereas the Optmizer class expects a different order of the arguments:

def set_params(net, param_values):

I propose changing the BatchSimulate class to expect set_params(net, param_values). I think this makes the most sense, and I believe was the original intention since the documentation incorrectly describes the argument in this way:

hnn-core/hnn_core/batch_simulate.py

Line 26 in e27afa9

``set_params(net, params) -> None``

This will require changing the internals of BatchSimulate, as well as updating the tests and associated code tutorial

[Rahul-2k4]

Hi @ntolley ,

I’ve taken a look at this issue and implemented the change by treating it as a clean, intentional API alignment rather than a purely mechanical swap. The approach is to update BatchSimulate so that it consistently calls the set_params callback with the signature (net, param_values), matching both the Optimizer API and the existing documentation.

Concretely, this involves updating the call site in _run_single_sim, adjusting the corresponding test fixtures to reflect the new callback signature, and updating the example script so user-facing code remains correct. Since this is a breaking change for users who provide custom callbacks, I’ve also added a note to doc/whats_new.md under in-progress development changes to make the behavior change explicit.

I’ve kept the scope limited to what’s necessary for this alignment, without adding shims or deprecation logic, as the change was explicitly proposed here. I’ll draft and open the PR shortly please let me know if you’d prefer a different approach or any additional checks.

Thanks!