reduced-3dgs 1.10.4__tar.gz → 1.10.13__tar.gz

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reduced_3dgs
-Version: 1.10.4
+Version: 1.10.13
 Summary: Refactored code for the paper "Reducing the Memory Footprint of 3D Gaussian Splatting"
 Home-page: https://github.com/yindaheng98/reduced-3dgs
 Author: yindaheng98
@@ -8,13 +8,8 @@ Author-email: yindaheng98@gmail.com
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: tqdm
-Requires-Dist: plyfile
-Requires-Dist: scikit-learn
-Requires-Dist: torch
-Requires-Dist: torchvision
-Requires-Dist: numpy
 Requires-Dist: gaussian-splatting
+Requires-Dist: scikit-learn
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -40,47 +35,35 @@ This repository contains the **refactored Python code for [Reduced-3DGS](https:/
 
 * [Pytorch](https://pytorch.org/) (v2.4 or higher recommended)
 * [CUDA Toolkit](https://developer.nvidia.com/cuda-12-4-0-download-archive) (12.4 recommended, should match with PyTorch version)
+* (Optional) [cuML](https://github.com/rapidsai/cuml) for faster vector quantization
 
-## Install (PyPI)
-
+(Optional) If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), try to install it from source:
 ```sh
-pip install --upgrade reduced-3dgs
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master --no-build-isolation
 ```
 
-## Install (Build from source)
-
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main
-```
-If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), you can install it from source:
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
-```
+## PyPI Install
 
-## Install (Development)
-
-Install [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting).
-You can download the wheel from [PyPI](https://pypi.org/project/gaussian-splatting/):
 ```shell
-pip install --upgrade gaussian-splatting
+pip install --upgrade reduced-3dgs
 ```
-Alternatively, install the latest version from the source:
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
+or
+build latest from source:
+```shell
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main --no-build-isolation
 ```
 
+### Development Install
+
 ```shell
 git clone --recursive https://github.com/yindaheng98/reduced-3dgs
 cd reduced-3dgs
-pip install tqdm plyfile scikit-learn numpy tifffile triton xformers
+pip install scikit-learn
 pip install --target . --upgrade --no-deps .
 ```
 
-(Optional) If you prefer not to install `gaussian-splatting` in your environment, you can install it in your `reduced-3dgs` directory:
-```sh
-pip install --target . --no-deps --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
-```
-
 ## Quick Start
 
 1. Download the dataset (T&T+DB COLMAP dataset, size 650MB):

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/README.md

@@ -13,47 +13,35 @@ This repository contains the **refactored Python code for [Reduced-3DGS](https:/
 
 * [Pytorch](https://pytorch.org/) (v2.4 or higher recommended)
 * [CUDA Toolkit](https://developer.nvidia.com/cuda-12-4-0-download-archive) (12.4 recommended, should match with PyTorch version)
+* (Optional) [cuML](https://github.com/rapidsai/cuml) for faster vector quantization
 
-## Install (PyPI)
-
-```sh
-pip install --upgrade reduced-3dgs
-```
-
-## Install (Build from source)
-
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main
-```
-If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), you can install it from source:
+(Optional) If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), try to install it from source:
 ```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master --no-build-isolation
 ```
 
-## Install (Development)
+## PyPI Install
 
-Install [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting).
-You can download the wheel from [PyPI](https://pypi.org/project/gaussian-splatting/):
 ```shell
-pip install --upgrade gaussian-splatting
+pip install --upgrade reduced-3dgs
 ```
-Alternatively, install the latest version from the source:
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
+or
+build latest from source:
+```shell
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main --no-build-isolation
 ```
 
+### Development Install
+
 ```shell
 git clone --recursive https://github.com/yindaheng98/reduced-3dgs
 cd reduced-3dgs
-pip install tqdm plyfile scikit-learn numpy tifffile triton xformers
+pip install scikit-learn
 pip install --target . --upgrade --no-deps .
 ```
 
-(Optional) If you prefer not to install `gaussian-splatting` in your environment, you can install it in your `reduced-3dgs` directory:
-```sh
-pip install --target . --no-deps --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
-```
-
 ## Quick Start
 
 1. Download the dataset (T&T+DB COLMAP dataset, size 650MB):

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs/combinations.py

@@ -97,11 +97,17 @@ def BaseFullPrunerInDensifyTrainer(
 
 
 def DepthFullPruningTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BaseFullPruningTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BaseFullPruningTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 def DepthFullPrunerInDensifyTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BaseFullPrunerInDensifyTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BaseFullPrunerInDensifyTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 def OpacityResetPruningTrainer(

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs/importance/combinations.py

@@ -52,11 +52,17 @@ def BaseImportancePrunerInDensifyTrainer(
 
 
 def DepthImportancePruningTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BaseImportancePruningTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BaseImportancePruningTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 def DepthImportancePrunerInDensifyTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BaseImportancePrunerInDensifyTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BaseImportancePrunerInDensifyTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 ImportancePruningTrainer = DepthImportancePruningTrainer

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs/pruning/combinations.py

@@ -54,11 +54,17 @@ def BasePrunerInDensifyTrainer(
 
 
 def DepthPruningTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BasePruningTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BasePruningTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 def DepthPrunerInDensifyTrainer(model: GaussianModel, scene_extent: float, dataset: TrainableCameraDataset, *args, **kwargs):
-    return DepthTrainerWrapper(BasePrunerInDensifyTrainer, model, scene_extent, *args, dataset=dataset, **kwargs)
+    return DepthTrainerWrapper(
+        BasePrunerInDensifyTrainer,
+        model, scene_extent, dataset,
+        *args, **kwargs)
 
 
 PruningTrainer = DepthPruningTrainer

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs/quantization/quantizer.py

@@ -4,7 +4,15 @@ from typing import Dict, Tuple
 import torch
 import torch.nn as nn
 import numpy as np
-from sklearn.cluster import MiniBatchKMeans as KMeans
+try:
+    from cuml.cluster import KMeans
+    kmeans_init = 'k-means||'
+except ImportError:
+    print("Cuml not found, using sklearn's MiniBatchKMeans for quantization.")
+    from sklearn.cluster import MiniBatchKMeans
+    from functools import partial
+    KMeans = partial(MiniBatchKMeans, batch_size=256 * os.cpu_count())
+    kmeans_init = 'k-means++'
 from gaussian_splatting import GaussianModel
 from plyfile import PlyData, PlyElement
 import numpy as np
@@ -65,9 +73,8 @@ class VectorQuantizer(AbstractQuantizer):
     def generate_codebook(self, values: torch.Tensor, num_clusters, init_codebook=None):
         kmeans = KMeans(
             n_clusters=num_clusters, tol=self.tol, max_iter=self.max_iter,
-            init='k-means++' if init_codebook is None else init_codebook.cpu().numpy(),
-            random_state=0, n_init="auto", verbose=0,
-            batch_size=256 * os.cpu_count()
+            init=kmeans_init if init_codebook is None else init_codebook.cpu().numpy(),
+            random_state=0, n_init="auto", verbose=1,
         )
         ids = torch.tensor(kmeans.fit_predict(values.cpu().numpy()), device=values.device)
         centers = torch.tensor(kmeans.cluster_centers_, dtype=values.dtype, device=values.device)

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs/train.py

@@ -14,8 +14,12 @@ from reduced_3dgs.quantization import AbstractQuantizer
 from reduced_3dgs.prepare import modes, prepare_gaussians, prepare_trainer
 
 
-def prepare_training(sh_degree: int, source: str, device: str, mode: str, trainable_camera: bool = False, load_ply: str = None, load_camera: str = None, load_depth=False, with_scale_reg=False, quantize: bool = False, load_quantized: str = None, configs={}):
-    dataset = prepare_dataset(source=source, device=device, trainable_camera=trainable_camera, load_camera=load_camera, load_depth=load_depth)
+def prepare_training(
+        sh_degree: int, source: str, device: str, mode: str,
+        trainable_camera: bool = False, load_ply: str = None, load_camera: str = None,
+        load_mask=True, load_depth=True,
+        with_scale_reg=False, quantize: bool = False, load_quantized: str = None, configs={}):
+    dataset = prepare_dataset(source=source, device=device, trainable_camera=trainable_camera, load_camera=load_camera, load_mask=load_mask, load_depth=load_depth)
     gaussians = prepare_gaussians(sh_degree=sh_degree, source=source, device=device, trainable_camera=trainable_camera, load_ply=load_ply)
     trainer, quantizer = prepare_trainer(gaussians=gaussians, dataset=dataset, mode=mode, with_scale_reg=with_scale_reg, quantize=quantize, load_quantized=load_quantized, configs=configs)
     return dataset, gaussians, trainer, quantizer
@@ -23,26 +27,39 @@ def prepare_training(sh_degree: int, source: str, device: str, mode: str, traina
 
 def training(dataset: CameraDataset, gaussians: GaussianModel, trainer: AbstractTrainer, quantizer: AbstractQuantizer, destination: str, iteration: int, save_iterations: List[int], device: str, empty_cache_every_step=False):
     shutil.rmtree(os.path.join(destination, "point_cloud"), ignore_errors=True)  # remove the previous point cloud
-    pbar = tqdm(range(1, iteration+1))
+    pbar = tqdm(range(1, iteration+1), dynamic_ncols=True, desc="Training")
     epoch = list(range(len(dataset)))
     epoch_psnr = torch.empty(3, 0, device=device)
+    epoch_maskpsnr = torch.empty(3, 0, device=device)
     ema_loss_for_log = 0.0
     avg_psnr_for_log = 0.0
+    avg_maskpsnr_for_log = 0.0
     for step in pbar:
         epoch_idx = step % len(dataset)
         if epoch_idx == 0:
             avg_psnr_for_log = epoch_psnr.mean().item()
+            avg_maskpsnr_for_log = epoch_maskpsnr.mean().item()
             epoch_psnr = torch.empty(3, 0, device=device)
+            epoch_maskpsnr = torch.empty(3, 0, device=device)
             random.shuffle(epoch)
         idx = epoch[epoch_idx]
         loss, out = trainer.step(dataset[idx])
         if empty_cache_every_step:
             torch.cuda.empty_cache()
         with torch.no_grad():
+            ground_truth_image = dataset[idx].ground_truth_image
+            rendered_image = out["render"]
+            epoch_psnr = torch.concat([epoch_psnr, psnr(rendered_image, ground_truth_image)], dim=1)
+            if dataset[idx].ground_truth_image_mask is not None:
+                ground_truth_maskimage = ground_truth_image * dataset[idx].ground_truth_image_mask
+                rendered_maskimage = rendered_image * dataset[idx].ground_truth_image_mask
+                epoch_maskpsnr = torch.concat([epoch_maskpsnr, psnr(rendered_maskimage, ground_truth_maskimage)], dim=1)
             ema_loss_for_log = 0.4 * loss.item() + 0.6 * ema_loss_for_log
-            epoch_psnr = torch.concat([epoch_psnr, psnr(out["render"], dataset[idx].ground_truth_image)], dim=1)
             if step % 10 == 0:
-                pbar.set_postfix({'epoch': step // len(dataset), 'loss': ema_loss_for_log, 'psnr': avg_psnr_for_log, 'n': gaussians._xyz.shape[0]})
+                postfix = {'epoch': step // len(dataset), 'loss': ema_loss_for_log, 'psnr': avg_psnr_for_log, 'masked psnr': avg_maskpsnr_for_log, 'n': gaussians._xyz.shape[0]}
+                if avg_maskpsnr_for_log <= 0:
+                    del postfix['masked psnr']
+                pbar.set_postfix(postfix)
         if step in save_iterations:
             save_path = os.path.join(destination, "point_cloud", "iteration_" + str(step))
             os.makedirs(save_path, exist_ok=True)
@@ -68,6 +85,7 @@ if __name__ == "__main__":
     parser.add_argument("-l", "--load_ply", default=None, type=str)
     parser.add_argument("--load_camera", default=None, type=str)
     parser.add_argument("--quantize", action='store_true')
+    parser.add_argument("--no_image_mask", action="store_true")
     parser.add_argument("--no_depth_data", action='store_true')
     parser.add_argument("--with_scale_reg", action="store_true")
     parser.add_argument("--load_quantized", default=None, type=str)
@@ -83,7 +101,9 @@ if __name__ == "__main__":
     configs = {o.split("=", 1)[0]: eval(o.split("=", 1)[1]) for o in args.option}
     dataset, gaussians, trainer, quantizer = prepare_training(
         sh_degree=args.sh_degree, source=args.source, device=args.device, mode=args.mode, trainable_camera="camera" in args.mode,
-        load_ply=args.load_ply, load_camera=args.load_camera, load_depth=not args.no_depth_data, with_scale_reg=args.with_scale_reg,
+        load_ply=args.load_ply, load_camera=args.load_camera,
+        load_mask=not args.no_image_mask, load_depth=not args.no_depth_data,
+        with_scale_reg=args.with_scale_reg,
         quantize=args.quantize, load_quantized=args.load_quantized, configs=configs)
     dataset.save_cameras(os.path.join(args.destination, "cameras.json"))
     torch.cuda.empty_cache()

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/reduced_3dgs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reduced_3dgs
-Version: 1.10.4
+Version: 1.10.13
 Summary: Refactored code for the paper "Reducing the Memory Footprint of 3D Gaussian Splatting"
 Home-page: https://github.com/yindaheng98/reduced-3dgs
 Author: yindaheng98
@@ -8,13 +8,8 @@ Author-email: yindaheng98@gmail.com
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: tqdm
-Requires-Dist: plyfile
-Requires-Dist: scikit-learn
-Requires-Dist: torch
-Requires-Dist: torchvision
-Requires-Dist: numpy
 Requires-Dist: gaussian-splatting
+Requires-Dist: scikit-learn
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -40,47 +35,35 @@ This repository contains the **refactored Python code for [Reduced-3DGS](https:/
 
 * [Pytorch](https://pytorch.org/) (v2.4 or higher recommended)
 * [CUDA Toolkit](https://developer.nvidia.com/cuda-12-4-0-download-archive) (12.4 recommended, should match with PyTorch version)
+* (Optional) [cuML](https://github.com/rapidsai/cuml) for faster vector quantization
 
-## Install (PyPI)
-
+(Optional) If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), try to install it from source:
 ```sh
-pip install --upgrade reduced-3dgs
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master --no-build-isolation
 ```
 
-## Install (Build from source)
-
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main
-```
-If you have trouble with [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting), you can install it from source:
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
-```
+## PyPI Install
 
-## Install (Development)
-
-Install [`gaussian-splatting`](https://github.com/yindaheng98/gaussian-splatting).
-You can download the wheel from [PyPI](https://pypi.org/project/gaussian-splatting/):
 ```shell
-pip install --upgrade gaussian-splatting
+pip install --upgrade reduced-3dgs
 ```
-Alternatively, install the latest version from the source:
-```sh
-pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
+or
+build latest from source:
+```shell
+pip install wheel setuptools
+pip install --upgrade git+https://github.com/yindaheng98/reduced-3dgs.git@main --no-build-isolation
 ```
 
+### Development Install
+
 ```shell
 git clone --recursive https://github.com/yindaheng98/reduced-3dgs
 cd reduced-3dgs
-pip install tqdm plyfile scikit-learn numpy tifffile triton xformers
+pip install scikit-learn
 pip install --target . --upgrade --no-deps .
 ```
 
-(Optional) If you prefer not to install `gaussian-splatting` in your environment, you can install it in your `reduced-3dgs` directory:
-```sh
-pip install --target . --no-deps --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master
-```
-
 ## Quick Start
 
 1. Download the dataset (T&T+DB COLMAP dataset, size 650MB):

reduced_3dgs-1.10.13/reduced_3dgs.egg-info/requires.txt

@@ -0,0 +1,2 @@
+gaussian-splatting
+scikit-learn

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/setup.py

@@ -60,7 +60,7 @@ if os.name == 'nt':
 
 setup(
     name="reduced_3dgs",
-    version='1.10.4',
+    version='1.10.13',
     author='yindaheng98',
     author_email='yindaheng98@gmail.com',
     url='https://github.com/yindaheng98/reduced-3dgs',
@@ -97,12 +97,7 @@ setup(
         'build_ext': BuildExtension
     },
     install_requires=[
-        'tqdm',
-        'plyfile',
-        'scikit-learn',
-        'torch',
-        'torchvision',
-        'numpy',
         'gaussian-splatting',
+        'scikit-learn',
     ]
 )

{reduced_3dgs-1.10.4 → reduced_3dgs-1.10.13}/submodules/simple-knn/simple_knn.cu

@@ -12,6 +12,7 @@
 #define BOX_SIZE 1024
 #define BOX_SIZE2 128
 
+#include <float.h>
 #include "cuda_runtime.h"
 #include "device_launch_parameters.h"
 #include "simple_knn.h"

reduced_3dgs-1.10.4/reduced_3dgs.egg-info/requires.txt

@@ -1,7 +0,0 @@
-tqdm
-plyfile
-scikit-learn
-torch
-torchvision
-numpy
-gaussian-splatting