Skip to main content

CUDA kernels for machine learning systems optimization

Project description

kernel-craft Python API

CUDA convolution kernels exposed to Python with numpy and PyTorch support.

Installation

Option 1: pip (recommended for users)

pip install kernel-craft

Requires:

  • Python 3.11 - 3.12
  • numpy >= 1.20
  • CUDA runtime (for GPU execution)

Option 2: Build with Python (recommended for distribution)

cd src/python
python -m build

The .so file will be at src/python/build/kernel_craft_python.cpython-*.so.

Option 3: Build with CMake

cd /path/to/kernel-craft
mkdir build && cd build
cmake ..
make kernel_craft_python

The module will be at src/python/build/kernel_craft_python.cpython-*.so.

Usage

import sys
sys.path.insert(0, 'src/python/build')

import kernel_craft_python as kc
import numpy as np

# Input: 2D float32 numpy array
input = np.random.randn(256, 256).astype(np.float32)
kernel = np.random.randn(3, 3).astype(np.float32)

# Naive convolution
out = kc.conv_naive(input, kernel)  # -> np.ndarray

# Tiled convolution with configurable tile size
out = kc.conv_tiled(input, kernel, tile_w=8, tile_h=8)  # -> np.ndarray

Version

import kernel_craft
print(kernel_craft.__version__)  # "0.1.1"

Or via the module directly:

import kernel_craft_python as kc
print(kc.__version__)  # "0.1.1"

PyTorch Tensors

import torch
import kernel_craft_python as kc

# Input: 2D float32 PyTorch tensor on CUDA
input = torch.rand(256, 256, dtype=torch.float32, device='cuda')
kernel = torch.rand(3, 3, dtype=torch.float32, device='cuda')

# Naive convolution
out = kc.conv_naive(input, kernel)  # -> torch.Tensor on GPU

# Tiled convolution
out = kc.conv_tiled(input, kernel, tile_w=16, tile_h=16)  # -> torch.Tensor on GPU

API Reference

Function Input Type Output Type
conv_naive(input, kernel) np.ndarray or Tensor np.ndarray or Tensor
conv_tiled(input, kernel, tile_w, tile_h) np.ndarray or Tensor np.ndarray or Tensor

Parameters

  • input: Input image (2D, float32)
  • kernel: Convolution kernel (2D, float32, odd dimension)
  • tile_w: Tile width for tiled convolution (default: 8)
  • tile_h: Tile height for tiled convolution (default: 8)

Supported Tile Sizes

  • 8x8 (default, best overall performance)
  • 16x16
  • 32x32

Error Handling

All functions raise RuntimeError with descriptive messages for:

  • Invalid input dimensions (must be 2D)
  • Invalid kernel dimensions (must be 2D, square, odd-sized)
  • Invalid dtype (must be float32)
  • CUDA errors (kernel launch failures, memory errors)

Quick Start with pip

import kernel_craft
import numpy as np

input = np.random.randn(256, 256).astype(np.float32)
kernel = np.random.randn(3, 3).astype(np.float32)

# Works with both import styles
out = kernel_craft.conv_naive(input, kernel)  # Recommended

# Or with the internal module name
import kernel_craft_python as kc
out = kc.conv_tiled(input, kernel, tile_w=8, tile_h=8)

Publishing to PyPI

# Build package
cd src/python
python -m build

# Upload to TestPyPI
twine upload --repository testpypi dist/*

# Upload to PyPI
twine upload dist/*

Requirements

  • Python 3.11 - 3.12
  • numpy >= 1.20
  • CUDA Toolkit (for building, not for installed .so)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kernel_craft-0.1.3.tar.gz (118.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kernel_craft-0.1.3-py3-none-any.whl (117.2 kB view details)

Uploaded Python 3

File details

Details for the file kernel_craft-0.1.3.tar.gz.

File metadata

  • Download URL: kernel_craft-0.1.3.tar.gz
  • Upload date:
  • Size: 118.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for kernel_craft-0.1.3.tar.gz
Algorithm Hash digest
SHA256 73123d790fe7d7e336a9a1ad8c335c47e2271f96fddd4765e5c77e2fffb03c7f
MD5 6a0774ba56879955f3b208b9c74d2448
BLAKE2b-256 ddae8a6787d1746cd177df3c85807e140659f9493776511ff78b4366c5a32762

See more details on using hashes here.

File details

Details for the file kernel_craft-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: kernel_craft-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 117.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for kernel_craft-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ee5d70d569d3d8c496f4be881dec4c19b2e6687f17caf78d1bae4d336b93c570
MD5 29e455d1b27004da45f58faccfa3dd52
BLAKE2b-256 cfa9830a7e13af5032304fea2d51b2f4f7ba5abebd4804846dbd4644d78689c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page