Function load_module

python/tvm_ffi/module.py:438–477

Load module from file. Parameters ---------- path The path to the module file. keep_module_alive Whether to keep the module alive. If True, the module will be kept alive for the duration of the program until libtvm_ffi.so is unloaded. Returns ------

(path: str | PathLike, keep_module_alive: bool = True)

def load_module(path: str | PathLike, keep_module_alive: bool = True) -> Module:
    """Load module from file.

    Parameters
    ----------
    path
        The path to the module file.

    keep_module_alive
        Whether to keep the module alive. If True, the module will be kept alive
        for the duration of the program until libtvm_ffi.so is unloaded.

    Returns
    -------
    The loaded module

    Examples
    --------
    .. code-block:: python

        import tvm_ffi
        from pathlib import Path

        # Works with string paths
        mod = tvm_ffi.load_module("path/to/module.so")
        # Also works with pathlib.Path objects
        mod = tvm_ffi.load_module(Path("path/to/module.so"))

        mod.func_name(*args)

    See Also
    --------
    :py:class:`tvm_ffi.Module`

    """
    path = fspath(path)
    mod = _ffi_api.ModuleLoadFromFile(path)
    if keep_module_alive:
        _ffi_api.ModuleGlobalsAdd(mod)
    return mod