mmengine.fileio.load — mmengine 0.10.7 documentation (original) (raw)

mmengine.fileio.load(file, file_format=None, file_client_args=None, backend_args=None, **kwargs)[source]¶

Load data from json/yaml/pickle files.

This method provides a unified api for loading data from serialized files.

load supports loading data from serialized files those can be storaged in different backends.

Parameters:

• file (str or Path or file-like object) – Filename or a file-like object.
• file_format (str, optional) – If not specified, the file format will be inferred from the file extension, otherwise use the specified one. Currently supported formats include “json”, “yaml/yml” and “pickle/pkl”.
• file_client_args (dict, optional) – Arguments to instantiate a FileClient. See mmengine.fileio.FileClient for details. Defaults to None. It will be deprecated in future. Please usebackend_args instead.
• backend_args (dict, optional) – Arguments to instantiate the prefix of uri corresponding backend. Defaults to None. New in v0.2.0.

Examples

load('/path/of/your/file') # file is storaged in disk load('https://path/of/your/file') # file is storaged in Internet load('s3://path/of/your/file') # file is storaged in petrel

Returns:

The content from the file.