Skip to content

Commit

Permalink
add explanation that compute will compute
Browse files Browse the repository at this point in the history
  • Loading branch information
zm711 committed Jul 9, 2024
1 parent e139e75 commit 38fe192
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/modules/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions examples/tutorials/waveform_extractor_to_sorting_analyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html>`_

Expand Down

0 comments on commit 38fe192

Please sign in to comment.