nispace.io.from_pickle

nispace.io.from_pickle(filepath, use_dill=False)[source]

Unpickle a python object saved with to_pickle().

Parameters:
  • filepath (str) – Path to a .pkl, .pkl.gz, or .pkl.blosc file (extension determines the decompression method used).

  • use_dill (bool, default False) – Whether to unpickle with dill instead of the standard pickle module; must match what was used to save the file.

Returns:

The unpickled python object.

Return type:

object

Raises:

ValueError – If filepath’s extension is not one of the supported formats.