Skip to main content

Refactored python training and inference code for 3D Gaussian Splatting

Project description

3D Gaussian Splatting (Packaged Python Version)

This repo is the refactored python training and inference code for 3D Gaussian Splatting. Forked from commit a2a91d9093fd791fb01f556fa717f8d9f2cfbdd7. We refactored the original code following the standard Python package structure, while keeping the algorithms used in the code identical to the original version.

Features

  • organize the code as a standard Python package
  • exposure compensation
  • camera and 3DGS parameters joint training
  • depth regularization
  • local relative depth regularization
  • image mask
  • integrated gsplat backend
  • integrated 2DGS from gsplat

Downstream Projects

Install

Prerequisites

PyPI Install

pip install --upgrade gaussian-splatting

or build latest from source:

pip install wheel setuptools
pip install --upgrade git+https://github.com/yindaheng98/gaussian-splatting.git@master --no-build-isolation

Development Install

git clone --recursive https://github.com/yindaheng98/gaussian-splatting
cd gaussian-splatting
pip install tqdm plyfile tifffile numpy opencv-python pillow open3d
pip install git+https://github.com/nerfstudio-project/gsplat.git
pip install --target . --upgrade . --no-deps

Quick Start

  1. Download dataset (T&T+DB COLMAP dataset, size 650MB):
wget https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/datasets/input/tandt_db.zip -P ./data
unzip data/tandt_db.zip -d data/
  1. Train 3DGS with densification (same with original 3DGS)
python -m gaussian_splatting.train -s data/truck -d output/truck -i 30000 --mode densify
  1. Render or view 3DGS
python -m gaussian_splatting.render -s data/truck -d output/truck -i 30000 --mode densify
python -m gaussian_splatting.viewer -d output/truck -i 30000
  1. Joint training 3DGS and camera (load the trained 3DGS)
python -m gaussian_splatting.train -s data/truck -d output/truck-camera -i 30000 --mode camera -l output/truck/point_cloud/iteration_30000/point_cloud.ply
  1. Render 3DGS with optimized cameras
python -m gaussian_splatting.render -s data/truck -d output/truck-camera -i 30000 --mode camera --load_camera output/truck-camera/cameras.json

💡 This repo does not contain code for creating dataset. If you want to create your own dataset, please refer to InstantSplat or use convert.py.

💡 See .vscode/launch.json for more example. See gaussian_splatting.train and gaussian_splatting.render for full options.

(Optional) Generate depth maps before training

  1. Prepare Depth-Anything-V2
git clone https://github.com/DepthAnything/Depth-Anything-V2.git
mkdir checkpoints
wget -O checkpoints/depth_anything_v2_vitl.pth https://huggingface.co/depth-anything/Depth-Anything-V2-Large/resolve/main/depth_anything_v2_vitl.pth?download=true
  1. Generate depth maps
# (Recommanded) save depth map as floating-point tiff file
python tools/run_depth_anything_v2.py --encoder vitl --img-path data/truck/images --outdir data/truck/depths
# (not Recommanded) save depth map as uint8 png file
python Depth-Anything-V2/run.py --encoder vitl --pred-only --grayscale --img-path data/truck/images --outdir data/truck/depths

API Usage

Gaussian models

GaussianModel is the basic 3DGS model.

from gaussian_splatting import GaussianModel
gaussians = GaussianModel(sh_degree).to(device)

If you want cameras-3DGS joint training, use CameraTrainableGaussianModel, the rendering process is different.

from gaussian_splatting import CameraTrainableGaussianModel
gaussians = CameraTrainableGaussianModel(sh_degree).to(device)

save and load params:

gaussians.save_ply("output/truck/point_cloud/iteration_30000/point_cloud.ply")
gaussians.load_ply("output/truck/point_cloud/iteration_30000/point_cloud.ply")

init 3DGS with sparse point cloud extracted by colmap:

