-
Notifications
You must be signed in to change notification settings - Fork 195
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add loading.py and change load_extractor() to load()
- Loading branch information
Showing
28 changed files
with
225 additions
and
207 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| import warnings | ||
| from pathlib import Path | ||
|
|
||
|
|
||
| from .base import BaseExtractor | ||
| from .core_tools import is_path_remote | ||
|
|
||
|
|
||
| def load(file_or_folder_or_dict, base_folder=None) -> BaseExtractor: | ||
| """ | ||
| General load function to load a SpikeInterface object. | ||
| The function can load: | ||
| - a `Recording` or `Sorting` object from: | ||
| * dictionary | ||
| * json file | ||
| * pkl file | ||
| * binary folder (after `extractor.save(..., format='binary_folder')`) | ||
| * zarr folder (after `extractor.save(..., format='zarr')`) | ||
| * remote zarr folder | ||
| - (TODO) a `SortingAnalyzer` object from : | ||
| * binary folder | ||
| * zarr folder | ||
| * remote zarr folder | ||
| * WaveformExtractor folder | ||
| Parameters | ||
| ---------- | ||
| file_or_folder_or_dict : dictionary or folder or file (json, pickle) | ||
| The file path, folder path, or dictionary to load the extractor from | ||
| base_folder : str | Path | bool (optional) | ||
| The base folder to make relative paths absolute. | ||
| If True and file_or_folder_or_dict is a file, the parent folder of the file is used. | ||
| Returns | ||
| ------- | ||
| extractor: Recording or Sorting | ||
| The loaded extractor object | ||
| """ | ||
| if isinstance(file_or_folder_or_dict, dict): | ||
| assert not isinstance(base_folder, bool), "`base_folder` must be a string or Path when loading from dict" | ||
| return BaseExtractor.from_dict(file_or_folder_or_dict, base_folder=base_folder) | ||
| else: | ||
| file_path = file_or_folder_or_dict | ||
| error_msg = ( | ||
| f"{file_path} is not a file or a folder. It should point to either a json, pickle file or a " | ||
| "folder that is the result of extractor.save(...)" | ||
| ) | ||
| if not is_path_remote(file_path): | ||
| file_path = Path(file_path) | ||
|
|
||
| if base_folder is True: | ||
| base_folder = file_path.parent | ||
|
|
||
| if file_path.is_file(): | ||
| # standard case based on a file (json or pickle) | ||
| if str(file_path).endswith(".json"): | ||
| import json | ||
|
|
||
| with open(file_path, "r") as f: | ||
| d = json.load(f) | ||
| elif str(file_path).endswith(".pkl") or str(file_path).endswith(".pickle"): | ||
| import pickle | ||
|
|
||
| with open(file_path, "rb") as f: | ||
| d = pickle.load(f) | ||
| else: | ||
| raise ValueError(error_msg) | ||
|
|
||
| # this is for back-compatibility since now unserializable objects will not | ||
| # be saved to file | ||
| if "warning" in d: | ||
| print("The extractor was not serializable to file") | ||
| return None | ||
|
|
||
| extractor = BaseExtractor.from_dict(d, base_folder=base_folder) | ||
|
|
||
| elif file_path.is_dir(): | ||
| # this can be and extractor, SortingAnalyzer, or WaveformExtractor | ||
| folder = file_path | ||
| file = None | ||
|
|
||
| if folder.suffix == ".zarr": | ||
| from .zarrextractors import read_zarr | ||
|
|
||
| extractor = read_zarr(folder) | ||
| else: | ||
| # For backward compatibility (v<=0.94) we check for the cached.json/pkl/pickle files | ||
| # In later versions (v>0.94) we use the si_folder.json file | ||
| for dump_ext in ("json", "pkl", "pickle"): | ||
| f = folder / f"cached.{dump_ext}" | ||
| if f.is_file(): | ||
| file = f | ||
|
|
||
| f = folder / f"si_folder.json" | ||
| if f.is_file(): | ||
| file = f | ||
|
|
||
| if file is None: | ||
| raise ValueError(error_msg) | ||
| extractor = BaseExtractor.load(file, base_folder=folder) | ||
|
|
||
| else: | ||
| raise ValueError(error_msg) | ||
| else: | ||
| # remote case - zarr | ||
| if str(file_path).endswith(".zarr"): | ||
| from .zarrextractors import read_zarr | ||
|
|
||
| extractor = read_zarr(file_path) | ||
| else: | ||
| raise NotImplementedError( | ||
| "Only zarr format is supported for remote files and you should provide a path to a .zarr " | ||
| "remote path. You can save to a valid zarr folder using: " | ||
| "`extractor.save(folder='path/to/folder', format='zarr')`" | ||
| ) | ||
|
|
||
| return extractor | ||
|
|
||
|
|
||
| def load_extractor(file_or_folder_or_dict, base_folder=None) -> BaseExtractor: | ||
| warnings.warn( | ||
| "load_extractor() is deprecated and will be removed in the future. Please use load() instead.", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
| return load(file_or_folder_or_dict, base_folder=base_folder) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.