Install & Compatibility
Where this runs
tested against v0.10.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 307.6MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 13.0s · import 0.000s · 299MB
321MB installed
● package 321MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
EquivariantTensorProduct
✓ from cuequivariance import EquivariantTensorProduct
✗ from cuequivariance.modules import PointCloudTransformer
Irreps
✓ from cuequivariance import Irreps
✗ from cuequivariance.modules import PointCloudTransformer
O3
✓ from cuequivariance import O3
✗ from cuequivariance.modules import PointCloudTransformer
This quickstart demonstrates how to use the PointCloudTransformer module from cuequivariance. It initializes a batch of 3D points and associated features, then processes them through the transformer on a CUDA-enabled GPU. This highlights the library's core functionality for equivariant operations on point cloud data and includes essential runtime CUDA checks.
import torch
from cuequivariance.modules import PointCloudTransformer
# --- Runtime CUDA Check ---
# cuequivariance requires a CUDA-enabled GPU and PyTorch compiled with CUDA support.
if not torch.cuda.is_available():
raise RuntimeError(
"CUDA is not available. cuequivariance requires a CUDA-enabled GPU and PyTorch "
"compiled with CUDA support. Please check your PyTorch installation and CUDA setup."
)
# Ensure PyTorch device is set to CUDA
device = torch.device("cuda")
# --- Example Data Generation ---
batch_size = 1
num_points = 100
input_feature_dim = 64
output_feature_dim = 128
# Input points (batch_size, num_points, 3) - Represents 3D coordinates
points = torch.randn(batch_size, num_points, 3, device=device)
# Input features (batch_size, num_points, input_feature_dim) - Features associated with each point
features = torch.randn(batch_size, num_points, input_feature_dim, device=device)
# --- Initialize and Use a cuequivariance Module ---
# PointCloudTransformer is an example module demonstrating 3D equivariant operations.
transformer = PointCloudTransformer(input_feature_dim, output_feature_dim).to(device)
# Perform the forward pass
output_features = transformer(points, features)
# --- Verify Output ---
print(f"Input points shape: {points.shape}")
print(f"Input features shape: {features.shape}")
print(f"Output features shape: {output_features.shape}")
assert output_features.shape == (batch_size, num_points, output_feature_dim)
print("cuequivariance quickstart example ran successfully!")
Debug
Known issues
gotchacuequivariance is a CUDA-dependent library. It requires a CUDA-enabled GPU, NVIDIA drivers, and the CUDA Toolkit installed on your system for both compilation during `pip install` and for runtime execution. Without a proper CUDA setup, the library will not function and installation may fail.fixEnsure you have a compatible CUDA-enabled GPU. Install the NVIDIA CUDA Toolkit (matching your PyTorch CUDA version if possible) and corresponding GPU drivers. Verify your PyTorch installation is compiled with CUDA support (e.g., `torch.cuda.is_available()` should be `True`).
affects: All versions
gotchaThe library explicitly requires PyTorch version 2.0.0 or newer. Using older PyTorch versions (e.g., < 2.0) will lead to API incompatibilities, compilation failures, or runtime errors.fixUpgrade your PyTorch installation to version 2.0.0 or newer (e.g., `pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118` for CUDA 11.8).
affects: All cuequivariance versions (requires PyTorch >= 2.0.0)
breakingAs the library is currently in version 0.9.x (pre-1.0.0), its API is subject to change without strict backward compatibility guarantees between minor releases. Future updates may introduce breaking changes to module names, class signatures, or function parameters.fixAlways refer to the latest official documentation or release notes when upgrading to new minor versions. Pin your `cuequivariance` version in `requirements.txt` to mitigate unexpected breaking changes in production environments (e.g., `cuequivariance==0.9.1`).
affects: All versions prior to 1.0.0
Upgrade
Version history
0.10.0latest on PyPI · released Apr 22, 2026
Audit
Dependencies
torchrequiredRequired for tensor operations and deep learning framework integration (version >= 2.0.0).
CUDA ToolkitrequiredSystem-level dependency required for CUDA compilation and runtime execution on a GPU.