Method get_function_metadata

python/tvm_ffi/module.py:194–239

Get metadata for a function exported from the module. This retrieves metadata for functions exported via c:macro:`TVM_FFI_DLL_EXPORT_TYPED_FUNC` and when c:macro:`TVM_FFI_DLL_EXPORT_INCLUDE_METADATA` is on, which includes type schema information. Parameters

(
        self, name: str, query_imports: bool = False
    )

        return func

    def get_function_metadata(
        self, name: str, query_imports: bool = False
    ) -> dict[str, Any] | None:
        """Get metadata for a function exported from the module.

        This retrieves metadata for functions exported via c:macro:`TVM_FFI_DLL_EXPORT_TYPED_FUNC`
        and when c:macro:`TVM_FFI_DLL_EXPORT_INCLUDE_METADATA` is on, which includes type schema
        information.

        Parameters
        ----------
        name
            The name of the function

        query_imports
            Whether to also query modules imported by this module.

        Returns
        -------
        metadata
            A dictionary containing function metadata. The ``type_schema`` field
            encodes the callable signature.

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

            import tvm_ffi
            from tvm_ffi.core import TypeSchema
            import json

            mod = tvm_ffi.load_module("add_one_cpu.so")
            metadata = mod.get_function_metadata("add_one_cpu")
            schema = TypeSchema.from_json_str(metadata["type_schema"])
            print(schema)  # Shows function signature

        See Also
        --------
        :py:func:`tvm_ffi.get_global_func_metadata`
            Get metadata for global registry functions.

        """
        metadata_str = _ffi_api.ModuleGetFunctionMetadata(self, name, query_imports)
        if metadata_str is None:
            return None
        return json.loads(metadata_str)

    def get_function_doc(self, name: str, query_imports: bool = False) -> str | None:
        """Get documentation string for a function exported from the module.