diff --git a/doc/modules/core.rst b/doc/modules/core.rst index 239e42bc3c..ea1052bfd2 100644 --- a/doc/modules/core.rst +++ b/doc/modules/core.rst @@ -361,6 +361,9 @@ examples is seen below: ["random_spikes", "waveforms", "templates", "noise_levels"] ) +Note that any extension entered into the :code:`compute` function will be computed. Thus, even if an extension has already been computed +it will be recomputed when :code:`compute` is called even if the parameters are the same. + It is important when calculating extensions to remember which backend you are using. :code:`compute` accepts an argument :code:`save` which will write results to disk if using the :code:`zarr` or :code:`binary_folder` backends. If your :code:`SortingAnalyzer` is in memory using :code:`save=True` **will not** write to disk since spikeinterface does not know where to save it. diff --git a/examples/tutorials/waveform_extractor_to_sorting_analyzer.rst b/examples/tutorials/waveform_extractor_to_sorting_analyzer.rst index 22e62c837e..dacaa0bf27 100644 --- a/examples/tutorials/waveform_extractor_to_sorting_analyzer.rst +++ b/examples/tutorials/waveform_extractor_to_sorting_analyzer.rst @@ -349,6 +349,9 @@ looks slightly different. Let's calculate these extensions, and also add a param ) Note that if a parent is recomputed, all its children are deleted to maintain data consistency. +Also note that the ``load_if_exists`` semantic that was found in the ``WaveformExtractor`` has +been removed from the ``SortingAnalyzer``. This means that each call to ``compute`` will recompute +and overwrite the previous results. Adjust your scripts according to account for this new behavior. Read more about this, the extensions and their keyword arguments in the `postprocessing module documentation `_