iron.jit Namespace Reference

Classes
class	NPUKernel
class	NPUKernel_Error

Functions
	jit (function=None, is_placed=True, use_cache=True)
	compile_external_kernel (func, kernel_dir, target_arch)
	hash_module (module, external_kernels=None, target_arch=None)

Variables
	IRON_CACHE_DIR = os.path.expanduser("~/.iron/cache")

Function Documentation

compile_external_kernel()

iron.jit.compile_external_kernel	(		func,
			kernel_dir,
			target_arch
	)

Compile an ExternalFunction to an object file in the kernel directory.

Args:
    func: ExternalFunction instance to compile
    kernel_dir: Directory to place the compiled object file
    target_arch: Target architecture (e.g., "aie2" or "aie2p")

hash_module()

iron.jit.hash_module	(		module,
			external_kernels = None,
			target_arch = None
	)

Hash the MLIR module and ExternalFunction compiler options to create a unique identifier.

jit()

iron.jit.jit	(		function = None,
			is_placed = True,
			use_cache = True
	)

Decorator to compile an IRON kernel into a binary to run on the NPU.

Parameters:
- is_placed (bool): Whether the kernel is using explicit or implicit placement Defaults to True.
- use_cache (bool): Use cached MLIR module if available. Defaults to True.

Variable Documentation

IRON_CACHE_DIR

iron.jit.IRON_CACHE_DIR = os.path.expanduser("~/.iron/cache")