MCPcopy Create free account
hub / github.com/ShijieZhou-UCLA/feature-3dgs

github.com/ShijieZhou-UCLA/feature-3dgs @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
3,311 symbols 9,891 edges 350 files 648 documented · 20% updated 21mo ago★ 66921 open issues

Browse by type

Functions 2,707 Types & classes 604
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Feature 3DGS 🪄: Supercharging 3D Gaussian Splatting to Enable Distilled Feature Fields

Shijie Zhou, Haoran Chang, Sicheng Jiang, Zhiwen Fan, Zehao Zhu, Dejia Xu, Pradyumna Chari, Suya You, Zhangyang Wang, Achuta Kadambi (* indicates equal contribution)

| Webpage | Full Paper | Video | Viewer Pre-built for Windows

Teaser image

Abstract: 3D scene representations have gained immense popularity in recent years. Methods that use Neural Radiance fields are versatile for traditional tasks such as novel view synthesis. In recent times, some work has emerged that aims to extend the functionality of NeRF beyond view synthesis, for semantically aware tasks such as editing and segmentation using 3D feature field distillation from 2D foundation models. However, these methods have two major limitations: (a) they are limited by the rendering speed of NeRF pipelines, and (b) implicitly represented feature fields suffer from continuity artifacts reducing feature quality. Recently, 3D Gaussian Splatting has shown state-of-the-art performance on real-time radiance field rendering. In this work, we go one step further: in addition to radiance field rendering, we enable 3D Gaussian splatting on arbitrary-dimension semantic features via 2D foundation model distillation. This translation is not straightforward: naively incorporating feature fields in the 3DGS framework encounters significant challenges, notably the disparities in spatial resolution and channel consistency between RGB images and feature maps. We propose architectural and training changes to efficiently avert this problem. Our proposed method is general, and our experiments showcase novel view semantic segmentation, language-guided editing and segment anything through learning feature fields from state-of-the-art 2D foundation models such as SAM and CLIP-LSeg. Across experiments, our distillation method is able to provide comparable or better results, while being significantly faster to both train and render. Additionally, to the best of our knowledge, we are the first method to enable point and bounding-box prompting for radiance field manipulation, by leveraging the SAM model.

BibTeX

@inproceedings{zhou2024feature,
  title={Feature 3dgs: Supercharging 3d gaussian splatting to enable distilled feature fields},
  author={Zhou, Shijie and Chang, Haoran and Jiang, Sicheng and Fan, Zhiwen and Zhu, Zehao and Xu, Dejia and Chari, Pradyumna and You, Suya and Wang, Zhangyang and Kadambi, Achuta},
  booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
  pages={21676--21685},
  year={2024}
}

Environment setup

Our default, provided install method is based on Conda package and environment management:

conda create --name feature_3dgs python=3.8
conda activate feature_3dgs

PyTorch (Please check your CUDA version, we used 11.8)

pip install torch==2.4.0 torchvision==0.19.0 torchaudio==2.4.0 --index-url https://download.pytorch.org/whl/cu118

Required packages

pip install -r requirements.txt

Submodules

New: Our Parallel N-dimensional Gaussian Rasterizer now supports RGB, arbitrary N-dimensional Feature, and Depth rendering.

pip install submodules/diff-gaussian-rasterization-feature # Rasterizer for RGB, n-dim feature, depth
pip install submodules/simple-knn

Processing your own Scenes

We follow the same dataset logistics for 3D Gaussian Splatting. If you want to work with your own scene, put the images you want to use in a directory <location>/input.

<location>
|---input
    |---<image 0>
    |---<image 1>
    |---...

For rasterization, the camera models must be either a SIMPLE_PINHOLE or PINHOLE camera. We provide a converter script convert.py, to extract undistorted images and SfM information from input images. Optionally, you can use ImageMagick to resize the undistorted images. This rescaling is similar to MipNeRF360, i.e., it creates images with 1/2, 1/4 and 1/8 the original resolution in corresponding folders. To use them, please first install a recent version of COLMAP (ideally CUDA-powered) and ImageMagick.

