updated example/plot_batch_simulate

doc/api.rst

@@ -95,7 +95,7 @@ Parallel backends (:py:mod:`hnn_core.parallel_backends`):
    JoblibBackend
 
 Batch Simulation (:py:mod:`hnn_core.batch_simulate`):
----------------------------------------------------------
+-----------------------------------------------------
 .. currentmodule:: hnn_core.batch_simulate
 
 .. autosummary::

examples/howto/plot_batch_simulate.py

@@ -13,7 +13,7 @@
 #          Ryan Thorpe <[email protected]>
 #          Mainak Jas <[email protected]>
 
-#############################################################################
+###############################################################################
 # Let us import hnn_core.
 
 import hnn_core
@@ -23,7 +23,7 @@
 
 # The number of cores may need modifying depending on your current machine.
 n_jobs = 10
-###########################################################################
+###############################################################################
 
 
 def set_params(param_values, net=None):
@@ -57,8 +57,8 @@ def set_params(param_values, net=None):
                          weights_ampa=weights_ampa,
                          synaptic_delays=synaptic_delays)
 
-###########################################################################
-
+###############################################################################
+# Define a parameter grid for the batch simulation.
 
 param_grid = {
     'weight_basket': np.logspace(-4 - 1, 5),
@@ -67,6 +67,9 @@ def set_params(param_values, net=None):
     'sigma': np.linspace(1, 20, 5)
 }
 
+###############################################################################
+# Run the batch simulation and collect the results.
+
 batch_simulation = BatchSimulate(set_params=set_params)
 simulation_results = batch_simulation.run(param_grid,
                                           n_jobs=n_jobs,