[doc] Update container docs with save() function
@@ -54,6 +54,7 @@ The following code creates a test recording and runs a containerized spike sorte
num_channels=64,
num_segments=1
)
+ test_recording = test_recording.save(folder="test-docker-folder")
sorting = ss.run_kilosort3(
recording=test_recording,
@@ -80,6 +81,13 @@ To use a specific image, set either ``docker_image`` or ``singularity_image`` to
output_folder="kilosort3",
singularity_image="spikeinterface/kilosort3-compiled-base:0.1.0")
+
+**NOTE:** the :code:`toy_example()` returns in-memory objects, which are not bound to a file on disk.
+In order to run spike sorting in a container, the recording object MUST be persistent on disk, so that the
+container can reload it. The :code:`save()` function makes the recording persistent on disk, by saving the in-memory
+:code:`test_recording` object to a binary file in the :code:`test-docker-folder` folder.
+
+
Contributing
------------
