Skip to main content

3D Convolution for Apple Silicon (MPS)

Project description

MPS Conv3D

3D Convolution for Apple Silicon (M1/M2/M3/M4).

Drop-in replacement for torch.nn.functional.conv3d on MPS.

Why?

3D convolutions are essential for video models:

  • Synchformer: Audio-visual synchronization
  • I3D: Video classification
  • SlowFast: Action recognition
  • C3D: Video feature extraction
  • MMAudio: Audio generation from video

But PyTorch's MPS backend doesn't support 3D convolutions:

NotImplementedError: aten::slow_conv3d_forward is not implemented for MPS

This package provides a native Metal implementation.

Installation

pip install mps-conv3d

Or from source:

git clone https://github.com/mpsops/mps-conv3d
cd mps-conv3d
pip install -e .

Quick Start

Patch All Conv3D Operations (Recommended)

from mps_conv3d import patch_conv3d

# Patch at the start of your script
patch_conv3d()

# Now all conv3d operations use MPS!
import torch
import torch.nn.functional as F

x = torch.randn(1, 3, 16, 112, 112, device='mps')
w = torch.randn(64, 3, 3, 7, 7, device='mps')
out = F.conv3d(x, w, padding=(1, 3, 3))  # Uses MPS!

Direct Usage

import torch
from mps_conv3d import conv3d

x = torch.randn(1, 3, 16, 112, 112, device='mps')
w = torch.randn(64, 3, 3, 7, 7, device='mps')

out = conv3d(x, w, stride=1, padding=(1, 3, 3))

Conv3d Module

from mps_conv3d import Conv3d

conv = Conv3d(
    in_channels=3,
    out_channels=64,
    kernel_size=(3, 7, 7),
    stride=(1, 2, 2),
    padding=(1, 3, 3)
).to('mps')

x = torch.randn(1, 3, 16, 112, 112, device='mps')
out = conv(x)

API Reference

conv3d(input, weight, bias, stride, padding, dilation, groups)

Same signature as torch.nn.functional.conv3d.

Parameter Type Description
input Tensor Input tensor (N, C_in, D, H, W)
weight Tensor Weight tensor (C_out, C_in/groups, kD, kH, kW)
bias Tensor Optional bias (C_out,)
stride int/tuple Stride of convolution
padding int/tuple Padding added to input
dilation int/tuple Dilation of kernel
groups int Number of groups

patch_conv3d()

Monkey-patches torch.nn.functional.conv3d to use MPS implementation for MPS tensors.

unpatch_conv3d()

Restores original torch.nn.functional.conv3d.

Compatibility

  • PyTorch: 2.0+
  • macOS: 12.0+ (Monterey)
  • Hardware: Apple Silicon (M1/M2/M3/M4)

Features

  • Full forward and backward pass (training supported)
  • fp32 and fp16 supported
  • Groups and dilation supported
  • Drop-in compatible with PyTorch API

License

MIT

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

mps_conv3d-0.1.5-cp314-cp314-macosx_15_0_arm64.whl (90.6 kB view details)

Uploaded CPython 3.14macOS 15.0+ ARM64

File details

Details for the file mps_conv3d-0.1.5-cp314-cp314-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for mps_conv3d-0.1.5-cp314-cp314-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 4c4742bd43ff11c4e87446ebe708fde956919c7d671a96ba5c4f176ba27e1c19
MD5 2cfe34e2c1cb8edc206aa22c55b5b612
BLAKE2b-256 ef864ec9b88a9a081cb8782ec0c2a7eae44605252a2f3904a02d9821939d59aa

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