Skip to main content

K-Planes nerfstudio integration

Project description

PyPI version license

K-Planes nerfstudio integration

This repository provides code to integrate the K-Planes model into nerfstudio.

It provides an alternative way to use k-planes in addition to the official repository, which allows access to nerfstudio's in-browser viewer and additional training capabilities. Beware that some details about the training procedure differ from the official repository.

Installation

  1. Install nerfstudio. This is pip install nerfstudio, but there are a few dependencies (e.g. torch, tinycudann) which may require further steps, so make sure to check their installation guide!
  2. Install the k-planes nerfstudio integration (this repository): pip install kplanes-nerfstudio

Included Models

Two models are included here:

  • kplanes which is tuned for the Synthetic NeRF dataset (i.e. chair, drums, etc.)
  • kplanes-dynamic which is tuned to the DNeRF dataset (dynamic, monocular video).

:exclamation: PRs are welcome for configurations tuned to different datasets :exclamation:

You can run the static model by calling (remember to use the correct data directory!)

ns-train kplanes --data <data-folder>

and connect to the viewer using the link provided in the output of the training script.

Benchmarks

Synthetic NeRF (hybrid model)

drums materials ficus ship mic chair lego hotdog AVG
PSNR 26.31 29.82 32.47 30.27 33.73 34.98 36.56 36.77 32.61
SSIM 0.9394 0.9539 0.9788 0.8755 0.9857 0.9824 0.982 0.9792 0.9596

DNeRF (hybrid model)

hell warrior mutant hook balls lego t-rex stand up jumping jacks AVG
PSNR 25.06 34.29 28.22 43.02 27.03 33.59 34.04 33.43 32.33
SSIM 0.9487 0.9839 0.9552 0.9954 0.956 0.9817 0.9835 0.9797 0.973

Roadmap

Expected future updates to this repository:

  • Including all datasets used in the K-Planes paper
  • Clarifying configuration of colliders (near-far)
  • Add benchmarks and configs for linear models

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

kplanes_nerfstudio-0.5.2.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

kplanes_nerfstudio-0.5.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file kplanes_nerfstudio-0.5.2.tar.gz.

File metadata

  • Download URL: kplanes_nerfstudio-0.5.2.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.9

File hashes

Hashes for kplanes_nerfstudio-0.5.2.tar.gz
Algorithm Hash digest
SHA256 722849c0994cd190df96b9bd8799e7cd15a58bbf2d15a3a3c2f198df22408d11
MD5 64f72ddbc827d08337396cf22b9057f6
BLAKE2b-256 c0987bc4632f2987473dca13224950850c7e1fae1e1ff15011f260cf604490e4

See more details on using hashes here.

File details

Details for the file kplanes_nerfstudio-0.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for kplanes_nerfstudio-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8481fdc521808283e4700f11616e6d1e1b953d442369e6313904b669bb04f0d5
MD5 079f15c555557c9037f04e174bfd4c2c
BLAKE2b-256 eef92d225da89bfe8e9f2bdcaa81b1f5ca107d33cc66f6912d90898a9448c1bf

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