If you have COLMAP and ImageMagick on your system path, you can simply run

python convert.py -s <location> [--resize] #If not resizing, ImageMagick is not needed

Our COLMAP loaders expect the following dataset structure in the source path location:

<location>
|---images
|   |---<image 0>
|   |---<image 1>
|   |---...
|---sparse
    |---0
        |---cameras.bin
        |---images.bin
        |---points3D.bin

Alternatively, you can use the optional parameters --colmap_executable and --magick_executable to point to the respective paths. Please note that on Windows, the executable should point to the COLMAP .bat file that takes care of setting the execution environment. Once done, <location> will contain the expected COLMAP data set structure with undistorted, resized input images, in addition to your original images and some temporary (distorted) data in the directory distorted.

If you have your own COLMAP dataset without undistortion (e.g., using OPENCV camera), you can try to just run the last part of the script: Put the images in input and the COLMAP info in a subdirectory distorted:

<location>
|---input
|   |---<image 0>
|   |---<image 1>
|   |---...
|---distorted
    |---database.db
    |---sparse
        |---0
            |---...

Then run

python convert.py -s <location> --skip_matching [--resize] #If not resizing, ImageMagick is not needed

Command Line Arguments for convert.py

#### --no_gpu Flag to avoid using GPU in COLMAP. #### --skip_matching Flag to indicate that COLMAP info is available for images. #### --source_path / -s Location of the inputs. #### --camera Which camera model to use for the early matching steps, OPENCV by default. #### --resize Flag for creating resized versions of input images. #### --colmap_executable Path to the COLMAP executable (.bat on Windows). #### --magick_executable Path to the ImageMagick executable.

Feature Encoding from Teacher Network

LSeg encoder

Download the LSeg model file demo_e200.ckpt from the Google drive and place it under the folder: encoders/lseg_encoder.

Feature embedding

cd encoders/lseg_encoder
python -u encode_images.py --backbone clip_vitl16_384 --weights demo_e200.ckpt --widehead --no-scaleinv --outdir ../../data/DATASET_NAME/rgb_feature_langseg --test-rgb-dir ../../data/DATASET_NAME/images --workers 0

This may produces large feature map files in --outdir (100-200MB per file).

Run train.py. If reconstruction fails, change --scale 4.0 to smaller or larger values, e.g., --scale 1.0 or --scale 16.0.

SAM encoder

Installation

The code requires python>=3.8, as well as pytorch>=1.7 and torchvision>=0.8. Please follow the instructions here to install both PyTorch and TorchVision dependencies. Installing both PyTorch and TorchVision with CUDA support is strongly recommended.

SAM setup:

cd encoders/sam_encoder
pip install -e .

Pretrain model download:

Click the links below to download the checkpoint for the corresponding model type.

And place it under the folder: encoders/sam_encoder/checkpoints

Feature embedding

Run the following to export the image embeddings of an input image or directory of images.

cd encoders/sam_encoder
python export_image_embeddings.py --checkpoint checkpoints/sam_vit_h_4b8939.pth --model-type vit_h --input ../../data/DATASET_NAME/images  --output ../../data/OUTPUT_NAME/sam_embeddings

Training, Rendering, and Inference:

🔥 New features: Multi-functional Interactive Viewer (optional)

We are glad to introduce a brand new Multi-functional Interactive Viewer for the visualization of RGB, Depth, Edge, Normal, Curvature, and especially semantic feature. The Pre-built Viewer for Windows is placed in viewer_windows and can also be downloaded here. If your OS is Ubuntu 22.04, you need to compile the viewer locally:

# Dependencies
sudo apt install -y libglew-dev libassimp-dev libboost-all-dev libgtk-3-dev libopencv-dev libglfw3-dev libavdevice-dev libavcodec-dev libeigen3-dev libxxf86vm-dev libembree-dev
# Project setup
cd SIBR_viewers
cmake -Bbuild . -DCMAKE_BUILD_TYPE=Release # add -G Ninja to build faster
cmake --build build -j24 --target install

