torchsparsegradutils 0.2.0__tar.gz → 0.2.1__tar.gz

{torchsparsegradutils-0.2.0/torchsparsegradutils.egg-info → torchsparsegradutils-0.2.1}/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.4
 Name: torchsparsegradutils
-Version: 0.2.0
+Version: 0.2.1
 Summary: A collection of utility functions to work with PyTorch sparse tensors
-Home-page: https://github.com/cai4cai/torchsparsegradutils
-Author: CAI4CAI research group
-Author-email: contact@cai4cai.uk
-License: Apache-2.0
-Keywords: sparse torch utility
+Author-email: CAI4CAI research group <contact@cai4cai.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cai4cai/torchsparsegradutils
+Project-URL: Documentation, https://torchsparsegradutils.readthedocs.io
+Project-URL: Repository, https://github.com/cai4cai/torchsparsegradutils
+Project-URL: Issues, https://github.com/cai4cai/torchsparsegradutils/issues
+Project-URL: Changelog, https://github.com/cai4cai/torchsparsegradutils/releases
+Keywords: sparse,torch,utility
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -28,23 +30,19 @@ Requires-Dist: myst-parser>=2.0.0; extra == "docs"
 Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
 Requires-Dist: matplotlib>=3.5.0; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints>=1.24.0; extra == "docs"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
+Requires-Dist: sphinxcontrib-bibtex>=2.5.0; extra == "docs"
+Requires-Dist: sphinx-gallery>=0.13.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # torchsparsegradutils: Sparsity-preserving gradient utility tools for PyTorch
 
