processors.outputs.pickle_candidates

processors.outputs.pickle_candidates(candidates, file)

This will save a CandidateTracks object to disk as a “pickle” file. Due to the way sound objects are handled, only use unpickle_candidates() to re-load the pickle object.

Parameters

Name	Type	Description	Default
candidates	CandidateTracks	A CandidateTracks object to pickle.	required
file	Path | str	The file location to save the pickle file to.	required