<!--- Licensed to the Apache Software Foundation (ASF) under one -->
<!--- or more contributor license agreements.  See the NOTICE file -->
<!--- distributed with this work for additional information -->
<!--- regarding copyright ownership.  The ASF licenses this file -->
<!--- to you under the Apache License, Version 2.0 (the -->
<!--- "License"); you may not use this file except in compliance -->
<!--- with the License.  You may obtain a copy of the License at -->

<!---   http://www.apache.org/licenses/LICENSE-2.0 -->

<!--- Unless required by applicable law or agreed to in writing, -->
<!--- software distributed under the License is distributed on an -->
<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
<!--- KIND, either express or implied.  See the License for the -->
<!--- specific language governing permissions and limitations -->
<!--- under the License. -->

# TVM FFI: Open ABI and FFI for Machine Learning Systems

📚 [Documentation](https://tvm.apache.org/ffi/) | 🚀 [Quickstart](https://tvm.apache.org/ffi/get_started/quickstart.html)

Apache TVM FFI is an open ABI and FFI for machine learning systems. It is a minimal, framework-agnostic,
yet flexible open convention with the following systems in mind:

- **Kernel libraries** - ship one wheel to support multiple frameworks, Python versions, and different languages. [[FlashInfer](https://docs.flashinfer.ai/)]
- **Kernel DSLs** - reusable open ABI for JIT and AOT kernel exposure frameworks and runtimes. [[TileLang](https://tilelang.com/)][[cuteDSL](https://docs.nvidia.com/cutlass/latest/media/docs/pythonDSL/cute_dsl_general/compile_with_tvm_ffi.html)]
- **Frameworks and runtimes** - a uniform extension point for ABI-compliant libraries and DSLs. [[PyTorch](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-pytorch)][[JAX](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-jax)][[PaddlePaddle](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-paddle)][[NumPy/CuPy](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-numpy)]
- **ML infrastructure** - out-of-box bindings and interop across languages. [[Python](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-python)][[C++](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-cpp)][[Rust](https://tvm.apache.org/ffi/get_started/quickstart.html#ship-to-rust)][[XGrammar](https://github.com/mlc-ai/xgrammar)]
- **Coding agents** - a unified mechanism for shipping generated code in production.

## Features

- **Stable, minimal C ABI** designed for kernels, DSLs, and runtime extensibility.
- **Zero-copy interop** across PyTorch, JAX, and CuPy using [DLPack protocol](https://data-apis.org/array-api/2024.12/design_topics/data_interchange.html).
- **Compact value and call convention** covering common data types for ultra low-overhead ML applications.
- **Multi-language support** out of the box: Python, C++, and Rust (with a path towards more languages).

These enable broad **interoperability** across frameworks, libraries, DSLs, and agents; the ability to **ship one wheel** for multiple frameworks and Python versions (including free-threaded Python); and consistent infrastructure across environments.

## Getting Started

Install TVM-FFI with pip, uv or from source:

```bash
pip install apache-tvm-ffi
pip install torch-c-dlpack-ext  # compatibility package for torch <= 2.9
```

## Status and Release Versioning

**C ABI stability** is our top priority.

**Status: RFC** Main features are complete and ABI stable. We recognize potential needs for evolution to ensure
it works best for the machine learning systems community, and would like to work together with the
community for such evolution. We plan to stay in the RFC stage for three months from the v0.1.0 release.

Releases during the RFC stage will be `0.X.Y`, where bumps in `X` indicate C ABI-breaking changes
and `Y` indicates other changes. We anticipate the RFC stage will last for three months, then we will start following
[Semantic Versioning](https://packaging.python.org/en/latest/discussions/versioning/)
(`major.minor.patch`) going forward.

## Documentation

Our [documentation site](https://tvm.apache.org/ffi/) includes:

### Get Started

- [Quick Start](https://tvm.apache.org/ffi/get_started/quickstart.html)
- [Stable C ABI](https://tvm.apache.org/ffi/get_started/stable_c_abi.html)

### Guides

- [Export Functions & Classes](https://tvm.apache.org/ffi/guides/export_func_cls.html)
- [Kernel Library Guide](https://tvm.apache.org/ffi/guides/kernel_library_guide.html)

### Concepts

- [ABI Overview](https://tvm.apache.org/ffi/concepts/abi_overview.html)
- [Any](https://tvm.apache.org/ffi/concepts/any.html)
- [Object & Class](https://tvm.apache.org/ffi/concepts/object_and_class.html)
- [Tensor](https://tvm.apache.org/ffi/concepts/tensor.html)
- [Function & Module](https://tvm.apache.org/ffi/concepts/func_module.html)
- [Exception Handling](https://tvm.apache.org/ffi/concepts/exception_handling.html)

### Packaging

- [Python Packaging](https://tvm.apache.org/ffi/packaging/python_packaging.html)
- [Stub Generation](https://tvm.apache.org/ffi/packaging/stubgen.html)
- [C++ Tooling](https://tvm.apache.org/ffi/packaging/cpp_tooling.html)

### Developer Manual

- [Build from Source](https://tvm.apache.org/ffi/dev/source_build.html)
- [Reproduce CI/CD](https://tvm.apache.org/ffi/dev/ci_cd.html)
- [Release Process](https://tvm.apache.org/ffi/dev/release_process.html)
