Skip to main content

A modular toolkit for 3D and 2D Gaussian Splatting

Project description

splatkit

A modular toolkit for Gaussian Splatting training, built on top of gsplat.

Installation

Step 1: Install PyTorch with CUDA support (required, not included):

pip install torch torchvision --index-url https://download.pytorch.org/whl/cu121

Step 2: Install splatkit:

# From PyPI (once published)
pip install splatkit[all]
# or using uv
uv add splatkit --extra all

# For development (from source)
git clone https://github.com/veristic/splatkit.git
cd splatkit
pip install -e ".[all]"  # or: uv pip install -e ".[all]"

Optional: For fused SSIM support (improves training quality):

pip install git+https://github.com/rahul-goel/fused-ssim@98126b7781f9e563234c92d2bf08ee0994f4f175

See the installation guide for more options.

Quick Example

Train a 3D Gaussian Splatting model:

from splatkit.trainer import SplatTrainer, SplatTrainerConfig
from splatkit.data_provider import SplatColmapDataProvider, SplatColmapDataProviderConfig
from splatkit.renderer import Splat3DGSRenderer
from splatkit.loss_fn import Splat3DGSLossFn
from splatkit.densification import SplatDefaultDensification

# Configure training
config = SplatTrainerConfig(
    max_steps=30000,
    output_dir="outputs/my_scene",
)

# Set up COLMAP data
data_provider = SplatColmapDataProvider(
    config=SplatColmapDataProviderConfig(
        colmap_dir="data/sparse/0",
        images_dir="data/images",
        normalize=True,
    )
)

# Create and run trainer
trainer = SplatTrainer(
    config=config,
    data_provider=data_provider,
    renderer=Splat3DGSRenderer(),
    loss_fn=Splat3DGSLossFn(),
    densification=SplatDefaultDensification(),
)
trainer.run()

Documentation

📚 Full Documentation — Installation, guides, API reference, and customization examples.

Check out examples/ folder for more:

  • examples/3dgs/simple_3dgs.py — 3D Gaussian Splatting
  • examples/2dgs/simple_2dgs.py — 2D Gaussian Splatting

Project details


Download files

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

Source Distribution

splatkit-0.1.0.tar.gz (58.5 kB view details)

Uploaded Source

Built Distribution

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

splatkit-0.1.0-py3-none-any.whl (77.0 kB view details)

Uploaded Python 3

File details

Details for the file splatkit-0.1.0.tar.gz.

File metadata

  • Download URL: splatkit-0.1.0.tar.gz
  • Upload date:
  • Size: 58.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for splatkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 28176076a0b8ffadd823d8a59e6e4e9cc0473ba6e1672e8d282ddf7a5ba1e8d3
MD5 6e523833d8de8477bc77719f9c9cb2ee
BLAKE2b-256 4717973e30bbb1f57c2afdf5ba23ad6c1fdcef3cc3fda7711afbb26bca8ddc0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for splatkit-0.1.0.tar.gz:

Publisher: publish.yml on FeiyouG/splatkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file splatkit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: splatkit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 77.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for splatkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ef65d0de67b53fce29fb4a51f1bb739ecea585ecd6ecbc4c822c22754e73cad
MD5 113ac9ffb5bbd6eaa5dc32463c15270a
BLAKE2b-256 0e875a9f5d0843bfee4ae06eb84af480ac60c538d68f60c1cb4957045063a671

See more details on using hashes here.

Provenance

The following attestation bundles were made for splatkit-0.1.0-py3-none-any.whl:

Publisher: publish.yml on FeiyouG/splatkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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