from gaussian_splatting.dataset.colmap import colmap_init
colmap_init(gaussians, "data/truck")

Dataset

Basic colmap dataset:

from gaussian_splatting.dataset.colmap import ColmapCameraDataset, colmap_init
dataset = ColmapCameraDataset("data/truck")

save to JSON and load JSON dataset:

dataset.save_cameras("output/truck/cameras.json")
from gaussian_splatting import JSONCameraDataset
dataset = JSONCameraDataset("output/truck/cameras.json")

Dataset with trainable cameras:

from gaussian_splatting import TrainableCameraDataset
dataset = TrainableCameraDataset("data/truck") # init cameras from colmap
dataset = TrainableCameraDataset.from_json("output/truck/cameras.json") # init cameras from saved json

Inference

for camera in dataset:
  out = gaussians(camera)
  image = out["render"]
  ... # compute loss, save image or others

Trainers

gaussian_splatting.trainer contains a series of trainers for optimizing 3DGS models.

Core Trainers

Basic training methods​ that handle fundamental optimization tasks:

BaseTrainer only optimize the 3DGS parameters, without densification or camera optimization.

from gaussian_splatting.trainer import BaseTrainer
trainer = BaseTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/base.py for full options
)

BaseDensificationTrainer optimize the 3DGS parameters with densification.

from gaussian_splatting.trainer import BaseDensificationTrainer
trainer = BaseDensificationTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/densifier/densifier.py for full options
)

BaseCameraTrainer jointly optimize the 3DGS parameters and cameras, without densification.

from gaussian_splatting.trainer import BaseCameraTrainer
trainer = BaseCameraTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    dataset=dataset,
    ... # see gaussian_splatting/trainer/camera_trainable.py for full options
)

BaseDepthTrainer optimize the 3DGS parameters with depth regularization.

from gaussian_splatting.trainer import BaseDepthTrainer
trainer = BaseDepthTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/base.py for full options
)

DepthCameraTrainer integrated BaseCameraTrainer with depth regularization.

from gaussian_splatting.trainer import SHLiftTrainer
trainer = SHLiftTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    dataset=dataset,
    ... # see gaussian_splatting/trainer/sh_lift.py for full options
)

Enhanced Trainers

Gaussian Splatting paper also introduce two tricks "opacity reset" and "lifting SH", they are also included. The basic methods can be integrated with opacity reset and lifting SH. For example:

BaseOpacityResetDensificationTrainer integrated BaseDensificationTrainer with opacity reset.

from gaussian_splatting.trainer import BaseOpacityResetDensificationTrainer
trainer = OpacityResetDensificationTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/combinations.py for full options
)

DepthOpacityResetDensificationTrainer integrated BaseOpacityResetDensificationTrainer with depth regularization.

from gaussian_splatting.trainer import DepthOpacityResetDensificationTrainer
trainer = DepthOpacityResetDensificationTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/combinations.py for full options
)

BaseSHLiftOpacityResetDensificationTrainer integrated BaseOpacityResetDensificationTrainer with lifting SH.

from gaussian_splatting.trainer import BaseSHLiftOpacityResetDensificationTrainer
trainer = BaseSHLiftOpacityResetDensificationTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/combinations.py for full options
)

DepthSHLiftOpacityResetDensificationTrainer integrated DepthOpacityResetDensificationTrainer with lifting SH.

from gaussian_splatting.trainer import DepthSHLiftOpacityResetDensificationTrainer
trainer = DepthSHLiftOpacityResetDensificationTrainer(
    gaussians,
    scene_extent=dataset.scene_extent(),
    ... # see gaussian_splatting/trainer/combinations.py for full options
)

Similarly, there are BaseOpacityResetDensificationCameraTrainer, DepthOpacityResetDensificationCameraTrainer, BaseSHLiftOpacityResetDensificationCameraTrainer, DepthSHLiftOpacityResetDensificationCameraTrainer that integrated the above with camera training.

