Skip to main content
Ctrl+K

tvm-ffi

Get Started

  • Quick Start
  • Stable C ABI

Guides

  • Export Functions and Classes
  • Dataclass-Style Reflection
  • Kernel Library Guide
  • Compiler Integration
  • CUBIN Launcher Guide
  • Python Guide
  • C++ Guide
  • Rust Guide

Concepts

  • ABI Overview
  • Any and AnyView
  • Containers
  • Object and Class
  • Tensor and DLPack
  • Function and Module
  • Exception Handling
  • Structural Equality, Hashing, and Walk

Packaging

  • Python Packaging
  • Stub Generation
  • C++ Tooling

Reference

  • Python API
    • tvm_ffi.Object
    • tvm_ffi.Tensor
    • tvm_ffi.from_dlpack
    • tvm_ffi.Shape
    • tvm_ffi.dtype
    • tvm_ffi.Device
    • tvm_ffi.DLDeviceType
    • tvm_ffi.device
    • tvm_ffi.Function
    • tvm_ffi.Module
    • tvm_ffi.system_lib
    • tvm_ffi.load_module
    • tvm_ffi.Array
    • tvm_ffi.Map
    • tvm_ffi.StructuralKey
    • tvm_ffi.StructuralVisitor
    • tvm_ffi.VisitInterrupt
    • tvm_ffi.WalkOrder
    • tvm_ffi.WalkResult
    • tvm_ffi.get_first_structural_mismatch
    • tvm_ffi.structural_equal
    • tvm_ffi.structural_hash
    • tvm_ffi.structural_walk
    • tvm_ffi.register_error
    • tvm_ffi.register_object
    • tvm_ffi.register_global_func
    • tvm_ffi.get_global_func
    • tvm_ffi.get_global_func_metadata
    • tvm_ffi.init_ffi_api
    • tvm_ffi.remove_global_func
    • tvm_ffi.StreamContext
    • tvm_ffi.use_torch_stream
    • tvm_ffi.use_raw_stream
    • tvm_ffi.get_raw_stream
    • tvm_ffi.cpp.load_inline
    • tvm_ffi.cpp.build_inline
    • tvm_ffi.cpp.load
    • tvm_ffi.cpp.build
    • tvm_ffi.libinfo.load_lib_module
    • tvm_ffi.cpp.nvrtc.nvrtc_compile
    • tvm_ffi.serialization.from_json_graph_str
    • tvm_ffi.serialization.to_json_graph_str
    • tvm_ffi.access_path.AccessKind
    • tvm_ffi.access_path.AccessPath
    • tvm_ffi.access_path.AccessStep
    • tvm_ffi.convert
    • tvm_ffi.convert_func
    • tvm_ffi.ObjectConvertible
  • C++ API
  • Rust API

Developer Manual

  • Build from Source
  • Build This Doc Site
  • Reproduce CI/CD
  • Release Process
  • .rst

File optional.h

Contents

  • Definition (tvm/ffi/optional.h)
  • Detailed Description
  • Includes
  • Included By
  • Namespaces

File optional.h#

↰ Parent directory (tvm/ffi)

Runtime Optional container types.

Contents

  • Definition (tvm/ffi/optional.h)

  • Detailed Description

  • Includes

  • Included By

  • Namespaces

Definition (tvm/ffi/optional.h)#

  • Program Listing for File optional.h

Detailed Description#

Optional<T> specializes for T is ObjectRef and used nullptr to indicate nullopt.

Includes#

  • optional (File optional.h)

  • string (File string.h)

  • tvm/ffi/error.h (File error.h)

  • tvm/ffi/object.h (File object.h)

  • tvm/ffi/string.h (File string.h)

  • utility

Included By#

  • File cast.h

  • File array.h

  • File dict.h

  • File map.h

  • File map_base.h

  • File variant.h

  • File dataclass.h

  • File structural_equal.h

  • File structural_visit.h

  • File visit_error_context.h

  • File overload.h

  • File registry.h

  • File tvm_ffi.h

Namespaces#

  • Namespace tvm

  • Namespace tvm::ffi

Contents
  • Definition (tvm/ffi/optional.h)
  • Detailed Description
  • Includes
  • Included By
  • Namespaces

By Apache TVM FFI contributors

Last updated on Jun 17, 2026.

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.