4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 02:24:38 +08:00
nerfstudio/index.html
2025-07-29 02:30:47 +00:00

714 lines
46 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html class="no-js" lang="en" >
<head><meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta property="og:title" content="Contents" />
<meta property="og:type" content="website" />
<meta property="og:url" content="http://docs.nerf.studio/index.html" />
<meta property="og:description" content="Nerfstudio Documentation" />
<meta property="og:image" content="https://assets.nerf.studio/opg.png" />
<meta property="og:image:alt" content="Contents" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="quickstart/installation.html" />
<meta name="generator" content="sphinx-5.2.1, furo 2022.09.29" />
<title>nerfstudio</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f9fb;
--color-code-foreground: black;
--color-brand-primary: #d34600;
--color-brand-content: #ff6f00;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #282C34;
--color-code-foreground: #ABB2BF;
--color-brand-primary: #fdd06c;
--color-brand-content: ##fea96a;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #282C34;
--color-code-foreground: #ABB2BF;
--color-brand-primary: #fdd06c;
--color-brand-content: ##fea96a;
}
}
}
</style><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="_static/design-tabs.js"></script>
<script src="_static/require.min.js"></script>
<script src="_static/custom.js"></script>
</head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">nerfstudio</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a
class="sidebar-brand"
href="#"
>
<div class="sidebar-logo-container">
<img
class="sidebar-logo only-light"
src="_static/imgs/logo.png"
alt="Light Logo"
/>
<img
class="sidebar-logo only-dark"
src="_static/imgs/logo-dark.png"
alt="Dark Logo"
/>
</div>
</a>
<div style="text-align: center">
<script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- Place this tag where you want the button to render. -->
<a
class="github-button"
href="https://github.com/nerfstudio-project/nerfstudio/"
data-color-scheme="no-preference: light; light: light; dark: light;"
data-size="large"
data-show-count="true"
aria-label="Download buttons/github-buttons on GitHub"
>
Github
</a>
<br />
<a
href="https://colab.research.google.com/github/nerfstudio-project/nerfstudio/blob/main/colab/demo.ipynb"
style="
background-color: #ebf0f4;
background-image: linear-gradient(180deg, #f6f8fa, #ebf0f4 90%);
border-radius: 3px;
border: 1px solid #1b1f2426;
display: inline-flex;
cursor: pointer;
color: #0d0d0d;
font-family: Arial;
font-size: 12px;
font-weight: bold;
padding: 5px 41px;
line-height: 16px;
text-decoration: none;
"
>
<svg
viewBox="0 0 24 24"
width="16"
height="16"
class="octicon octicon-mark-github"
>
<g>
<path
d="M4.54,9.46,2.19,7.1a6.93,6.93,0,0,0,0,9.79l2.36-2.36A3.59,3.59,0,0,1,4.54,9.46Z"
style=""
fill="#E8710A"
></path>
<path
d="M2.19,7.1,4.54,9.46a3.59,3.59,0,0,1,5.08,0l1.71-2.93h0l-.1-.08h0A6.93,6.93,0,0,0,2.19,7.1Z"
style=""
fill="#F9AB00"
></path>
<path
d="M11.34,17.46h0L9.62,14.54a3.59,3.59,0,0,1-5.08,0L2.19,16.9a6.93,6.93,0,0,0,9,.65l.11-.09"
style=""
fill="#F9AB00"
></path>
<path
d="M12,7.1a6.93,6.93,0,0,0,0,9.79l2.36-2.36a3.59,3.59,0,1,1,5.08-5.08L21.81,7.1A6.93,6.93,0,0,0,12,7.1Z"
style=""
fill="#F9AB00"
></path>
<path
d="M21.81,7.1,19.46,9.46a3.59,3.59,0,0,1-5.08,5.08L12,16.9A6.93,6.93,0,0,0,21.81,7.1Z"
style=""
fill="#E8710A"
></path>
</g>
</svg>
<span>&nbspcolab</span></a
>
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/first_nerf.html">Training your first model</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/existing_dataset.html">Using existing data</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/custom_dataset.html">Using custom data</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/viewer_quickstart.html">Using the viewer</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/export_geometry.html">Export geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/data_conventions.html">Data conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/contributing.html">Contributing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Extensions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="extensions/blender_addon.html">Blender VFX add-on</a></li>
<li class="toctree-l1"><a class="reference internal" href="extensions/maya_plugin.html">Autodesk Maya Plug-in</a></li>
<li class="toctree-l1"><a class="reference internal" href="extensions/unreal_engine.html">Exporting to Unreal Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="extensions/sdfstudio.html">SDFStudio</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">NeRFology</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="nerfology/methods/index.html">Methods</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/instant_ngp.html"> Instant-NGP</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/splat.html"> Splatfacto</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/splatw.html"> Splatfacto-W</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/in2n.html"> Instruct-NeRF2NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/igs2gs.html"> Instruct-GS2GS</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/signerf.html"> SIGNeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/kplanes.html"> K-Planes</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/lerf.html"> LERF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/livescene.html"> LiveScene</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/feature_splatting.html"> Feature-Splatting</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/mipnerf.html"> Mip-NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/nerf.html"> NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/nerfacto.html"> Nerfacto</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/nerfbusters.html"> Nerfbusters</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/nerfplayer.html"> NeRFPlayer</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/tetranerf.html"> Tetra-NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/tensorf.html"> TensoRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/generfacto.html"> Generfacto</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/pynerf.html"> PyNeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/seathru_nerf.html"> SeaThru-NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/zipnerf.html"> Zip-NeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/bionerf.html"> BioNeRF</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/nerf2gs2nerf.html"> NeRFtoGSandBack</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/methods/opennerf.html"> OpenNeRF</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="nerfology/model_components/index.html">Model components</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="nerfology/model_components/visualize_cameras.html"> Cameras models</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/model_components/visualize_samples.html"> Sample representation</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/model_components/visualize_samplers.html"> Ray samplers</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/model_components/visualize_spatial_distortions.html"> Spatial distortions</a></li>
<li class="toctree-l2"><a class="reference internal" href="nerfology/model_components/visualize_encoders.html"> Encoders</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developer_guides/new_methods.html">Adding a New Method</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="developer_guides/pipelines/index.html">Pipelines overview</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="developer_guides/pipelines/dataparsers.html">DataParsers</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/api/data/dataparsers.html">Data Parsers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/pipelines/datamanagers.html">DataManagers</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/pipelines/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/pipelines/fields.html">Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/pipelines/pipelines.html">Pipelines</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="developer_guides/viewer/index.html">Viewer</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/viewer/custom_gui.html">Custom GUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/viewer/viewer_control.html">Python Viewer Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/viewer/local_viewer.html">(Legacy Viewer) Local Server</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer_guides/config.html">Customizable configs</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="developer_guides/debugging_tools/index.html">Debugging tools</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/debugging_tools/local_logger.html">Local writer</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/debugging_tools/profiling.html">Code profiling support</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_guides/debugging_tools/benchmarking.html">Benchmarking workflow</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/cli/index.html">CLI</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_install_cli.html">ns-install-cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_process_data.html">ns-process-data</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_download_data.html">ns-download-data</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_train.html">ns-train</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_render.html">ns-render</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_viewer.html">ns-viewer</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_export.html">ns-export</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/cli/ns_eval.html">ns-eval</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/api/index.html">API</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/api/cameras.html">Cameras</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/config.html">Configs</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/api/data/index.html">Data</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/api/data/dataparsers.html">Data Parsers</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/data/datamanagers.html">Datamanagers</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/data/datasets.html">Datasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/data/utils.html">Utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/fields.html">Fields</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/api/field_components/index.html">Field Modules</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/api/field_components/encodings.html">Encodings</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/field_components/embeddings.html">Embeddings</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/field_components/field_heads.html">Field Heads</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/field_components/mlp.html">MLP</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/field_components/spatial_distortions.html">Spatial Distortions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/models.html">Models</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/api/model_components/index.html">Model components</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/api/model_components/ray_sampler.html">Ray Sampler</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/model_components/losses.html">Losses</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/model_components/renderers.html">Renderers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/optimizers.html">Engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/plugins.html">Plugins</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/api/utils/index.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/api/utils/colors.html">Colors</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/utils/math.html">Math</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/utils/colormaps.html">Colormaps</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/api/utils/tensor_dataclass.html">TensorDataclass</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/api/viewer.html">Viewer</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<br/>
<a class="only-light reference internal image-reference" href="_images/logo.png"><img alt="nerfstudio" class="only-light align-center" src="_images/logo.png" style="width: 400px;" /></a>
<a class="only-dark reference internal image-reference" href="_images/logo-dark.png"><img alt="nerfstudio" class="only-dark align-center" src="_images/logo-dark.png" style="width: 400px;" /></a>
<br/>
<p><a class="reference internal" href="https://user-images.githubusercontent.com/3310961/194017985-ade69503-9d68-46a2-b518-2db1a012f090.gif"><img alt="https://user-images.githubusercontent.com/3310961/194017985-ade69503-9d68-46a2-b518-2db1a012f090.gif" src="https://user-images.githubusercontent.com/3310961/194017985-ade69503-9d68-46a2-b518-2db1a012f090.gif" style="width: 52%;" /></a> <a class="reference internal" href="https://user-images.githubusercontent.com/3310961/194020648-7e5f380c-15ca-461d-8c1c-20beb586defe.gif"><img alt="https://user-images.githubusercontent.com/3310961/194020648-7e5f380c-15ca-461d-8c1c-20beb586defe.gif" src="https://user-images.githubusercontent.com/3310961/194020648-7e5f380c-15ca-461d-8c1c-20beb586defe.gif" style="width: 46%;" /></a></p>
<br/>
<p>Nerfstudio provides a simple API that allows for a simplified end-to-end process of creating, training, and testing NeRFs.
The library supports a <strong>more interpretable implementation of NeRFs by modularizing each component.</strong>
With more modular NeRFs, we hope to create a more user-friendly experience in exploring the technology.</p>
<p>This is a contributor-friendly repo with the goal of building a community where users can more easily build upon each other’s contributions.
Nerfstudio initially launched as an opensource project by Berkeley students in <a class="reference external" href="https://people.eecs.berkeley.edu/~kanazawa/index.html#kair">KAIR lab</a> at <a class="reference external" href="https://bair.berkeley.edu/">Berkeley AI Research (BAIR)</a> in October 2022 as a part of a research project (<a class="reference external" href="https://arxiv.org/abs/2302.04264">paper</a>). It is currently developed by Berkeley students and community contributors.</p>
<p>We are committed to providing learning resources to help you understand the basics of (if you’re just getting started), 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!</p>
<p>Have feature requests? Want to add your brand-spankin’-new NeRF model? Have a new dataset? <strong>We welcome <a class="reference internal" href="reference/contributing.html"><span class="doc std std-doc">contributions</span></a>!</strong>
Please do not hesitate to reach out to the nerfstudio team with any questions via <a class="reference external" href="https://discord.gg/uMbNqcraFc">Discord</a>.</p>
<p>Have feedback? We’d love for you to fill out our <a class="reference external" href="https://forms.gle/sqN5phJN7LfQVwnP9">Nerfstudio Feedback Form</a> if you want to let us know who you are, why you are interested in Nerfstudio, or provide any feedback!</p>
<p>We hope nerfstudio enables you to build faster 🔨 learn together 📚 and contribute to our NeRF community 💖.</p>
<section id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this heading">#</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<p>This documentation is organized into 3 parts:</p>
<ul class="simple">
<li><p><strong>🏃‍♀️ Getting Started</strong>: 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.</p></li>
<li><p><strong>🧪 Nerfology</strong>: 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.</p></li>
<li><p><strong>🤓 Developer Guides</strong>: describe 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.</p></li>
<li><p><strong>📚 Reference</strong>: 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.</p></li>
</ul>
</section>
<section id="supported-methods">
<h1>Supported Methods<a class="headerlink" href="#supported-methods" title="Permalink to this heading">#</a></h1>
<section id="included-methods">
<h2>Included Methods<a class="headerlink" href="#included-methods" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="nerfology/methods/nerfacto.html"><span class="doc std std-doc"><strong>Nerfacto</strong></span></a>: Recommended method, integrates multiple methods into one.</p></li>
<li><p><a class="reference internal" href="nerfology/methods/instant_ngp.html"><span class="doc std std-doc">Instant-NGP</span></a>: Instant Neural Graphics Primitives with a Multiresolution Hash Encoding</p></li>
<li><p><a class="reference internal" href="nerfology/methods/nerf.html"><span class="doc std std-doc">NeRF</span></a>: OG Neural Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/mipnerf.html"><span class="doc std std-doc">Mip-NeRF</span></a>: A Multiscale Representation for Anti-Aliasing Neural Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/tensorf.html"><span class="doc std std-doc">TensoRF</span></a>: Tensorial Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/splat.html"><span class="doc std std-doc">Splatfacto</span></a>: Nerfstudio’s Gaussian Splatting implementation</p></li>
</ul>
</section>
<section id="third-party-methods">
<span id="id1"></span><h2>Third-party Methods<a class="headerlink" href="#third-party-methods" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="nerfology/methods/bionerf.html"><span class="doc std std-doc">BioNeRF</span></a>: Biologically Plausible Neural Radiance Fields for View Synthesis</p></li>
<li><p><a class="reference internal" href="nerfology/methods/in2n.html"><span class="doc std std-doc">Instruct-NeRF2NeRF</span></a>: Editing 3D Scenes with Instructions</p></li>
<li><p><a class="reference internal" href="nerfology/methods/igs2gs.html"><span class="doc std std-doc">Instruct-GS2GS</span></a>: Editing 3DGS Scenes with Instructions</p></li>
<li><p><a class="reference internal" href="nerfology/methods/signerf.html"><span class="doc std std-doc">SIGNeRF</span></a>: Controlled Generative Editing of NeRF Scenes</p></li>
<li><p><a class="reference internal" href="nerfology/methods/kplanes.html"><span class="doc std std-doc">K-Planes</span></a>: Unified 3D and 4D Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/lerf.html"><span class="doc std std-doc">LERF</span></a>: Language Embedded Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/livescene.html"><span class="doc std std-doc">LiveScene</span></a>: Language Embedding Interactive Radiance Fields for Physical Scene Rendering and Control</p></li>
<li><p><a class="reference internal" href="nerfology/methods/feature_splatting.html"><span class="doc std std-doc">Feature Splatting</span></a>: Gaussian Feature Splatting based on GSplats</p></li>
<li><p><a class="reference internal" href="nerfology/methods/nerfbusters.html"><span class="doc std std-doc">Nerfbusters</span></a>: Removing Ghostly Artifacts from Casually Captured NeRFs</p></li>
<li><p><a class="reference internal" href="nerfology/methods/nerfplayer.html"><span class="doc std std-doc">NeRFPlayer</span></a>: 4D Radiance Fields by Streaming Feature Channels</p></li>
<li><p><a class="reference internal" href="nerfology/methods/tetranerf.html"><span class="doc std std-doc">Tetra-NeRF</span></a>: Representing Neural Radiance Fields Using Tetrahedra</p></li>
<li><p><a class="reference internal" href="nerfology/methods/pynerf.html"><span class="doc std std-doc">PyNeRF</span></a>: Pyramidal Neural Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/seathru_nerf.html"><span class="doc std std-doc">SeaThru-NeRF</span></a>: Neural Radiance Field for subsea scenes</p></li>
<li><p><a class="reference internal" href="nerfology/methods/zipnerf.html"><span class="doc std std-doc">Zip-NeRF</span></a>: Anti-Aliased Grid-Based Neural Radiance Fields</p></li>
<li><p><a class="reference internal" href="nerfology/methods/nerf2gs2nerf.html"><span class="doc std std-doc">NeRFtoGSandBack</span></a>: Converting back and forth between NeRF and GS to get the best of both approaches</p></li>
<li><p><a class="reference internal" href="nerfology/methods/opennerf.html"><span class="doc std std-doc">OpenNeRF</span></a>: OpenSet 3D Neural Scene Segmentation</p></li>
</ul>
<p><strong>Eager to contribute a method?</strong> We’d love to see you use nerfstudio in implementing new (or even existing) methods! Please view our <a class="reference internal" href="nerfology/methods/index.html#own-method-docs"><span class="std std-ref">guide</span></a> for more details about how to add to this list!</p>
</section>
</section>
<section id="quicklinks">
<h1>Quicklinks<a class="headerlink" href="#quicklinks" title="Permalink to this heading">#</a></h1>
<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p></p></th>
<th class="head"><p></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/nerfstudio-project/nerfstudio">Github</a></p></td>
<td><p>Official Github Repo</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://discord.gg/RyVk6w5WWP">Discord</a></p></td>
<td><p>Join Discord Community</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://forms.gle/sqN5phJN7LfQVwnP9">Feedback Form</a></p></td>
<td><p>Provide Nerfstudio Feedback</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="sponsors">
<h1>Sponsors<a class="headerlink" href="#sponsors" title="Permalink to this heading">#</a></h1>
<p>Sponsors of this work includes <a class="reference external" href="https://lumalabs.ai/">Luma AI</a> and the <a class="reference external" href="https://bcommons.berkeley.edu/home">BAIR commons</a>.</p>
<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p></p></th>
<th class="head"><p></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://lumalabs.ai/"><img alt="Luma AI" class="only-light" src="_images/luma_light.png" style="width: 300px;" /></a><a class="reference external" href="https://lumalabs.ai/"><img alt="Luma AI" class="only-dark" src="_images/luma_dark.png" style="width: 300px;" /></a></p></td>
<td><p><a class="reference external" href="https://bcommons.berkeley.edu/home"><img alt="BAIR" class="only-light" src="_images/bair_light.png" style="width: 300px;" /></a><a class="reference external" href="https://bcommons.berkeley.edu/home"><img alt="BAIR" class="only-dark" src="_images/bair_dark.png" style="width: 300px;" /></a></p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="built-on">
<h1>Built On<a class="headerlink" href="#built-on" title="Permalink to this heading">#</a></h1>
<a class="reference external image-reference" href="https://github.com/brentyi/tyro"><img alt="tyro" class="only-light" src="https://brentyi.github.io/tyro/_static/logo-light.svg" width="150" /></a>
<a class="reference external image-reference" href="https://github.com/brentyi/tyro"><img alt="tyro" class="only-dark" src="https://brentyi.github.io/tyro/_static/logo-dark.svg" width="150" /></a>
<ul class="simple">
<li><p>Easy to use config system</p></li>
<li><p>Developed by <a class="reference external" href="https://brentyi.com/">Brent Yi</a></p></li>
</ul>
<a class="reference external image-reference" href="https://github.com/KAIR-BAIR/nerfacc"><img alt="tyro" class="only-light" src="https://user-images.githubusercontent.com/3310961/199084143-0d63eb40-3f35-48d2-a9d5-78d1d60b7d66.png" style="width: 250px;" /></a>
<a class="reference external image-reference" href="https://github.com/KAIR-BAIR/nerfacc"><img alt="tyro" class="only-dark" src="https://user-images.githubusercontent.com/3310961/199083722-881a2372-62c1-4255-8521-31a95a721851.png" style="width: 250px;" /></a>
<ul class="simple">
<li><p>Library for accelerating NeRF renders</p></li>
<li><p>Developed by <a class="reference external" href="https://www.liruilong.cn/">Ruilong Li</a></p></li>
</ul>
</section>
<section id="citation">
<h1>Citation<a class="headerlink" href="#citation" title="Permalink to this heading">#</a></h1>
<p>You can find a paper writeup of the framework on <a class="reference external" href="https://arxiv.org/abs/2302.04264">arXiv</a>.</p>
<p>If you use this library or find the documentation useful for your research, please consider citing:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>@inproceedings{nerfstudio,
title = {Nerfstudio: A Modular Framework for Neural Radiance Field Development},
author = {
Tancik, Matthew and Weber, Ethan and Ng, Evonne and Li, Ruilong and Yi, Brent
and Kerr, Justin and Wang, Terrance and Kristoffersen, Alexander and Austin,
Jake and Salahi, Kamyar and Ahuja, Abhik and McAllister, David and Kanazawa,
Angjoo
},
year = 2023,
booktitle = {ACM SIGGRAPH 2023 Conference Proceedings},
series = {SIGGRAPH &#39;23}
}
</pre></div>
</div>
</section>
<section id="contributors">
<h1>Contributors<a class="headerlink" href="#contributors" title="Permalink to this heading">#</a></h1>
<a href="https://github.com/nerfstudio-project/nerfstudio/graphs/contributors">
<img src="https://contrib.rocks/image?repo=nerfstudio-project/nerfstudio" />
</a>
</section>
<section id="maintainers">
<h1>Maintainers<a class="headerlink" href="#maintainers" title="Permalink to this heading">#</a></h1>
<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p></p></th>
<th class="head"><p>Nerfstudio Discord</p></th>
<th class="head"><p>Affiliation</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://kerrj.github.io/">Justin Kerr</a></p></td>
<td><p>justin.kerr</p></td>
<td><p>UC Berkeley</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://jkulhanek.com/">Jonáš Kulhánek</a></p></td>
<td><p>jkulhanek</p></td>
<td><p>Czech Technical University in Prague</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://www.matthewtancik.com">Matt Tancik</a></p></td>
<td><p>tancik</p></td>
<td><p>Luma AI</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://maturk.github.io/">Matias Turkulainen</a></p></td>
<td><p>maturk</p></td>
<td><p>ETH Zurich</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://ethanweber.me/">Ethan Weber</a></p></td>
<td><p>ethanweber</p></td>
<td><p>UC Berkeley</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/brentyi">Brent Yi</a></p></td>
<td><p>brent</p></td>
<td><p>UC Berkeley</p></td>
</tr>
</tbody>
</table>
</div>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="quickstart/installation.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Installation</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, nerfstudio Team
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Contents</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#supported-methods">Supported Methods</a><ul>
<li><a class="reference internal" href="#included-methods">Included Methods</a></li>
<li><a class="reference internal" href="#third-party-methods">Third-party Methods</a></li>
</ul>
</li>
<li><a class="reference internal" href="#quicklinks">Quicklinks</a></li>
<li><a class="reference internal" href="#sponsors">Sponsors</a></li>
<li><a class="reference internal" href="#built-on">Built On</a></li>
<li><a class="reference internal" href="#citation">Citation</a></li>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
<li><a class="reference internal" href="#maintainers">Maintainers</a></li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div></body>
</html>