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 Splattingexamples/2dgs/simple_2dgs.py— 2D 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28176076a0b8ffadd823d8a59e6e4e9cc0473ba6e1672e8d282ddf7a5ba1e8d3
|
|
| MD5 |
6e523833d8de8477bc77719f9c9cb2ee
|
|
| BLAKE2b-256 |
4717973e30bbb1f57c2afdf5ba23ad6c1fdcef3cc3fda7711afbb26bca8ddc0f
|
Provenance
The following attestation bundles were made for splatkit-0.1.0.tar.gz:
Publisher:
publish.yml on FeiyouG/splatkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
splatkit-0.1.0.tar.gz -
Subject digest:
28176076a0b8ffadd823d8a59e6e4e9cc0473ba6e1672e8d282ddf7a5ba1e8d3 - Sigstore transparency entry: 868741943
- Sigstore integration time:
-
Permalink:
FeiyouG/splatkit@0bee0a7122939733ac7390b6e7dcca2e7dfbb4e5 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/FeiyouG
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0bee0a7122939733ac7390b6e7dcca2e7dfbb4e5 -
Trigger Event:
release
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ef65d0de67b53fce29fb4a51f1bb739ecea585ecd6ecbc4c822c22754e73cad
|
|
| MD5 |
113ac9ffb5bbd6eaa5dc32463c15270a
|
|
| BLAKE2b-256 |
0e875a9f5d0843bfee4ae06eb84af480ac60c538d68f60c1cb4957045063a671
|
Provenance
The following attestation bundles were made for splatkit-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on FeiyouG/splatkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
splatkit-0.1.0-py3-none-any.whl -
Subject digest:
5ef65d0de67b53fce29fb4a51f1bb739ecea585ecd6ecbc4c822c22754e73cad - Sigstore transparency entry: 868741946
- Sigstore integration time:
-
Permalink:
FeiyouG/splatkit@0bee0a7122939733ac7390b6e7dcca2e7dfbb4e5 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/FeiyouG
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0bee0a7122939733ac7390b6e7dcca2e7dfbb4e5 -
Trigger Event:
release
-
Statement type: