Numbast Documentation

Announcement

Numba-CUDA-MLIR binding generation

Numbast now supports generating bindings for the numba-cuda-mlir backend. See Numba-CUDA-MLIR support for the backend differences and the migration steps for dynamic and static binding generation.

Contents

• Overview
  • What Numbast does
  • How it works
  • Modes of operation
  • Environment assumptions
  • API reference
  • Key Visual
• Quickstart
  • Prerequisites
  • Example: parse and bind CUDA C++ declarations
  • Next steps
• Numba-CUDA-MLIR support
  • Backend differences
  • Dynamic binding generation
  • Static binding generation
  • Notes
• Install
• Install via PyPI (recommended)
• Install via Conda (alternative)
• From source with Pixi (recommended for development)
• Validate the installation (optional)
• Building Documentation
  • Dependencies
  • Build Steps
  • Notes
• Static binding generation
  • When to use
  • Requirements
  • Configuration file
  • Generate the binding
  • Distribute and use
  • Notes and tips
• Config Schema Reference
  • Required keys
  • Optional keys
  • Raw schema
• Dynamic binding generation
  • When to use
  • Requirements
  • Example
  • Struct name overrides
  • External C++ type mappings
  • Class template calls
  • Guidance and best practices
  • Differences vs static generation
• Template calls
  • Class template calls
  • Function template calls
  • Argument deduction
• Argument intents
  • C++ source of truth
  • Example config
  • Intent semantics
  • Generated Python signatures
  • Notes
• Supported declarations
  • Concrete structs and classes
  • Functions and operators
  • Templates
  • Example mapping
  • Qualified names (qual_name)
  • Supported argument types
  • POD struct fields
  • See also
• AST Canopy overview
  • What it provides
  • Primary API
  • Build and tests
  • Folder structure
  • Notes
• FAQ
  • CUDA headers and include paths
  • Clang requirements (host headers and resources)
  • Generated bindings and Numba-CUDA version requirements
  • C++ Enum Binding Generation Notes
• API reference
  • ast_canopy
  • ast_canopy.decl
  • numbast
  • numbast.static