Function load

imperative/python/megengine/serialization.py:114–187

r"""Load an object saved with :func:`~.megengine.save` from a file. Args: f: a string of file name or a text file object from which to load. map_location: defines device mapping. See examples for usage. pickle_module: the module to use for pickling. Return:

(f, map_location=None, pickle_module=pickle)

def load(f, map_location=None, pickle_module=pickle):
    r"""Load an object saved with :func:`~.megengine.save` from a file.

    Args:
        f: a string of file name or a text file object from which to load.
        map_location: defines device mapping. See examples for usage.
        pickle_module: the module to use for pickling.

    Return:
        None.

    Note:
       
        If you will call :func:`~.megengine.set_default_device()`, please do it
        before :func:`~.megengine.load()`.

    .. admonition:: If you are using MegEngine with different Python versions
       :class: warning

       Different Python version may use different DEFAULT/HIGHEST pickle protocol.
       If you want to :func:`~megengine.load` the saved object in another Python version,
       please make sure you have used the same protocol.

    .. admonition:: You can select to use ``pickle`` module directly

        This interface is a wrapper of :func:`pickle.load`. If you want to use ``pickle``,
        See :py:mod:`pickle` for more information about how to set ``pickle_protocol``:

        * :py:data:`pickle.HIGHEST_PROTOCOL` - the highest protocol version available.
        * :py:data:`pickle.DEFAULT_PROTOCOL` - the default protocol version used for pickling.

    Examples:

        This example shows how to load tenors to different devices:

        .. code-block::

           import megengine as mge

           # Load tensors to the same device as defined in model.pkl
           mge.load('model.pkl')

           # Load all tensors to gpu0.
           mge.load('model.pkl', map_location='gpu0')

           # Load all tensors originally on gpu0 to cpu0
           mge.load('model.pkl', map_location={'gpu0':'cpu0'})

           # Load all tensors to cpu0
           mge.load('model.pkl', map_location=lambda dev: 'cpu0')

        If you are using a lower version of Python (<3.8),
        you can use other pickle module like ``pickle5`` to load object saved in pickle 5 protocol:

        >>> import pickle5 as pickle  # doctest: +SKIP

        Or you can use ``pickle5`` in this way (only used with this interface)：