import_pickles¶
-
menpo.io.
import_pickles
(pattern, max_pickles=None, shuffle=False, as_generator=False, verbose=False)[source]¶ Import multiple pickle files.
Menpo unambiguously uses
.pkl
as it’s choice of extension for pickle files. Menpo also supports automatic importing of gzip compressed pickle files - matching files with extensionpkl.gz
will be automatically un-gzipped and imported.Note that this is a function returns a
LazyList
. Therefore, the function will return immediately and indexing into the returned list will load the landmarks at run time. If all pickles should be loaded, then simply wrap the returnedLazyList
in a Python list.Parameters: - pattern (str) – The glob path pattern to search for pickles. Every pickle file found to match the glob will be imported one by one.
- max_pickles (positive int, optional) – If not
None
, only import the firstmax_pickles
found. Else, import all. - shuffle (bool, optional) – If
True
, the order of the returned pickles will be randomised. IfFalse
, the order of the returned pickles will be alphanumerically ordered. - as_generator (bool, optional) – If
True
, the function returns a generator and assets will be yielded one after another when the generator is iterated over. - verbose (bool, optional) – If
True
progress of the importing will be dynamically reported.
Returns: lazy_list (
LazyList
or generator of Python objects) – ALazyList
or generator yielding Python objects inside the pickle files found to match the glob pattern provided.Raises: ValueError
– If no pickles are found at the provided glob.