Method get_function_doc

python/tvm_ffi/module.py:241–277

Get documentation string for a function exported from the module. This retrieves documentation for functions exported via c:macro:`TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC`. Parameters ---------- name The name of the function query_imports

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

        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.

        This retrieves documentation for functions exported via c:macro:`TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC`.

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

        query_imports
            Whether to also query modules imported by this module.

        Returns
        -------
        doc : str or None
            The documentation string if available, None otherwise.

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

            import tvm_ffi

            mod = tvm_ffi.load_module("mylib.so")
            doc = mod.get_function_doc("process_batch")
            if doc:
                print(doc)

        See Also
        --------
        :py:meth:`get_function_metadata`
            Get metadata including type schema.

        """
        doc_str = _ffi_api.ModuleGetFunctionDoc(self, name, query_imports)
        return doc_str if doc_str else None

    def import_module(self, module: Module) -> None:
        """Add module to the import list of current one.