You can visit GS Monitor for more details.

https://github.com/RongLiu-Leo/feature-3dgs/assets/102014841/7baf236f-29bc-4de1-9a99-97d528f6e63e

How to use

Firstly run the viewer,

./viewer_windows/bin/SIBR_remoteGaussian_app_rwdi # Windows

or

./<SIBR install dir>/bin/SIBR_remoteGaussian_app # Ubuntu 22.04

and then

  1. If you want to monitor the training process, run train.py, see Train section for more details.

  2. If you prefer faster training, run view.py to interact with your trained model once training is complete. See View the Trained Model section for more details.

Train

python train.py -s data/DATASET_NAME -m output/OUTPUT_NAME -f lseg --speedup --iterations 7000

Command Line Arguments for train.py

#### --source_path / -s Path to the source directory containing a COLMAP or Synthetic NeRF data set. #### --model_path / -m Path where the trained model should be stored (output/<random> by default). #### --foundation_model / -f Switch different foundation model encoders, lseg for LSeg and sam for SAM #### --images / -i Alternative subdirectory for COLMAP images (images by default). #### --eval Add this flag to use a MipNeRF360-style training/test split for evaluation. #### --resolution / -r Specifies resolution of the loaded images before training. If provided 1, 2, 4 or 8, uses original, 1/2, 1/4 or 1/8 resolution, respectively. If proveided 0, use GT feature map's resolution. For all other values, rescales the width to the given number while maintaining image aspect. If proveided -2, use the customized resolution (utils/camera_utils.py L31). If not set and input image width exceeds 1.6K pixels, inputs are automatically rescaled to this target. #### --speedup Optional speed-up module for reduced feature dimention initialization. #### --data_device Specifies where to put the source image data, cuda by default, recommended to use cpu if training on large/high-resolution dataset, will reduce VRAM consumption, but slightly slow down training. Thanks to HrsPythonix. #### --white_background / -w Add this flag to use white background instead of black (default), e.g., for evaluation of NeRF Synthetic dataset. #### --sh_degree Order of spherical harmonics to be used (no larger than 3). 3 by default. #### --convert_SHs_python Flag to make pipeline compute forward and backward of SHs with PyTorch instead of ours. #### --convert_cov3D_python Flag to make pipeline compute forward and backward of the 3D covariance with PyTorch instead of ours. #### --debug Enables debug mode if you experience erros. If the rasterizer fails, a dump file is created that you may forward to us in an issue so we can take a look. #### --debug_from Debugging is slow. You may specify an iteration (starting from 0) after which the above debugging becomes active. #### --iterations Number of total iterations to train for, 30_000 by default. #### --ip IP to start GUI server on, 127.0.0.1 by default. #### --port Port to use for GUI server, 6009 by default. #### --test_iterations Space-separated iterations at which the training script computes L1 and PSNR over test set, ```7000 30

Core symbols most depended-on inside this repo

Shape

Method 1,871
Function 836
Class 565
Enum 39

Languages

C++75%
Python25%

Modules by API surface

SIBR_viewers/src/projects/remote/json.hpp548 symbols
SIBR_viewers/src/core/video/VideoUtils.hpp94 symbols
SIBR_viewers/src/core/video/VideoUtils.cpp59 symbols
SIBR_viewers/src/core/graphics/Types.hpp55 symbols
SIBR_viewers/src/core/graphics/Image.hpp54 symbols
SIBR_viewers/src/core/graphics/Mesh.cpp50 symbols
SIBR_viewers/src/core/system/CommandLineArgs.hpp46 symbols
SIBR_viewers/src/core/graphics/Texture.hpp40 symbols
encoders/lseg_encoder/modules/models/lseg_vit_zs.py38 symbols
SIBR_viewers/src/core/assets/InputCamera.cpp38 symbols
scene/gaussian_model.py31 symbols
SIBR_viewers/src/core/view/interface/Interface.cpp30 symbols

For agents

$ claude mcp add feature-3dgs \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page