Function save

imperative/python/megengine/serialization.py:9–69

r"""Save an object to disk file. The saved object must be a :class:`~.module.Module`, :attr:`.Module.state_dict` or :attr:`.Optimizer.state_dict`. See :ref:`serialization-guide` for more details. Args: obj: object to be saved. f: a string of file name or a text file

(obj, f, pickle_module=pickle, pickle_protocol=pickle.DEFAULT_PROTOCOL)

def save(obj, f, pickle_module=pickle, pickle_protocol=pickle.DEFAULT_PROTOCOL):
    r"""Save an object to disk file.
    The saved object must be a :class:`~.module.Module`,
    :attr:`.Module.state_dict` or :attr:`.Optimizer.state_dict`.
    See :ref:`serialization-guide` for more details.

    Args:
        obj: object to be saved.
        f: a string of file name or a text file object to which ``obj`` is saved to.
        pickle_module: the module to use for pickling.
        pickle_protocol: the protocol to use for pickling.

    Return:
        None.

    .. 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.dump`. 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:

        If you want to save object in a higher protocol version which current version Python
        not support, you can install other pickle module instead of the build-in one.
        Take ``pickle5`` as an example:

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

        It's a backport of the pickle 5 protocol (PEP 574) and other pickle changes.
        So you can use it to save object in pickle 5 protocol and load it in Python 3.8+.

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

        .. code-block:: python

           import pickle5
           import megengine

           megengine.save(obj, f, pickle_module=pickle5, pickle_protocol=5)

    """
    if isinstance(f, str):
        with open(f, "wb") as fout:
            save(
                obj, fout, pickle_module=pickle_module, pickle_protocol=pickle_protocol
            )
        return