Skip to main content
Ctrl+K

tvm-ffi

Get Started

  • Installation
  • Quick Start

Guides

  • Packaging
  • C++ Guide
  • Python Guide
  • Compiler Integration

Concepts

  • ABI Overview

Reference

  • Python API
    • tvm_ffi.Object
    • tvm_ffi.register_object
    • tvm_ffi.Function
    • tvm_ffi.Module
    • tvm_ffi.register_global_func
    • tvm_ffi.get_global_func
    • tvm_ffi.system_lib
    • tvm_ffi.load_module
    • tvm_ffi.init_ffi_api
    • tvm_ffi.register_error
    • tvm_ffi.convert
    • tvm_ffi.Shape
    • tvm_ffi.Tensor
    • tvm_ffi.Device
    • tvm_ffi.from_dlpack
    • tvm_ffi.Array
    • tvm_ffi.Map
    • tvm_ffi.StreamContext
    • tvm_ffi.use_torch_stream
    • tvm_ffi.use_raw_stream
    • tvm_ffi.cpp.load_inline
    • tvm_ffi.cpp.build_inline
  • C++ API
    • Full API Index
      • Namespace tvm
      • Namespace tvm::ffi
      • Namespace tvm::ffi::json
      • Namespace tvm::ffi::reflection
      • Namespace tvm::ffi::symbol
      • Struct AnyEqual
      • Struct AnyHash
      • Struct DenseMapObj::Block
      • Struct DenseMapObj::ItemType
      • Struct DenseMapObj::ListNode
      • Struct EnvErrorAlreadySet
      • Template Struct FallbackOnlyTraitsBase
      • Template Struct is_valid_iterator
      • Template Struct is_valid_iterator< Any, IterType >
      • Template Struct is_valid_iterator< Optional< T >, IterType >
      • Struct ObjectPtrEqual
      • Struct ObjectPtrHash
      • Template Struct ObjectRefWithFallbackTraitsBase
      • Struct FieldInfoTrait
      • Struct StaticTypeKey
      • Template Struct TypeToFieldStaticTypeIndex
      • Template Struct TypeToRuntimeTypeIndex
      • Struct UnsafeInit
      • Struct TVMFFIAny
      • Struct TVMFFIByteArray
      • Struct TVMFFIErrorCell
      • Struct TVMFFIFieldInfo
      • Struct TVMFFIFunctionCell
      • Struct TVMFFIMethodInfo
      • Struct TVMFFIObject
      • Struct TVMFFIOpaqueObjectCell
      • Struct TVMFFIShapeCell
      • Struct TVMFFITypeAttrColumn
      • Struct TVMFFITypeInfo
      • Struct TVMFFITypeMetadata
      • Class Any
      • Class AnyView
      • Template Class Array
      • Class ArrayObj
      • Class Bytes
      • Class DenseMapObj
      • Class Error
      • Class ErrorObj
      • Class Function
      • Class FunctionObj
      • Template Class Map
      • Class MapObj
      • Class Module
      • Class ModuleObj
      • Class Object
      • Template Class ObjectPtr
      • Class ObjectRef
      • Template Class Optional
      • Class PackedArgs
      • Class AccessPath
      • Class AccessPathObj
      • Class AccessStep
      • Class AccessStepObj
      • Class AttachFieldFlag
      • Class DefaultValue
      • Class FieldGetter
      • Class FieldSetter
      • Class GlobalDef
      • Class ObjectCreator
      • Template Class ObjectDef
      • Class TypeAttrColumn
      • Template Class TypeAttrDef
      • Template Class RValueRef
      • Class Shape
      • Class ShapeObj
      • Class ShapeView
      • Class SmallMapObj
      • Class StrictBool
      • Class String
      • Class StructuralEqual
      • Class StructuralHash
      • Class Tensor
      • Class TensorObj
      • Class TensorView
      • Template Class Tuple
      • Template Class TypedFunction
      • Template Class TypedFunction< R(Args…) >
      • Template Class Variant
      • Template Class WeakObjectPtr
      • Enum DLExtDataTypeCode
      • Enum AccessKind
      • Enum TVMFFIBacktraceUpdateMode
      • Enum TVMFFIFieldFlagBitMask
      • Enum TVMFFIObjectDeleterFlagBitMask
      • Enum TVMFFISEqHashKind
      • Enum TVMFFITypeIndex
      • Function tvm::ffi::Base64Decode(TVMFFIByteArray)
      • Function tvm::ffi::Base64Decode(const String&)
      • Function tvm::ffi::Base64Encode(TVMFFIByteArray)
      • Function tvm::ffi::Base64Encode(const Bytes&)
      • Function tvm::ffi::ByteSwap
      • Template Function tvm::ffi::Concat
      • Function tvm::ffi::DLDataTypeToString
      • Function tvm::ffi::FromJSONGraph
      • Function tvm::ffi::GetDataSize(int64_t, DLDataType)
      • Function tvm::ffi::GetDataSize(const DLTensor&)
      • Template Function tvm::ffi::GetObjectPtr
      • Template Function tvm::ffi::GetRef
      • Function tvm::ffi::IsAligned
      • Function tvm::ffi::IsContiguous
      • Function tvm::ffi::IsDirectAddressDevice
      • Function tvm::ffi::json::Parse
      • Function tvm::ffi::json::Stringify
      • Template Function tvm::ffi::make_inplace_array_object
      • Specialized Template Function tvm::ffi::make_object()
      • Template Function tvm::ffi::make_object(Args&&…)
      • Template Function tvm::ffi::Merge
      • Function tvm::ffi::reflection::EnsureTypeAttrColumn
      • Template Function tvm::ffi::reflection::ForEachFieldInfo
      • Template Function tvm::ffi::reflection::ForEachFieldInfoWithEarlyStop
      • Template Function tvm::ffi::reflection::GetFieldByteOffsetToObject
      • Function tvm::ffi::reflection::GetFieldInfo
      • Function tvm::ffi::reflection::GetMethod
      • Function tvm::ffi::reflection::GetMethodInfo
      • Template Function tvm::ffi::reflection::init
      • Function tvm::ffi::StringToDLDataType
      • Function tvm::ffi::ToJSONGraph
      • Function tvm::ffi::ToStringView
      • Function tvm::ffi::TypeIndexToTypeKey
      • Function tvm::ffi::TypeKeyToIndex
      • Function TVMFFIAnyViewToOwnedAny
      • Function TVMFFIBacktrace
      • Function TVMFFIBytesFromByteArray
      • Function TVMFFIBytesGetByteArrayPtr
      • Function TVMFFIDataTypeFromString
      • Function TVMFFIDataTypeToString
      • Function TVMFFIDLDeviceFromIntPair
      • Function TVMFFIEnvCheckSignals
      • Function TVMFFIEnvGetStream
      • Function TVMFFIEnvGetTensorAllocator
      • Function TVMFFIEnvModLookupFromImports
      • Function TVMFFIEnvModRegisterContextSymbol
      • Function TVMFFIEnvModRegisterSystemLibSymbol
      • Function TVMFFIEnvRegisterCAPI
      • Function TVMFFIEnvSetStream
      • Function TVMFFIEnvSetTensorAllocator
      • Function TVMFFIErrorCreate
      • Function TVMFFIErrorGetCellPtr
      • Function TVMFFIErrorMoveFromRaised
      • Function TVMFFIErrorSetRaised
      • Function TVMFFIErrorSetRaisedFromCStr
      • Function TVMFFIFunctionCall
      • Function TVMFFIFunctionCreate
      • Function TVMFFIFunctionGetCellPtr
      • Function TVMFFIFunctionGetGlobal
      • Function TVMFFIFunctionSetGlobal
      • Function TVMFFIFunctionSetGlobalFromMethodInfo
      • Function TVMFFIGetTypeAttrColumn
      • Function TVMFFIGetTypeInfo
      • Function TVMFFIObjectCreateOpaque
      • Function TVMFFIObjectDecRef
      • Function TVMFFIObjectGetTypeIndex
      • Function TVMFFIObjectIncRef
      • Function TVMFFIOpaqueObjectGetCellPtr
      • Function TVMFFIShapeGetCellPtr
      • Function TVMFFISmallBytesGetContentByteArray
      • Function TVMFFIStringFromByteArray
      • Function TVMFFITensorFromDLPack
      • Function TVMFFITensorFromDLPackVersioned
      • Function TVMFFITensorGetDLTensorPtr
      • Function TVMFFITensorToDLPack
      • Function TVMFFITensorToDLPackVersioned
      • Function TVMFFITypeGetOrAllocIndex
      • Function TVMFFITypeKeyToIndex
      • Function TVMFFITypeRegisterAttr
      • Function TVMFFITypeRegisterField
      • Function TVMFFITypeRegisterMetadata
      • Function TVMFFITypeRegisterMethod
      • Variable tvm::ffi::is_valid_iterator_v
      • Variable tvm::ffi::symbol::tvm_ffi_library_bin
      • Variable tvm::ffi::symbol::tvm_ffi_library_ctx
      • Variable tvm::ffi::symbol::tvm_ffi_main
      • Variable tvm::ffi::symbol::tvm_ffi_metadata_prefix
      • Variable tvm::ffi::symbol::tvm_ffi_symbol_prefix
      • Define TVM_FFI_ALWAYS_LOG_BEFORE_THROW
      • Define TVM_FFI_BACKTRACE_ON_SEGFAULT
      • Define TVM_FFI_CHECK
      • Define TVM_FFI_CHECK_FUNC
      • Define TVM_FFI_CHECK_SAFE_CALL
      • Define TVM_FFI_DECLARE_OBJECT_INFO
      • Define TVM_FFI_DECLARE_OBJECT_INFO_FINAL
      • Define TVM_FFI_DECLARE_OBJECT_INFO_PREDEFINED_TYPE_KEY
      • Define TVM_FFI_DECLARE_OBJECT_INFO_STATIC
      • Define TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE
      • Define TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE
      • Define TVM_FFI_DLL_EXPORT_TYPED_FUNC
      • Define TVM_FFI_ICHECK
      • Define TVM_FFI_ICHECK_BINARY_OP
      • Define TVM_FFI_ICHECK_EQ
      • Define TVM_FFI_ICHECK_GE
      • Define TVM_FFI_ICHECK_GT
      • Define TVM_FFI_ICHECK_LE
      • Define TVM_FFI_ICHECK_LT
      • Define TVM_FFI_ICHECK_NE
      • Define TVM_FFI_ICHECK_NOTNULL
      • Define TVM_FFI_IO_NO_ENDIAN_SWAP
      • Define TVM_FFI_IO_USE_LITTLE_ENDIAN
      • Define TVM_FFI_LOG_AND_THROW
      • Define TVM_FFI_SAFE_CALL_BEGIN
      • Define TVM_FFI_SAFE_CALL_END
      • Define TVM_FFI_THROW
      • Define TVM_FFI_USE_LIBBACKTRACE
      • Define TVM_FFI_WEAK
      • Typedef DLManagedTensorVersioned
      • Typedef DLPackTensorAllocator
      • Typedef tvm::ffi::FObjectDeleter
      • Typedef tvm::ffi::json::Array
      • Typedef tvm::ffi::json::Object
      • Typedef tvm::ffi::json::Value
      • Typedef tvm::ffi::reflection::AccessPathPair
      • Typedef tvm::ffi::TypeIndex
      • Typedef tvm::ffi::TypeInfo
      • Typedef TVMFFIFieldGetter
      • Typedef TVMFFIFieldSetter
      • Typedef TVMFFIObjectCreator
      • Typedef TVMFFIObjectHandle
      • Typedef TVMFFISafeCallType
      • Typedef TVMFFIStreamHandle
  • .rst

tvm_ffi.Function

Contents

  • Function
    • Function.__init__()
    • Function.release_gil

tvm_ffi.Function#

class tvm_ffi.Function#

Bases: Object

Python class that wraps a function with tvm-ffi ABI.

See also

tvm_ffi.register_global_func

How to register global function.

tvm_ffi.get_global_func

How to get global function.

__init__()#

Methods

__init__()

same_as(other)

Check object identity.

Attributes

release_gil

release_gil#

previous

tvm_ffi.register_object

next

tvm_ffi.Module

Contents
  • Function
    • Function.__init__()
    • Function.release_gil

Last updated on Oct 01, 2025.

Copyright © 2025, Apache Software Foundation
  • ASF Homepage
  • License
  • Sponsorship
  • Security
  • Thanks
  • Events
Apache TVM, Apache, the Apache feather, and the Apache TVM project logo are either trademarks or registered trademarks of the Apache Software Foundation.