Merge pull request #2894 from zm711/simple-docs

Add `_params_descriptions` for simple sorter

src/spikeinterface/sorters/internal/simplesorter.py

@@ -46,6 +46,23 @@ class SimpleSorter(ComponentsBasedSorter):
         "job_kwargs": {"n_jobs": -1, "chunk_duration": "1s"},
     }
 
+    _params_description = {
+        "apply_preprocessing": "whether to apply the preprocessing steps, default: False",
+        "waveforms": "A dictonary containing waveforms params: 'ms_before' (peak of spike) default: 1.0, 'ms_after' (peak of spike) deafult: 1.5",
+        "filtering": "A dictionary containing bandpass filter conditions, 'freq_min' default: 300 and 'freq_max' default:8000.0",
+        "detection": (
+            "A dictionary for specifying the detection conditions of 'peak_sign' (pos or neg) default: 'neg', "
+            "'detect_threshold' (snr) default: 5.0, 'exclude_sweep_ms' default: 1.5, 'radius_um' default: 150.0"
+        ),
+        "features": "A dictionary for the PCA specifying the 'n_components, default: 3",
+        "clustering": (
+            "A dictionary for specifying the clustering parameters: 'method' (to cluster) default: 'hdbscan', "
+            "'min_cluster_size' (min number of spikes per cluster) default: 25, 'allow_single_cluster' default: True, "
+            " 'core_dist_n_jobs' (parallelization) default: -1, cluster_selection_method (for hdbscan) default: leaf"
+        ),
+        "job_kwargs": "Spikeinterface job_kwargs (see job_kwargs documentation) default 'n_jobs': -1, 'chunk_duration': '1s'",
+    }
+
     @classmethod
     def get_sorter_version(cls):
         return "1.0"