For more, please refer to train.py and trainer/combinations.py.

Training

To use any trainer:

for camera in dataset:
    loss, out = trainer.step(camera)

Discussion on Additional Features

Local Relative Depth Regularization

Problem: Global Depth Rescaling Limitation

The default implementation uses DepthAnythingV2 for depth estimation (tools/run_depth_anything_v2.py). These estimated depth maps are then scaled using one global factor per scene (trainer/depth.py or in the github.com/graphdeco-inria/gaussian-splatting/utils/make_depth_scale.py). However, this approach suffers from local inaccuracies due to limitations inherent in monocular depth predictions.

As demonstrated below, monocular depth estimation frequently introduces local distortions with global rescaling (for instance, people are pouring wine, but the spout is not positioned directly above the wine glass.):

Using globally scaled depth alone results in artifacts and incorrectly placed surfaces during rendering:

Overlaying rendered depth map with DepthAnythingV2-estimated depth map manifests these shortcomings clearly. While background walls and foreground table approximately match ground truth, depth estimates for people remain significantly inaccurate:

Root Cause: Spatial Error Patterns in DepthAnythingV2

Although the output depth estimation from DepthAnythingV2 appears visually plausible when inspected independently (as illustrated in the figure below), local depth scale variations remain substantial.

Therefore, a single global scaling cannot account adequately for these local discrepancies.

Solution: Local relative depth regularization

Considering that DepthAnythingV2 produces relatively accurate local depth relationships, this repo introduces local relative depth regularization strategy. Specifically, the strategy involves:

  • Divide the depth map into small overlapping windows.
  • Compute scaling and offset corrections individually per window.
  • Apply these local corrections to guide model predictions.

Implementation details are provided in the function compute_local_relative_depth_loss in trainer/depth.py.

The resulting improvements are clearly visible, significantly reducing artifacts:

Overlaying it with DepthAnythingV2-estimated depth map:

Local regularization notably improves background alignment (e.g., walls), but some inaccuracies remain for complex foreground shapes such as people. This clearly highlights inherent limitations and persistent spatial error patterns in the monocular DepthAnythingV2 estimations.

3D Gaussian Splatting for Real-Time Radiance Field Rendering

Bernhard Kerbl*, Georgios Kopanas*, Thomas Leimkühler, George Drettakis (* indicates equal contribution)
| Webpage | Full Paper | Video | Other GRAPHDECO Publications | FUNGRAPH project page |
| T&T+DB COLMAP (650MB) | Pre-trained Models (14 GB) | Viewers for Windows (60MB) | Evaluation Images (7 GB) |
Teaser image

This repository contains the official authors implementation associated with the paper "3D Gaussian Splatting for Real-Time Radiance Field Rendering", which can be found here. We further provide the reference images used to create the error metrics reported in the paper, as well as recently created, pre-trained models.

Abstract: Radiance Field methods have recently revolutionized novel-view synthesis of scenes captured with multiple photos or videos. However, achieving high visual quality still requires neural networks that are costly to train and render, while recent faster methods inevitably trade off speed for quality. For unbounded and complete scenes (rather than isolated objects) and 1080p resolution rendering, no current method can achieve real-time display rates. We introduce three key elements that allow us to achieve state-of-the-art visual quality while maintaining competitive training times and importantly allow high-quality real-time (≥ 30 fps) novel-view synthesis at 1080p resolution. First, starting from sparse points produced during camera calibration, we represent the scene with 3D Gaussians that preserve desirable properties of continuous volumetric radiance fields for scene optimization while avoiding unnecessary computation in empty space; Second, we perform interleaved optimization/density control of the 3D Gaussians, notably optimizing anisotropic covariance to achieve an accurate representation of the scene; Third, we develop a fast visibility-aware rendering algorithm that supports anisotropic splatting and both accelerates training and allows realtime rendering. We demonstrate state-of-the-art visual quality and real-time rendering on several established datasets.

