gswarp 1.0.2__tar.gz

gswarp-1.0.2/LICENSE

@@ -0,0 +1,184 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed by
+their Contribution(s) alone or by combination of their Contribution(s) with the
+Work to which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent
+licenses granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability to
+use the Work (including but not limited to damages for loss of goodwill, work
+stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the
+possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright 2025 gswarp contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

gswarp-1.0.2/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include NOTICE
+include README.md
+include README_zh.md
+include pyproject.toml
+recursive-include gswarp *.py
+recursive-exclude gswarp __pycache__ *.py[cod]

gswarp-1.0.2/NOTICE

@@ -0,0 +1,21 @@
+gswarp
+Copyright 2025 gswarp contributors
+
+This project is distributed under the Apache License 2.0.
+
+Third-party attribution and scope notes:
+
+- NVIDIA Warp is an external dependency used as the GPU kernel runtime.
+  NVIDIA Warp is licensed under Apache License 2.0.
+
+- This repository is intended to be an independent implementation of a
+  differentiable Gaussian rasterization backend compatible with 3D Gaussian
+  Splatting style pipelines. No source code from graphdeco-inria/
+  gaussian-splatting is intentionally included in this repository.
+
+- The tight AABB tile-culling approach is inspired by published research ideas.
+  No source code, figures, or paper text from that work are included here.
+
+If any file in this repository is later found to contain copied third-party
+code, that file remains subject to the original upstream license and must be
+handled separately.

gswarp-1.0.2/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: gswarp
+Version: 1.0.2
+Summary: Pure-Python NVIDIA Warp backend for 3D Gaussian Splatting
+Author: GSWarp contributors
+License-Expression: Apache-2.0
+Keywords: 3dgs,gaussian-splatting,warp,rasterization,pytorch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: torch>=2.0
+Requires-Dist: warp-lang>=1.12.0
+Dynamic: license-file
+
+# gswarp
+
+**English** · [中文](README_zh.md)
+
+gswarp is a pure-Python **NVIDIA Warp** backend for 3D Gaussian Splatting, reimplementing the three core CUDA modules used in 3DGS training — the rasterizer, SSIM loss, and KNN initialization. No C++/CUDA compilation required; install via pip and swap out the original CUDA implementations directly.
+
+> **License**: [Apache License 2.0](LICENSE). Third-party attributions in [NOTICE](NOTICE).
+
+---
+
+## Table of Contents
+
+- [Three Replacement Modules](#three-replacement-modules)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Replacing CUDA Backends in a 3DGS Project](#replacing-cuda-backends-in-a-3dgs-project)
+  - [Rasterizer](#rasterizer)
+  - [SSIM](#ssim)
+  - [KNN](#knn)
+  - [Recommended: Replace All at Once](#recommended-replace-all-at-once)
+- [Performance](#performance)
+- [Quality Metrics](#quality-metrics)
+- [Detailed Documentation](#detailed-documentation)
+- [Acknowledgements](#acknowledgements)
+
+---
+
+## Three Replacement Modules
+
+| Module | Replaces | Import Path | Notes |
+|--------|----------|-------------|-------|
+| **Rasterizer** | `diff_gaussian_rasterization` | `gswarp` | Full differentiable Gaussian rasterization + auto-tuning |
+| **SSIM** | `fused_ssim` | `gswarp.fused_ssim` | Separable Gaussian convolution with launch caching |
+| **KNN** | `simple_knn` | `gswarp.knn` | Morton-sort + bounding-box pruning 3-NN |
+
+---
+
+## Requirements
+
+| Component | Minimum |
+|-----------|---------|
+| Python | 3.10+ |
+| NVIDIA GPU | Compute capability ≥ 7.0 (Volta) |
+| PyTorch | 2.0+ (with CUDA support) |
+| NVIDIA Warp | 1.12.0+ |
+
+---
+
+## Installation
+
+```bash
+pip install gswarp
+```
+
+This installs `warp-lang` automatically via package dependencies. If you want to pin the Warp version explicitly, use:
+
+```bash
+pip install "warp-lang>=1.12.0" gswarp
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/fancifulland2718/gswarp.git
+cd gswarp
+pip install .
+```
+
+No compilation steps are needed after installation. The first call to any Warp kernel triggers JIT compilation (a few seconds); subsequent runs use the cache.
+
+---
+
+## Replacing CUDA Backends in a 3DGS Project
+
+The examples below follow the [gaussian-splatting](https://github.com/graphdeco-inria/gaussian-splatting) reference implementation.
+
+### Rasterizer
+
+Original (`gaussian_renderer/__init__.py`):
+
+```python
+from diff_gaussian_rasterization import (
+    GaussianRasterizationSettings,
+    GaussianRasterizer,
+)
+```
+
+Replace with:
+
+```python
+from gswarp import (
+    GaussianRasterizationSettings,
+    GaussianRasterizer,
+)
+```
+
+`GaussianRasterizationSettings` is a `NamedTuple` with the same fields as the original (Warp-specific fields have defaults). `GaussianRasterizer.forward()` returns **additional outputs** compared to the original:
+
+```python
+# Original CUDA:
+color, radii = rasterizer(means3D=..., means2D=..., ...)
+
+# gswarp:
+color, radii, depth, alpha, proj_2D, conic_2D, conic_2D_inv, \
+    gs_per_pixel, weight_per_gs_pixel, x_mu = rasterizer(...)
+# Extra outputs can be ignored when only color and radii are needed
+```
+
+**Optional runtime configuration** (call once before the training loop):
+
+```python
+from gswarp import initialize_runtime_tuning, set_binning_sort_mode
+
+# Detect GPU and select optimal block_dim automatically (recommended)
+initialize_runtime_tuning(device="cuda:0", verbose=True)
+
+# Choose a sort mode (default warp_depth_stable_tile is usually best)
+set_binning_sort_mode("warp_depth_stable_tile")  # recommended for large scenes
+# set_binning_sort_mode("warp_radix")            # alternative
+# set_binning_sort_mode("torch")                 # fallback
+```
+
+### SSIM
+
+Original (`train.py`):
+
+```python
+from fused_ssim import fused_ssim
+```
+
+Replace with:
+
+```python
+from gswarp.fused_ssim import fused_ssim
+```
+
+The function signature is identical:
+
+```python
+loss_ssim = fused_ssim(img1, img2, padding="same", train=True)
+```
+
+### KNN
+
+Original (`scene/gaussian_model.py`):
+
+```python
+from simple_knn._C import distCUDA2
+```
+
+Replace with:
+
+```python
+from gswarp.knn import distCUDA2
+```
+
+The function signature is identical:
+
+```python
+dist2 = distCUDA2(points)  # points: (N, 3) float32 CUDA tensor
+```
+
+### Recommended: Replace All at Once
+
+Add the following near the top of `train.py`:
+
+```python
+try:
+    from gswarp import GaussianRasterizationSettings, GaussianRasterizer
+    from gswarp.fused_ssim import fused_ssim
+    from gswarp.knn import distCUDA2
+    GSWARP_AVAILABLE = True
+except ImportError:
+    GSWARP_AVAILABLE = False
+```
+
+Then switch backends at each usage site using the `GSWARP_AVAILABLE` flag. A reference integration is available in [gaussian-splatting/train.py](https://github.com/graphdeco-inria/gaussian-splatting/blob/main/train.py).
+
+---
+
+## Performance
+
+Results from full 30K-step training on 12 standard 3DGS datasets. Hardware: RTX 5090D V2 (sm_120, 24 GiB), Python 3.14, PyTorch 2.11.0+cu130, Warp 1.12.0. **All three modules use the Warp backend**, with Python-layer overhead optimizations applied.
+
+| Dataset | CUDA (it/s) | Warp (it/s) | Speedup |
+|---------|------------|------------|---------|
+| chair | 103.6 | 113.1 | ×1.09 |
+| drums | 103.0 | 115.3 | ×1.12 |
+| ficus | 139.5 | 148.2 | ×1.06 |
+| hotdog | 144.5 | 156.5 | ×1.08 |
+| lego | 117.5 | 126.5 | ×1.08 |
+| materials | 134.0 | 144.9 | ×1.08 |
+| mic | 95.4 | 105.1 | ×1.10 |
+| ship | 107.0 | 113.2 | ×1.06 |
+| train | 55.6 | 58.3 | ×1.05 |
+| truck | 39.4 | 40.1 | ×1.02 |
+| drjohnson | 30.8 | 32.0 | ×1.04 |
+| playroom | 46.9 | 47.5 | ×1.01 |
+
+**NeRF Synthetic (8 scenes)**: average ×1.08 speedup. **Tanks & Temples / Deep Blending (4 large scenes)**: average ×1.03 speedup. The smaller gains on large scenes (drjohnson, playroom) are explained by the higher Gaussian counts diluting the rasterizer kernel advantage — see the [rasterizer documentation](docs/rasterizer.md) for a per-phase breakdown.
+
+---
+
+## Quality Metrics
+
+Test-set evaluation after 30K training steps:
+
+**NeRF Synthetic (8-scene average)**
+
+| Metric | CUDA | Warp | Δ |
+|--------|------|------|---|
+| PSNR (dB) | 33.31 | 33.33 | +0.02 |
+| SSIM | 0.9692 | 0.9693 | +0.0001 |
+| LPIPS | 0.0303 | 0.0302 | −0.0001 |
+
+**Tanks & Temples (2-scene average)**
+
+| Metric | CUDA | Warp | Δ |
+|--------|------|------|---|
+| PSNR (dB) | 23.74 | 23.79 | +0.04 |
+| SSIM | 0.8512 | 0.8515 | +0.0003 |
+| LPIPS | 0.1711 | 0.1707 | −0.0004 |
+
+**Deep Blending (2-scene average)**
+
+| Metric | CUDA | Warp | Δ |
+|--------|------|------|---|
+| PSNR (dB) | 29.77 | 30.01 | +0.04 |
+| SSIM | 0.9062 | 0.9063 | +0.0001 |
+| LPIPS | 0.2390 | 0.2388 | −0.0002 |
+
+Per-scene PSNR differences are within ±0.25 dB; SSIM differences are < 0.001. The Warp backend produces training quality equivalent to the CUDA baseline across all tested scenes.
+
+---
+
+## Detailed Documentation
+
+| Document | Contents |
+|----------|----------|
+| [docs/rasterizer.md](docs/rasterizer.md) | Architecture, CUDA implementation differences, micro-benchmarks, correctness, known limitations |
+| [docs/ssim.md](docs/ssim.md) | SSIM kernel optimizations, performance analysis, correctness |
+| [docs/knn.md](docs/knn.md) | KNN algorithm, Morton sorting, performance analysis |
+
+---
+
+## Acknowledgements
+
+- [3D Gaussian Splatting](https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/) (INRIA / MPII)
+- [fused-ssim](https://github.com/rahul-goel/fused-ssim) (Rahul Goel et al.)
+- [simple-knn](https://github.com/camenduru/simple-knn) (graphdeco-inria)
+- [Fast Converging 3DGS](https://arxiv.org/abs/2601.19489) (Zhang et al., 2025) — inspiration for compact AABB culling
+- [NVIDIA Warp](https://nvidia.github.io/warp/)
+