-[![Python tests](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml) [![License](https://img.shields.io/github/license/cai4cai/torchsparsegradutils)](https://github.com/cai4cai/torchsparsegradutils?tab=Apache-2.0-1-ov-file#readme) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI](https://img.shields.io/pypi/v/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) [![Python Versions](https://img.shields.io/pypi/pyversions/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) [![Downloads](https://img.shields.io/pypi/dm/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) ![PyTorch 2.5+](https://img.shields.io/badge/PyTorch-2.5%2B-ee4c2c?logo=pytorch) ![Tested 2.5 / 2.9 / nightly](https://img.shields.io/badge/Tested-2.5%20|%202.9%20|%20nightly-ee4c2c?logo=pytorch) [![Build](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml) [![Docs](https://readthedocs.org/projects/torchsparsegradutils/badge/?version=latest)](https://readthedocs.org/projects/torchsparsegradutils) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![License](https://img.shields.io/github/license/cai4cai/torchsparsegradutils)](LICENSE) [![status](https://joss.theoj.org/papers/6da0e92488d06f70c0a03d0a7cbfba7d/status.svg)](https://joss.theoj.org/papers/6da0e92488d06f70c0a03d0a7cbfba7d)
 
 A comprehensive collection of utility functions to work with PyTorch sparse tensors, ensuring memory efficiency and supporting various sparsity-preserving tensor operations with automatic differentiation. This package addresses fundamental gaps in PyTorch's sparse tensor ecosystem, providing essential operations that preserve sparsity in gradients during backpropagation.
 
@@ -156,7 +154,7 @@ pip install scipy matplotlib pandas tqdm pytest
 
 ## 📊 Performance Benchmarks
 
-Our comprehensive benchmark suite demonstrates significant performance improvements across various sparse operations. All benchmarks were conducted on an NVIDIA GeForce RTX 4090 with PyTorch 2.8.0+cu128. Benchmarks are performed using [Rothberg/cfd2](https://suitesparse-collection-website.herokuapp.com/Rothberg/cfd2) matrix from [SuiteSparse Matrix Collection](https://suitesparse-collection-website.herokuapp.com/)
+Our comprehensive benchmark suite demonstrates significant performance improvements across various sparse operations. All benchmarks were conducted on an NVIDIA GeForce RTX 4090 with PyTorch 2.9.0+cu130. Benchmarks are performed using [Rothberg/cfd2](https://suitesparse-collection-website.herokuapp.com/Rothberg/cfd2) matrix from [SuiteSparse Matrix Collection](https://suitesparse-collection-website.herokuapp.com/)
 
 ![Sparse MM Suite Performance (int32/float32 COO)](torchsparsegradutils/benchmarks/benchmark_visualizations/sparse_mm_suite_performance_int32_float32_coo.png)
 
@@ -543,7 +541,7 @@ For a consistent development environment with GPU support and all dependencies p
 
 **Available Configurations:**
 
-- **`.devcontainer/Dockerfile.stable`** (default): Uses stable PyTorch with CUDA 12.8 support
+- **`.devcontainer/Dockerfile.stable`** (default): Uses stable PyTorch with CUDA 13.0 support
 - **`.devcontainer/Dockerfile.nightly`**: Uses nightly PyTorch builds for latest features
 
 To switch configurations, modify the `dockerfile` field in `.devcontainer/devcontainer.json`:
@@ -555,7 +553,7 @@ To switch configurations, modify the `dockerfile` field in `.devcontainer/devcon
 ```
 
 **What's Included:**
-- **CUDA 12.8**: Full GPU development support with NVIDIA drivers
+- **CUDA 13.0**: Full GPU development support with NVIDIA drivers
 - **Pre-installed Dependencies**: PyTorch, CuPy, JAX, SciPy, and all development tools
 - **VS Code Extensions**: Python, Pylance, Jupyter, GitHub Copilot, and code formatting tools
 - **Development Tools**: pytest, black, flake8, pre-commit hooks

{torchsparsegradutils-0.2.0 → torchsparsegradutils-0.2.1}/README.md

@@ -1,6 +1,6 @@
 # torchsparsegradutils: Sparsity-preserving gradient utility tools for PyTorch
 
-[![Python tests](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml) [![License](https://img.shields.io/github/license/cai4cai/torchsparsegradutils)](https://github.com/cai4cai/torchsparsegradutils?tab=Apache-2.0-1-ov-file#readme) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI](https://img.shields.io/pypi/v/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) [![Python Versions](https://img.shields.io/pypi/pyversions/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) [![Downloads](https://img.shields.io/pypi/dm/torchsparsegradutils.svg)](https://pypi.org/project/torchsparsegradutils/) ![PyTorch 2.5+](https://img.shields.io/badge/PyTorch-2.5%2B-ee4c2c?logo=pytorch) ![Tested 2.5 / 2.9 / nightly](https://img.shields.io/badge/Tested-2.5%20|%202.9%20|%20nightly-ee4c2c?logo=pytorch) [![Build](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/cai4cai/torchsparsegradutils/actions/workflows/python-package.yml) [![Docs](https://readthedocs.org/projects/torchsparsegradutils/badge/?version=latest)](https://readthedocs.org/projects/torchsparsegradutils) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![License](https://img.shields.io/github/license/cai4cai/torchsparsegradutils)](LICENSE) [![status](https://joss.theoj.org/papers/6da0e92488d06f70c0a03d0a7cbfba7d/status.svg)](https://joss.theoj.org/papers/6da0e92488d06f70c0a03d0a7cbfba7d)
 
 A comprehensive collection of utility functions to work with PyTorch sparse tensors, ensuring memory efficiency and supporting various sparsity-preserving tensor operations with automatic differentiation. This package addresses fundamental gaps in PyTorch's sparse tensor ecosystem, providing essential operations that preserve sparsity in gradients during backpropagation.
 
@@ -112,7 +112,7 @@ pip install scipy matplotlib pandas tqdm pytest
 
 ## 📊 Performance Benchmarks
 
-Our comprehensive benchmark suite demonstrates significant performance improvements across various sparse operations. All benchmarks were conducted on an NVIDIA GeForce RTX 4090 with PyTorch 2.8.0+cu128. Benchmarks are performed using [Rothberg/cfd2](https://suitesparse-collection-website.herokuapp.com/Rothberg/cfd2) matrix from [SuiteSparse Matrix Collection](https://suitesparse-collection-website.herokuapp.com/)
+Our comprehensive benchmark suite demonstrates significant performance improvements across various sparse operations. All benchmarks were conducted on an NVIDIA GeForce RTX 4090 with PyTorch 2.9.0+cu130. Benchmarks are performed using [Rothberg/cfd2](https://suitesparse-collection-website.herokuapp.com/Rothberg/cfd2) matrix from [SuiteSparse Matrix Collection](https://suitesparse-collection-website.herokuapp.com/)
 
 ![Sparse MM Suite Performance (int32/float32 COO)](torchsparsegradutils/benchmarks/benchmark_visualizations/sparse_mm_suite_performance_int32_float32_coo.png)
 
@@ -499,7 +499,7 @@ For a consistent development environment with GPU support and all dependencies p
 
 **Available Configurations:**
 
-- **`.devcontainer/Dockerfile.stable`** (default): Uses stable PyTorch with CUDA 12.8 support
+- **`.devcontainer/Dockerfile.stable`** (default): Uses stable PyTorch with CUDA 13.0 support
 - **`.devcontainer/Dockerfile.nightly`**: Uses nightly PyTorch builds for latest features
 
 To switch configurations, modify the `dockerfile` field in `.devcontainer/devcontainer.json`:
@@ -511,7 +511,7 @@ To switch configurations, modify the `dockerfile` field in `.devcontainer/devcon
 ```
 
 **What's Included:**
-- **CUDA 12.8**: Full GPU development support with NVIDIA drivers
+- **CUDA 13.0**: Full GPU development support with NVIDIA drivers
 - **Pre-installed Dependencies**: PyTorch, CuPy, JAX, SciPy, and all development tools
 - **VS Code Extensions**: Python, Pylance, Jupyter, GitHub Copilot, and code formatting tools
 - **Development Tools**: pytest, black, flake8, pre-commit hooks

torchsparsegradutils-0.2.1/docs/source/conf.py

@@ -0,0 +1,187 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+
+# Add the package to the Python path
+sys.path.insert(0, os.path.abspath("../../"))
+
+project = "torchsparsegradutils"
+copyright = "2025, CAI4CAI research group"
+author = "CAI4CAI research group"
+release = "0.2.1"
+version = "0.2.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",  # Automatic documentation from docstrings
+    "sphinx.ext.autosummary",  # Generate autodoc summaries
+    "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
+    "sphinx.ext.viewcode",  # Add links to highlighted source code
+    "sphinx.ext.mathjax",  # Math notation support
+    "sphinx.ext.intersphinx",  # Link to other project's documentation
+    "sphinx.ext.coverage",  # Documentation coverage
+    "sphinx.ext.githubpages",  # GitHub Pages support
+    "sphinx_copybutton",  # Add copy button to code blocks
+    "myst_parser",  # Markdown support
+]
+
+# Autosummary settings
+autosummary_generate = True
+autosummary_imported_members = True
+
+# Napoleon settings for docstring parsing
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
+# Autodoc settings
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
+}
+
+# Intersphinx mapping
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "torch": ("https://pytorch.org/docs/stable/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "jax": ("https://jax.readthedocs.io/en/latest/", None),
+    "cupy": ("https://docs.cupy.dev/en/stable/", None),
+}
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# Source file parsers
+source_suffix = {
+    ".rst": None,
+    ".md": "myst_parser",
+}
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+
+# Theme options
+html_theme_options = {
+    "canonical_url": "",
+    "analytics_id": "",
+    "logo_only": False,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "vcs_pageview_mode": "",
+    "style_nav_header_background": "#2980B9",
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Custom CSS
+html_css_files = [
+    "custom.css",
+]
+
+# HTML title
+html_title = f"{project} v{version}"
+
+# Favicon
+# html_favicon = '_static/favicon.ico'
+
+# Logo
+# html_logo = '_static/logo.png'
+
+# -- Options for LaTeX output ------------------------------------------------
+latex_engine = "pdflatex"
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    "papersize": "letterpaper",
+    # The font size ('10pt', '11pt' or '12pt').
+    "pointsize": "10pt",
+    # Additional stuff for the LaTeX preamble.
+    "preamble": r"""
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{amssymb}
+\usepackage{mathrsfs}
+""",
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    ("index", "torchsparsegradutils.tex", "torchsparsegradutils Documentation", "CAI4CAI research group", "manual"),
+]
+
+# -- Options for manual page output ------------------------------------------
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [("index", "torchsparsegradutils", "torchsparsegradutils Documentation", [author], 1)]
+
+# -- Options for Texinfo output ----------------------------------------------
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        "index",
+        "torchsparsegradutils",
+        "torchsparsegradutils Documentation",
+        author,
+        "torchsparsegradutils",
+        "PyTorch sparse tensor utilities.",
+        "Miscellaneous",
+    ),
+]
+
+# -- Extension configuration -------------------------------------------------
+# Copy button configuration
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
+# Math notation
+mathjax3_config = {
+    "tex": {
+        "inlineMath": [["$", "$"], ["\\(", "\\)"]],
+        "displayMath": [["$$", "$$"], ["\\[", "\\]"]],
+        "processEscapes": True,
+        "processEnvironments": True,
+    },
+    "options": {
+        "ignoreHtmlClass": "tex2jax_ignore",
+        "processHtmlClass": "tex2jax_process",
+    },
+}

torchsparsegradutils-0.2.1/pyproject.toml

@@ -0,0 +1,110 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "torchsparsegradutils"
+version = "0.2.1"
+description = "A collection of utility functions to work with PyTorch sparse tensors"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [
+    {name = "CAI4CAI research group", email = "contact@cai4cai.uk"}
+]
+keywords = ["sparse", "torch", "utility"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "torch>=2.5",
+    "scipy",
+]
+
+[project.optional-dependencies]
+extras = ["jax", "cupy"]
+docs = [
+    "sphinx>=7.0.0",
+    "sphinx-rtd-theme>=1.3.0",
+    "sphinx-copybutton>=0.5.0",
+    "myst-parser>=2.0.0",
+    "sphinx-autobuild>=2021.3.14",
+    "matplotlib>=3.5.0",
+    "sphinx-autodoc-typehints>=1.24.0",
+    "sphinxcontrib-bibtex>=2.5.0",
+    "sphinx-gallery>=0.13.0",
+]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "black",
+    "isort",
+    "flake8",
+]
+
+[project.urls]
+Homepage = "https://github.com/cai4cai/torchsparsegradutils"
+Documentation = "https://torchsparsegradutils.readthedocs.io"
+Repository = "https://github.com/cai4cai/torchsparsegradutils"
+Issues = "https://github.com/cai4cai/torchsparsegradutils/issues"
+Changelog = "https://github.com/cai4cai/torchsparsegradutils/releases"
+
+[tool.setuptools]
+zip-safe = false
+include-package-data = true
+
+[tool.setuptools.packages.find]
+exclude = ["tests*"]
+
+[tool.black]
+line-length = 120
+target-version = ['py310', 'py311', 'py312']
+include = '\.pyi?$'
+exclude = '''
+(
+  /(
+    # exclude a few common directories in the root of the project
+      \.eggs
+    | \.git
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | \.pytype
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+  # also separately exclude other files if needed
+  #| some_file
+)
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 120
+known_first_party = ["torchsparsegradutils"]
+force_grid_wrap = 0
+combine_as_imports = true
+include_trailing_comma = true
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = ["-v"]
+testpaths = [
+    "torchsparsegradutils/tests",
+]
+doctest_optionflags = [
+    "NORMALIZE_WHITESPACE",
+    "IGNORE_EXCEPTION_DETAIL",
+    "ELLIPSIS"
+]
+# Separate command for doctests due to potential issues
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+]

torchsparsegradutils-0.2.1/setup.py

@@ -0,0 +1,5 @@
+# Minimal setup.py for backward compatibility
+# All configuration is now in pyproject.toml
+from setuptools import setup
+
+setup()

torchsparsegradutils-0.2.1/torchsparsegradutils/encoders/__init__.py

@@ -0,0 +1,44 @@
+# Import from the new pairwise_encoder module (recommended)
+from .pairwise_encoder import PairwiseEncoder, calc_pairwise_coo_indices_nd
+
+
+def __getattr__(name):
+    """Lazy-load deprecated aliases to avoid import-time warnings."""
+    if name == "PairwiseVoxelEncoder":
+        # Import without warning here - the class itself will warn when instantiated
+        from .pairwise_voxel_encoder import PairwiseVoxelEncoder
+
+        return PairwiseVoxelEncoder
+    elif name == "calc_pairwise_coo_indices":
+        import warnings
+
+        warnings.warn(
+            "calc_pairwise_coo_indices is deprecated and will be removed in a future version. "
+            "Use calc_pairwise_coo_indices_nd instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from .pairwise_encoder import calc_pairwise_coo_indices
+
+        return calc_pairwise_coo_indices
+    elif name == "calc_pariwise_coo_indices":
+        import warnings
+
+        warnings.warn(
+            "calc_pariwise_coo_indices (typo) is deprecated and will be removed in a future version. "
+            "Use calc_pairwise_coo_indices_nd instead. "
+            "Note: This function name contains a typo; use calc_pairwise_coo_indices for the corrected spelling.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from .pairwise_encoder import calc_pariwise_coo_indices
+
+        return calc_pariwise_coo_indices
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = [
+    # New recommended classes and functions
+    "PairwiseEncoder",
+    "calc_pairwise_coo_indices_nd",
+]

{torchsparsegradutils-0.2.0 → torchsparsegradutils-0.2.1}/torchsparsegradutils/encoders/pairwise_encoder.py

@@ -505,7 +505,7 @@ def calc_pairwise_coo_indices_nd(
     return indices
 
 
-def calc_pariwise_coo_indices(
+def calc_pairwise_coo_indices(
     radius: float,
     volume_shape: Tuple[int, int, int, int],
     diag: bool = False,
@@ -548,13 +548,17 @@ def calc_pariwise_coo_indices(
     """
     # Validate 4D shape for backward compatibility
     if not (len(volume_shape) == 4 and all(isinstance(dim, int) and dim > 0 for dim in volume_shape)):
-        raise ValueError("volume_shape must be a 4D tuple of positive integers for backward compatibility")
+        raise ValueError("`volume_shape` must be a 4D tuple of positive integers, representing [C, H, D, W]")
 
     out = calc_pairwise_coo_indices_nd(radius, volume_shape, diag, upper, channel_voxel_relation, dtype, device)
     # Narrow key type for static checker (all offsets have length 4 here)
     return {tuple(k): v for k, v in out.items()}  # type: ignore[return-value]
 
 
+# Keep the typo version for backward compatibility
+calc_pariwise_coo_indices = calc_pairwise_coo_indices  # type: ignore[misc]
+
+
 class PairwiseEncoder(torch.nn.Module):
     r"""Encode pairwise spatial–channel neighborhoods as sparse tensors.
 

{torchsparsegradutils-0.2.0 → torchsparsegradutils-0.2.1}/torchsparsegradutils/encoders/pairwise_voxel_encoder.py

@@ -3,15 +3,8 @@ from typing import Tuple
 
 import torch
 
-# Deprecation warning for the entire module
-warnings.warn(
-    "The 'pairwise_voxel_encoder' module is deprecated and will be removed in a future version. "
-    "Please use 'pairwise_encoder' instead, which provides the same functionality with support for arbitrary N-dimensional spatial relationships.",
-    DeprecationWarning,
-    stacklevel=2,
-)
-
 # Import everything from the new module for backward compatibility
+from .pairwise_encoder import calc_pariwise_coo_indices  # typo version for backward compatibility
 from .pairwise_encoder import (
     PairwiseEncoder,
     _gen_coords,
@@ -19,8 +12,8 @@ from .pairwise_encoder import (
     _gen_offsets,
     _gen_offsets_nd,
     _trim_nd,
+    calc_pairwise_coo_indices,
     calc_pairwise_coo_indices_nd,
-    calc_pariwise_coo_indices,
 )
 
 
@@ -105,7 +98,7 @@ class PairwiseVoxelEncoder(PairwiseEncoder):
             "PairwiseVoxelEncoder is deprecated and will be removed in a future version. "
             "Use PairwiseEncoder instead, which supports arbitrary N-dimensional spatial relationships.",
             DeprecationWarning,
-            stacklevel=2,
+            stacklevel=3,
         )
 
         # Validate input for backward compatibility