Skip to main content

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

Metadata

Release files for kplanes-nerfstudio 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kplanes-nerfstudio 0.5.2
File Size Uploaded Provenance Actions
kplanes_nerfstudio-0.5.2.tar.gz 13.9 kB Without provenance Details for kplanes_nerfstudio-0.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for kplanes-nerfstudio 0.5.2
File Interpreter ABI Platform Actions
kplanes_nerfstudio-0.5.2-py3-none-any.whl Python 3 none any Details for kplanes_nerfstudio-0.5.2-py3-none-any.whl

Total release size: 28.4 kB

Release files / kplanes_nerfstudio-0.5.2.tar.gz

Download URL kplanes_nerfstudio-0.5.2.tar.gz
Size 13.9 kB
Tags Source
SHA-256 checksum
How to use checksums
722849c0994cd190df96b9bd8799e7cd15a58bbf2d15a3a3c2f198df22408d11
BLAKE2b-256 checksum
How to use checksums
c0987bc4632f2987473dca13224950850c7e1fae1e1ff15011f260cf604490e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.9

Release files / kplanes_nerfstudio-0.5.2-py3-none-any.whl

Download URL kplanes_nerfstudio-0.5.2-py3-none-any.whl
Size 14.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8481fdc521808283e4700f11616e6d1e1b953d442369e6313904b669bb04f0d5
BLAKE2b-256 checksum
How to use checksums
eef92d225da89bfe8e9f2bdcaa81b1f5ca107d33cc66f6912d90898a9448c1bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.9

Security for kplanes-nerfstudio 0.5.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page