BibTeX

@Article{kerbl3Dgaussians,
      author       = {Kerbl, Bernhard and Kopanas, Georgios and Leimk{\"u}hler, Thomas and Drettakis, George},
      title        = {3D Gaussian Splatting for Real-Time Radiance Field Rendering},
      journal      = {ACM Transactions on Graphics},
      number       = {4},
      volume       = {42},
      month        = {July},
      year         = {2023},
      url          = {https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/}
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

gaussian_splatting-2.3.8.tar.gz (4.5 MB view details)

Uploaded Source

Built Distributions

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

gaussian_splatting-2.3.8-cp312-cp312-win_amd64.whl (972.0 kB view details)

Uploaded CPython 3.12Windows x86-64

gaussian_splatting-2.3.8-cp311-cp311-win_amd64.whl (970.5 kB view details)

Uploaded CPython 3.11Windows x86-64

gaussian_splatting-2.3.8-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (7.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

gaussian_splatting-2.3.8-cp310-cp310-win_amd64.whl (968.0 kB view details)

Uploaded CPython 3.10Windows x86-64

gaussian_splatting-2.3.8-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

File details

Details for the file gaussian_splatting-2.3.8.tar.gz.

File metadata

  • Download URL: gaussian_splatting-2.3.8.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for gaussian_splatting-2.3.8.tar.gz
Algorithm Hash digest
SHA256 4707e79c0d85dcdb6c3dac1d8986ce8dbb6106ff44f6ed34ec875ca80b8cf526
MD5 6001f570bc749f7ce8b184204f580326
BLAKE2b-256 0be941ecdba80af4a17a9bbd6aec2e9a0785f7c3fa2e7066cbf58f527726970b

See more details on using hashes here.

File details

Details for the file gaussian_splatting-2.3.8-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for gaussian_splatting-2.3.8-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 0a92648248ad2e1df357528d8bbcce9b02663c39f65b1549926e54dd5738b606
MD5 ba87fddb86910f4592b384a62800fce8
BLAKE2b-256 be82e266a87a645d3afc109448100a0899546893707948816d4129bbc43487ef

See more details on using hashes here.

File details

Details for the file gaussian_splatting-2.3.8-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for gaussian_splatting-2.3.8-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 eb638b34bbb166d2b0bc550ec7ac4620ae42141049b346729953f6239de9eaaa
MD5 81a099d17b2643e42a213dcd5c78a787
BLAKE2b-256 394807da67921e16e7b7a63749d9a14bfe20e4cb4052a32d3ef69a9d5b5a3a0e

See more details on using hashes here.

File details

Details for the file gaussian_splatting-2.3.8-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for gaussian_splatting-2.3.8-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 de350f37703256abce5c1c5b57904f783ee03ff72589e3b2519a5f35c8249f71
MD5 7fa98c74c06cf4389054fd870808a2c5
BLAKE2b-256 7b90d21e8439fa0cc517fb98f1d8f8ff5c39d3a65467e6b00d2381f10bb56c14

See more details on using hashes here.

File details

Details for the file gaussian_splatting-2.3.8-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for gaussian_splatting-2.3.8-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 5e89dc7cf29f3bad7eda144c2aea56b3aa979d459577cbdd237c23c78d313d0d
MD5 8c3f5093f28e613f8bc0636b58a4ca8f
BLAKE2b-256 9e0c04a381ec46905a7ad032ffd35490a932d5e8f76651a8899597ec6e815245

See more details on using hashes here.

File details

Details for the file gaussian_splatting-2.3.8-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for gaussian_splatting-2.3.8-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 71054723f8ea0ad5d1f7d44bcfcd5d4e3076859fba257a8327e2897dd2c0d66e
MD5 8319e481cab94de52d3a22067c0abaa9
BLAKE2b-256 9e27489daffbb86e41bb34c1a02ef832424cb6a55ae25700214507bcadf7f93c

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