Method load_program

runtime/__init__.py:285–334

Loads an ExecuTorch program from a PTE binary. Args: data: The binary program data to load. Can be a file path (str or Path), bytes/bytearray, or a file-like object. verification: Level of program verification to perform (Minimal or InternalConsistenc

(
        self,
        data: Union[bytes, bytearray, BinaryIO, Path, str],
        *,
        verification: Verification = Verification.InternalConsistency,
        enable_etdump: bool = False,
        debug_buffer_size: int = 0,
    )

        self._legacy_module = legacy_module

    def load_program(
        self,
        data: Union[bytes, bytearray, BinaryIO, Path, str],
        *,
        verification: Verification = Verification.InternalConsistency,
        enable_etdump: bool = False,
        debug_buffer_size: int = 0,
    ) -> Program:
        """Loads an ExecuTorch program from a PTE binary.

        Args:
            data: The binary program data to load. Can be a file path (str or Path),
                bytes/bytearray, or a file-like object.
            verification: Level of program verification to perform (Minimal or InternalConsistency).
                Default is InternalConsistency.
            enable_etdump: If True, enables ETDump profiling for runtime performance analysis.
                Default is False.
            debug_buffer_size: Size of the debug buffer in bytes for ETDump data.
                Only used when enable_etdump=True. Default is 0.

        Returns:
            The loaded Program instance.
        """
        if isinstance(data, (Path, str)):
            p = self._legacy_module._load_program(
                str(data),
                enable_etdump=enable_etdump,
                debug_buffer_size=debug_buffer_size,
                program_verification=verification,
            )
            return Program(p, data=None)
        elif isinstance(data, bytes):
            data_bytes = data
        elif isinstance(data, bytearray):
            data_bytes = bytes(data)
        elif hasattr(data, "read"):
            # File-like object with read() method
            data_bytes = data.read()
        else:
            raise TypeError(
                f"Expected data to be bytes, bytearray, a path to a .pte file, or a file-like object, but got {type(data).__name__}."
            )
        p = self._legacy_module._load_program_from_buffer(
            data_bytes,
            enable_etdump=enable_etdump,
            debug_buffer_size=debug_buffer_size,
            program_verification=verification,
        )

        return Program(p, data=data_bytes)