4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-10 18:17:31 +08:00
nerfstudio/reference/api/config.html
2025-07-29 02:30:47 +00:00

793 lines
77 KiB
HTML
Raw Permalink 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="Configs" />
<meta property="og:type" content="website" />
<meta property="og:url" content="http://docs.nerf.studio/reference/api/config.html" />
<meta property="og:description" content="Base Configs" />
<meta property="og:image" content="https://assets.nerf.studio/opg.png" />
<meta property="og:image:alt" content="Configs" />
<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="Data" href="data/index.html" /><link rel="prev" title="Cameras" href="cameras.html" />
<meta name="generator" content="sphinx-5.2.1, furo 2022.09.29" />
<title>Configs - 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="../../index.html"><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="../../index.html"
>
<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="../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="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 class="current">
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../cli/ns_install_cli.html">ns-install-cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_process_data.html">ns-process-data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_download_data.html">ns-download-data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_train.html">ns-train</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_render.html">ns-render</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_viewer.html">ns-viewer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_export.html">ns-export</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cli/ns_eval.html">ns-eval</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">API</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="cameras.html">Cameras</a></li>
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Configs</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="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="data/dataparsers.html">Data Parsers</a></li>
<li class="toctree-l3"><a class="reference internal" href="data/datamanagers.html">Datamanagers</a></li>
<li class="toctree-l3"><a class="reference internal" href="data/datasets.html">Datasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="data/utils.html">Utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fields.html">Fields</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="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="field_components/encodings.html">Encodings</a></li>
<li class="toctree-l3"><a class="reference internal" href="field_components/embeddings.html">Embeddings</a></li>
<li class="toctree-l3"><a class="reference internal" href="field_components/field_heads.html">Field Heads</a></li>
<li class="toctree-l3"><a class="reference internal" href="field_components/mlp.html">MLP</a></li>
<li class="toctree-l3"><a class="reference internal" href="field_components/spatial_distortions.html">Spatial Distortions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="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="model_components/ray_sampler.html">Ray Sampler</a></li>
<li class="toctree-l3"><a class="reference internal" href="model_components/losses.html">Losses</a></li>
<li class="toctree-l3"><a class="reference internal" href="model_components/renderers.html">Renderers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="optimizers.html">Engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html">Plugins</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="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="utils/colors.html">Colors</a></li>
<li class="toctree-l3"><a class="reference internal" href="utils/math.html">Math</a></li>
<li class="toctree-l3"><a class="reference internal" href="utils/colormaps.html">Colormaps</a></li>
<li class="toctree-l3"><a class="reference internal" href="utils/tensor_dataclass.html">TensorDataclass</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="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">
<section id="configs">
<span id="id1"></span><h1>Configs<a class="headerlink" href="#configs" title="Permalink to this heading">#</a></h1>
<p>Base Configs</p>
<span class="target" id="module-nerfstudio.configs.base_config"></span><dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.InstantiateConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">InstantiateConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#InstantiateConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.InstantiateConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.configs.base_config.PrintableConfig" title="nerfstudio.configs.base_config.PrintableConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrintableConfig</span></code></a></p>
<p>Config class for instantiating an the class specified in the _target attribute.</p>
<dl class="py method">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.InstantiateConfig.setup">
<span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#InstantiateConfig.setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.InstantiateConfig.setup" title="Permalink to this definition">#</a></dt>
<dd><p>Returns the instantiated object using the config.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LocalWriterConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">LocalWriterConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_target:</span> <span class="pre">~typing.Type</span> <span class="pre">=</span> <span class="pre">&lt;class</span> <span class="pre">'nerfstudio.utils.writer.LocalWriter'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stats_to_track:</span> <span class="pre">~typing.Tuple[~nerfstudio.utils.writer.EventName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">...]</span> <span class="pre">=</span> <span class="pre">(&lt;EventName.ITER_TRAIN_TIME:</span> <span class="pre">'Train</span> <span class="pre">Iter</span> <span class="pre">(time)'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;EventName.TRAIN_RAYS_PER_SEC:</span> <span class="pre">'Train</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;EventName.CURR_TEST_PSNR:</span> <span class="pre">'Test</span> <span class="pre">PSNR'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;EventName.VIS_RAYS_PER_SEC:</span> <span class="pre">'Vis</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;EventName.TEST_RAYS_PER_SEC:</span> <span class="pre">'Test</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;EventName.ETA:</span> <span class="pre">'ETA</span> <span class="pre">(time)'&gt;)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_log_size:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#LocalWriterConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.LocalWriterConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.configs.base_config.InstantiateConfig" title="nerfstudio.configs.base_config.InstantiateConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstantiateConfig</span></code></a></p>
<p>Local Writer config</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LocalWriterConfig.enable">
<span class="sig-name descname"><span class="pre">enable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LocalWriterConfig.enable" title="Permalink to this definition">#</a></dt>
<dd><p>if True enables local logging, else disables</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LocalWriterConfig.max_log_size">
<span class="sig-name descname"><span class="pre">max_log_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LocalWriterConfig.max_log_size" title="Permalink to this definition">#</a></dt>
<dd><p>maximum number of rows to print before wrapping. if 0, will print everything.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LocalWriterConfig.setup">
<span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">banner_messages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#LocalWriterConfig.setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.LocalWriterConfig.setup" title="Permalink to this definition">#</a></dt>
<dd><p>Instantiate local writer</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>banner_messages</strong> – List of strings that always print at the bottom of screen.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LocalWriterConfig.stats_to_track">
<span class="sig-name descname"><span class="pre">stats_to_track</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">EventName</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">(&lt;EventName.ITER_TRAIN_TIME:</span> <span class="pre">'Train</span> <span class="pre">Iter</span> <span class="pre">(time)'&gt;,</span> <span class="pre">&lt;EventName.TRAIN_RAYS_PER_SEC:</span> <span class="pre">'Train</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;,</span> <span class="pre">&lt;EventName.CURR_TEST_PSNR:</span> <span class="pre">'Test</span> <span class="pre">PSNR'&gt;,</span> <span class="pre">&lt;EventName.VIS_RAYS_PER_SEC:</span> <span class="pre">'Vis</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;,</span> <span class="pre">&lt;EventName.TEST_RAYS_PER_SEC:</span> <span class="pre">'Test</span> <span class="pre">Rays</span> <span class="pre">/</span> <span class="pre">Sec'&gt;,</span> <span class="pre">&lt;EventName.ETA:</span> <span class="pre">'ETA</span> <span class="pre">(time)'&gt;)</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LocalWriterConfig.stats_to_track" title="Permalink to this definition">#</a></dt>
<dd><p>specifies which stats will be logged/printed to terminal</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">LoggingConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">relative_log_dir:</span> <span class="pre">~pathlib.Path</span> <span class="pre">=</span> <span class="pre">PosixPath('.')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps_per_log:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_buffer_size:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_writer:</span> <span class="pre">~nerfstudio.configs.base_config.LocalWriterConfig</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profiler:</span> <span class="pre">~typing.Literal['none'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'basic'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'pytorch']</span> <span class="pre">=</span> <span class="pre">'basic'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#LoggingConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.configs.base_config.PrintableConfig" title="nerfstudio.configs.base_config.PrintableConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrintableConfig</span></code></a></p>
<p>Configuration of loggers and profilers</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig.local_writer">
<span class="sig-name descname"><span class="pre">local_writer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig" title="nerfstudio.configs.base_config.LocalWriterConfig"><span class="pre">LocalWriterConfig</span></a></em><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig.local_writer" title="Permalink to this definition">#</a></dt>
<dd><p>if provided, will print stats locally. if None, will disable printing</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig.max_buffer_size">
<span class="sig-name descname"><span class="pre">max_buffer_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig.max_buffer_size" title="Permalink to this definition">#</a></dt>
<dd><p>maximum history size to keep for computing running averages of stats.
e.g. if 20, averages will be computed over past 20 occurrences.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig.profiler">
<span class="sig-name descname"><span class="pre">profiler</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'none'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'basic'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'pytorch'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'basic'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig.profiler" title="Permalink to this definition">#</a></dt>
<dd><p>how to profile the code;
“basic” - prints speed of all decorated functions at the end of a program.
“pytorch” - same as basic, but it also traces few training steps.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig.relative_log_dir">
<span class="sig-name descname"><span class="pre">relative_log_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('.')</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig.relative_log_dir" title="Permalink to this definition">#</a></dt>
<dd><p>relative path to save all logged events</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.LoggingConfig.steps_per_log">
<span class="sig-name descname"><span class="pre">steps_per_log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.LoggingConfig.steps_per_log" title="Permalink to this definition">#</a></dt>
<dd><p>number of steps between logging stats</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">MachineConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">42</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_devices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_machines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">machine_rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'auto'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'cpu'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'cuda'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'mps'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cuda'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#MachineConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.configs.base_config.PrintableConfig" title="nerfstudio.configs.base_config.PrintableConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrintableConfig</span></code></a></p>
<p>Configuration of machine setup</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.device_type">
<span class="sig-name descname"><span class="pre">device_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'cpu'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'cuda'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'mps'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cuda'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.device_type" title="Permalink to this definition">#</a></dt>
<dd><p>device type to use for training</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.dist_url">
<span class="sig-name descname"><span class="pre">dist_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'auto'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.dist_url" title="Permalink to this definition">#</a></dt>
<dd><p>distributed connection point (for DDP)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.machine_rank">
<span class="sig-name descname"><span class="pre">machine_rank</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.machine_rank" title="Permalink to this definition">#</a></dt>
<dd><p>current machine’s rank (for DDP)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.num_devices">
<span class="sig-name descname"><span class="pre">num_devices</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.num_devices" title="Permalink to this definition">#</a></dt>
<dd><p>total number of devices (e.g., gpus) available for train/eval</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.num_machines">
<span class="sig-name descname"><span class="pre">num_machines</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.num_machines" title="Permalink to this definition">#</a></dt>
<dd><p>total number of distributed machines available (for DDP)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.MachineConfig.seed">
<span class="sig-name descname"><span class="pre">seed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">42</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.MachineConfig.seed" title="Permalink to this definition">#</a></dt>
<dd><p>random seed initialization</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.PrintableConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">PrintableConfig</span></span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#PrintableConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.PrintableConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Printable Config defining str function</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nerfstudio.configs.base_config.</span></span><span class="sig-name descname"><span class="pre">ViewerConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">relative_log_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'viewer_log_filename.txt'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_port_default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">7007</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'0.0.0.0'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_rays_per_chunk</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">32768</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_num_display_images</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">512</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quit_on_train_completion</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'jpeg'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'png'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'jpeg'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">75</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">make_share_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_frustum_scale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_composite_depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/nerfstudio/configs/base_config.html#ViewerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nerfstudio.configs.base_config.PrintableConfig" title="nerfstudio.configs.base_config.PrintableConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrintableConfig</span></code></a></p>
<p>Configuration for viewer instantiation</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.camera_frustum_scale">
<span class="sig-name descname"><span class="pre">camera_frustum_scale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.1</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.camera_frustum_scale" title="Permalink to this definition">#</a></dt>
<dd><p>Scale for the camera frustums in the viewer.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.default_composite_depth">
<span class="sig-name descname"><span class="pre">default_composite_depth</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.default_composite_depth" title="Permalink to this definition">#</a></dt>
<dd><p>The default value for compositing depth. Turn off if you want to see the camera frustums without occlusions.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.image_format">
<span class="sig-name descname"><span class="pre">image_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'jpeg'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'png'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'jpeg'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.image_format" title="Permalink to this definition">#</a></dt>
<dd><p>Image format viewer should use; jpeg is lossy compression, while png is lossless.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.jpeg_quality">
<span class="sig-name descname"><span class="pre">jpeg_quality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">75</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.jpeg_quality" title="Permalink to this definition">#</a></dt>
<dd><p>Quality tradeoff to use for jpeg compression.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.make_share_url">
<span class="sig-name descname"><span class="pre">make_share_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.make_share_url" title="Permalink to this definition">#</a></dt>
<dd><p>print a shareable URL. This flag is ignored in the legacy version of the viewer.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Viewer beta feature</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.max_num_display_images">
<span class="sig-name descname"><span class="pre">max_num_display_images</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">512</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.max_num_display_images" title="Permalink to this definition">#</a></dt>
<dd><p>Maximum number of training images to display in the viewer, to avoid lag. This does not change which images are
actually used in training/evaluation. If -1, display all.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.num_rays_per_chunk">
<span class="sig-name descname"><span class="pre">num_rays_per_chunk</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">32768</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.num_rays_per_chunk" title="Permalink to this definition">#</a></dt>
<dd><p>number of rays per chunk to render with viewer</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.quit_on_train_completion">
<span class="sig-name descname"><span class="pre">quit_on_train_completion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.quit_on_train_completion" title="Permalink to this definition">#</a></dt>
<dd><p>Whether to kill the training job when it has completed. Note this will stop rendering in the viewer.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.relative_log_filename">
<span class="sig-name descname"><span class="pre">relative_log_filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'viewer_log_filename.txt'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.relative_log_filename" title="Permalink to this definition">#</a></dt>
<dd><p>Filename to use for the log file.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.websocket_host">
<span class="sig-name descname"><span class="pre">websocket_host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'0.0.0.0'</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_host" title="Permalink to this definition">#</a></dt>
<dd><p>The host address to bind the websocket server to.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.websocket_port">
<span class="sig-name descname"><span class="pre">websocket_port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_port" title="Permalink to this definition">#</a></dt>
<dd><p>The websocket port to connect to. If None, find an available port.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nerfstudio.configs.base_config.ViewerConfig.websocket_port_default">
<span class="sig-name descname"><span class="pre">websocket_port_default</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7007</span></em><a class="headerlink" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_port_default" title="Permalink to this definition">#</a></dt>
<dd><p>The default websocket port to connect to if websocket_port is not specified</p>
</dd></dl>
</dd></dl>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="data/index.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Data</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="cameras.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Cameras</div>
</div>
</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="#">Configs</a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.InstantiateConfig"><code class="docutils literal notranslate"><span class="pre">InstantiateConfig</span></code></a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.InstantiateConfig.setup"><code class="docutils literal notranslate"><span class="pre">InstantiateConfig.setup()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig"><code class="docutils literal notranslate"><span class="pre">LocalWriterConfig</span></code></a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig.enable"><code class="docutils literal notranslate"><span class="pre">LocalWriterConfig.enable</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig.max_log_size"><code class="docutils literal notranslate"><span class="pre">LocalWriterConfig.max_log_size</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig.setup"><code class="docutils literal notranslate"><span class="pre">LocalWriterConfig.setup()</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LocalWriterConfig.stats_to_track"><code class="docutils literal notranslate"><span class="pre">LocalWriterConfig.stats_to_track</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig"><code class="docutils literal notranslate"><span class="pre">LoggingConfig</span></code></a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig.local_writer"><code class="docutils literal notranslate"><span class="pre">LoggingConfig.local_writer</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig.max_buffer_size"><code class="docutils literal notranslate"><span class="pre">LoggingConfig.max_buffer_size</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig.profiler"><code class="docutils literal notranslate"><span class="pre">LoggingConfig.profiler</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig.relative_log_dir"><code class="docutils literal notranslate"><span class="pre">LoggingConfig.relative_log_dir</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.LoggingConfig.steps_per_log"><code class="docutils literal notranslate"><span class="pre">LoggingConfig.steps_per_log</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig"><code class="docutils literal notranslate"><span class="pre">MachineConfig</span></code></a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.device_type"><code class="docutils literal notranslate"><span class="pre">MachineConfig.device_type</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.dist_url"><code class="docutils literal notranslate"><span class="pre">MachineConfig.dist_url</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.machine_rank"><code class="docutils literal notranslate"><span class="pre">MachineConfig.machine_rank</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.num_devices"><code class="docutils literal notranslate"><span class="pre">MachineConfig.num_devices</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.num_machines"><code class="docutils literal notranslate"><span class="pre">MachineConfig.num_machines</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.MachineConfig.seed"><code class="docutils literal notranslate"><span class="pre">MachineConfig.seed</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.PrintableConfig"><code class="docutils literal notranslate"><span class="pre">PrintableConfig</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig"><code class="docutils literal notranslate"><span class="pre">ViewerConfig</span></code></a><ul>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.camera_frustum_scale"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.camera_frustum_scale</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.default_composite_depth"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.default_composite_depth</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.image_format"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.image_format</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.jpeg_quality"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.jpeg_quality</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.make_share_url"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.make_share_url</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.max_num_display_images"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.max_num_display_images</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.num_rays_per_chunk"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.num_rays_per_chunk</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.quit_on_train_completion"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.quit_on_train_completion</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.relative_log_filename"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.relative_log_filename</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_host"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.websocket_host</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_port"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.websocket_port</span></code></a></li>
<li><a class="reference internal" href="#nerfstudio.configs.base_config.ViewerConfig.websocket_port_default"><code class="docutils literal notranslate"><span class="pre">ViewerConfig.websocket_port_default</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div></body>
</html>