https://docs.nerf.studio/en/latest/index.html

[ ] [ ]
Hide navigation sidebar
Hide table of contents sidebar
Toggle site navigation sidebar
 
nerfstudio
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar
 
Light Logo Dark Logo
Github
[                    ] 
Getting Started

  * Installation
  * Training your first model
  * Using custom data
  * Using the viewer
  * Contributing

NeRFology

  * Methods[ ]
    Toggle child pages in navigation
      + NeRF
      + Mip-NeRF
      + Nerfacto
      + Instant-NGP
      + Semantic NeRF-W
  * Model components[ ]
    Toggle child pages in navigation
      + Cameras models
      + Sample representation
      + Ray samplers
      + Spatial distortions
      + Encoders

Developer Guides

  * Pipelines overview[ ]
    Toggle child pages in navigation
      + DataParsers
      + DataManagers
      + Models
      + Fields
      + Pipelines
  * Viewer overview
  * Customizable configs
  * Debugging tools[ ]
    Toggle child pages in navigation
      + Local writer
      + Code profiling support
      + Benchmarking workflow

Reference

  * CLI[ ]
    Toggle child pages in navigation
      + ns-process-data
      + ns-download-data
      + ns-train
      + ns-render
      + ns-eval
  * API[ ]
    Toggle child pages in navigation
      + Configs
      + Data
      + Fields
      + Field Modules[ ]
        Toggle child pages in navigation
          o Encodings
          o Embeddings
          o Field Heads
          o MLP
          o Spatial Distortions
      + Models
      + Model components[ ]
        Toggle child pages in navigation
          o Ray Sampler
          o Losses
          o Renderers
      + Engine
      + Utils[ ]
        Toggle child pages in navigation
          o Colors
          o Math
          o Colormaps
          o TensorDataclass
      + Viewer

  v: latest

Versions
    latest

Downloads

On Read the Docs
    Project Home
    Builds

Back to top
Edit this page
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar

nerfstudio nerfstudio

https://user-images.githubusercontent.com/3310961/
194017985-ade69503-9d68-46a2-b518-2db1a012f090.gif https://
user-images.githubusercontent.com/3310961/
194020648-7e5f380c-15ca-461d-8c1c-20beb586defe.gif


Nerfstudio provides a simple API that allows for a simplified
end-to-end process of creating, training, and visualizing NeRFs. The
library supports an interpretable implementation of NeRFs by
modularizing each component. With modular NeRF components, we hope to
create a user-friendly experience in exploring the technology.
Nerfstudio is a contributer friendly repo with the goal of building a
community where users can easily build upon each other's
contributions.

It's as simple as plug and play with nerfstudio!

On top of our API, we are commited to providing learning resources to
help you understand the basics of (if you're just getting start), and
keep up-to-date with (if you're a seasoned veteran) all things NeRF.
As researchers, we know just how hard it is to get onboarded with
this next-gen technology. So we're here to help with tutorials,
documentation, and more!

Finally, have feature requests? Want to add your brand-spankin'-new
NeRF model? Have a new dataset? We welcome any and all contributions!
Please do not hesitate to reach out to the nerfstudio team with any
questions via Discord.

We hope nerfstudio enables you to build faster  learn together  and
contribute to our NeRF community .

Contents#

This documentation is organized into 3 parts:

  * [?] Getting Started: a great place to start if you are new to
    nerfstudio. Contains a quick tour, installation, and an overview
    of the core structures that will allow you to get up and running
    with nerfstudio.

  *  Nerfology: want to learn more about the tech itself? We're here
    to help with our educational guides. We've provided some
    interactive notebooks that walk you through what each component
    is all about.

  *  Developer Guides: describes all of the components and
    additional support we provide to help you construct, train, and
    debug your NeRFs. Learn how to set up a model pipeline, use the
    viewer, create a custom config, and more.

  *  Reference: describes each class and function. Develop a better
    understanding of the core of our technology and terminology. This
    section includes descriptions of each module and component in the
    codebase.

Supported Methods#

  * Nerfacto: our defacto NeRF method combines modules focused on
    quality with modules focused on faster rendering. Nerfstudio
    easily lets us experiment with the best of both worlds!

  * NeRF: Representing Scenes as Neural Radiance Fields for View
    Synthesis

  * Instant NGP: Instant Neural Graphics Primitives with a
    Multiresolution Hash Encoding

  * Mipnerf: A Multiscale Representation for Anti-Aliasing Neural
    Radiance Fields

  * NerfW: Neural Radiance Fields for Unconstrained Photo Collections

  * Semantic NeRF: In-Place Scene Labelling and Understanding with
    Implicit Scene Representation

We'll be constantly growing this list! So make sure to check back in
to see our updates.

Eager to contribute? We'd love to see you use nerfstudio in
implementing new (or even existing) methods! Feel free to contact us
directly or view our Contributor's Guide to see how you can get your
model on this list!

Quicklinks#

Github  Official Github Repo

Discord Join Discord Community

Viewer  Web-based Nerf Viewer

Built On#

dcargs

  * Easy to use config system

  * Developed by Brent Yi

nerfacc

  * Library for accelerating NeRF renders

  * Developed by Ruilong Li

Citation#

If you use this library or find the documentation useful for your
research, please conside citing:

@misc{nerfstudio,
      title={Nerfstudio: A Framework for Neural Radiance Field Development},
      author={Matthew Tancik*, Ethan Weber*, Evonne Ng*, Ruilong Li, Brent Yi, Terrance Wang, Alexander Kristoffersen, Jake Austin, Kamyar Salahi, Abhik Ahuja, David McAllister, Angjoo Kanazawa},
      year={2022},
      url={https://github.com/nerfstudio-project/nerfstudio},
}

Contributors#

[nerfstudio]
 
Next
Installation
Copyright (c) 2022, nerfstudio Team
Made with Sphinx and @pradyunsg's Furo
  
Contents

  * Contents
  * Supported Methods
  * Quicklinks
  * Built On
  * Citation
  * Contributors