Function compile

python/tvm/driver/build_module.py:72–112

Compile an IRModule to a runtime executable. This function serves as a unified entry point for compiling both TIR and Relax modules. It automatically detects the module type and routes to the appropriate build function. Parameters ---------- mod : Union[PrimFunc, IRModule]

(  # pylint: disable=redefined-builtin
    mod: PrimFunc | IRModule,
    target: Target | None = None,
    *,
    relax_pipeline: tvm.transform.Pass | Callable | str | None = "default",
    tir_pipeline: tvm.transform.Pass | Callable | str | None = "default",
)

def compile(  # pylint: disable=redefined-builtin
    mod: PrimFunc | IRModule,
    target: Target | None = None,
    *,
    relax_pipeline: tvm.transform.Pass | Callable | str | None = "default",
    tir_pipeline: tvm.transform.Pass | Callable | str | None = "default",
) -> Executable:
    """
    Compile an IRModule to a runtime executable.

    This function serves as a unified entry point for compiling both TIR and Relax modules.
    It automatically detects the module type and routes to the appropriate build function.

    Parameters
    ----------
    mod : Union[PrimFunc, IRModule]
        The input module to be compiled. Can be a PrimFunc or an IRModule containing
        TIR or Relax functions.
    target : Optional[Target]
        The target platform to compile for.
    relax_pipeline : Optional[Union[tvm.transform.Pass, Callable, str]]
        The compilation pipeline to use for Relax functions.
        Only used if the module contains Relax functions.
    tir_pipeline : Optional[Union[tvm.transform.Pass, Callable, str]]
        The compilation pipeline to use for TIR functions.

    Returns
    -------
    Executable
        A runtime executable that can be loaded and executed.
    """
    # TODO(tvm-team): combine two path into unified one
    if _contains_relax(mod):
        return tvm.relax.build(
            mod,
            target,
            relax_pipeline=relax_pipeline,
            tir_pipeline=tir_pipeline,
        )
    lib = tvm.tirx.build(mod, target, pipeline=tir_pipeline)
    return Executable(lib)