build based on 09c734d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-15T15:11:37","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-05T14:29:59","documenter_version":"1.2.1"}}

dev/encoding/index.html

@@ -10,4 +10,4 @@
 ∇[2] # Gradient w.r.t. θ.</code></pre><p>It is done this way to dispatch to a different kernel that in the forward pass precomputes necessary values for the backward pass to speed things up.</p><p>See <a href="#NerfUtils.GridEncoding"><code>GridEncoding</code></a> docs for the description of each argument during instantiation as you might want to configure number of levels, their resolution and feature dimensions.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NerfUtils.GridEncoding" href="#NerfUtils.GridEncoding"><code>NerfUtils.GridEncoding</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">function GridEncoding(
     kab; n_dims::Int = 3, n_levels::Int = 16, scale::Float32 = 1.5f0,
     base_resolution::Int = 16, n_features::Int = 2, hashmap_size::Int = 19,
-    align_corners::Bool = true, store_level_ids::Bool = false)</code></pre><p>Multiresolution Hash Encoding</p><p><strong>Arguments:</strong></p><ul><li><code>kab</code>: Backend on which to instantiate <code>GridEncoding</code>.</li><li><code>n_dims::Int</code>: Number of input dimensions (e.g. for 3D points it must be 3).</li><li><code>n_levels::Int</code>: Number of levels in the grid. Higher number of levels   results in better accuracy at the expense of device memory.</li><li><code>scale::Float32</code>: By how much to scale each next level in size.</li><li><code>base_resolution::Int</code>: Initial resolution (1st level).</li><li><code>n_features::Int</code>: Size of the features at each level.</li><li><code>hashmap_size::Int</code>: log₂ size of the level at which it will switch from   one-to-one mapping to hashing.</li><li><code>align_corners::Bool</code>: If <code>true</code> then grid corners when scaling inputs   to a respective level resolution.</li><li><code>store_level_ids::Bool</code>: If <code>true</code> <code>GridEncoding</code> will store mapping id   from each feature to its level in the grid. This allows implementing   <code>GridEncoding</code> parameter decay as <code>mean(scatter(mean, θ.^2, level_ids))</code>.   Indices are stored in <code>Int8</code> type to reduce memory usage.</li></ul><p><strong>Reference:</strong></p><p><a href="https://nvlabs.github.io/instant-ngp/">https://nvlabs.github.io/instant-ngp/</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl/blob/4993ce88ddb95f3090ad31e9977322263babb08d/src/encoding/grid_encoding.jl#L4-L33">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../mlp/">MLP »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Wednesday 15 November 2023 15:11">Wednesday 15 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    align_corners::Bool = true, store_level_ids::Bool = false)</code></pre><p>Multiresolution Hash Encoding</p><p><strong>Arguments:</strong></p><ul><li><code>kab</code>: Backend on which to instantiate <code>GridEncoding</code>.</li><li><code>n_dims::Int</code>: Number of input dimensions (e.g. for 3D points it must be 3).</li><li><code>n_levels::Int</code>: Number of levels in the grid. Higher number of levels   results in better accuracy at the expense of device memory.</li><li><code>scale::Float32</code>: By how much to scale each next level in size.</li><li><code>base_resolution::Int</code>: Initial resolution (1st level).</li><li><code>n_features::Int</code>: Size of the features at each level.</li><li><code>hashmap_size::Int</code>: log₂ size of the level at which it will switch from   one-to-one mapping to hashing.</li><li><code>align_corners::Bool</code>: If <code>true</code> then grid corners when scaling inputs   to a respective level resolution.</li><li><code>store_level_ids::Bool</code>: If <code>true</code> <code>GridEncoding</code> will store mapping id   from each feature to its level in the grid. This allows implementing   <code>GridEncoding</code> parameter decay as <code>mean(scatter(mean, θ.^2, level_ids))</code>.   Indices are stored in <code>Int8</code> type to reduce memory usage.</li></ul><p><strong>Reference:</strong></p><p><a href="https://nvlabs.github.io/instant-ngp/">https://nvlabs.github.io/instant-ngp/</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl/blob/09c734dea13fa872cd5a4ddb17936b369bac2f1d/src/encoding/grid_encoding.jl#L4-L33">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../mlp/">MLP »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 5 December 2023 14:29">Tuesday 5 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · NerfUtils.jl</title><meta name="title" content="Home · NerfUtils.jl"/><meta property="og:title" content="Home · NerfUtils.jl"/><meta property="twitter:title" content="Home · NerfUtils.jl"/><meta name="description" content="Documentation for NerfUtils.jl."/><meta property="og:description" content="Documentation for NerfUtils.jl."/><meta property="twitter:description" content="Documentation for NerfUtils.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>NerfUtils.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Requirements"><span>Requirements</span></a></li><li><a class="tocitem" href="#Backends"><span>Backends</span></a></li></ul></li><li><a class="tocitem" href="encoding/">Encoding</a></li><li><a class="tocitem" href="mlp/">MLP</a></li><li><a class="tocitem" href="rendering/">Rendering</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="NerfUtils.jl"><a class="docs-heading-anchor" href="#NerfUtils.jl">NerfUtils.jl</a><a id="NerfUtils.jl-1"></a><a class="docs-heading-anchor-permalink" href="#NerfUtils.jl" title="Permalink"></a></h1><p>Reusable NeRF components.</p><h2 id="Requirements"><a class="docs-heading-anchor" href="#Requirements">Requirements</a><a id="Requirements-1"></a><a class="docs-heading-anchor-permalink" href="#Requirements" title="Permalink"></a></h2><ul><li>Julia 1.9 or higher.</li><li>AMD or Nvidia GPU (supported by AMDGPU.jl or CUDA.jl respectively).</li></ul><h2 id="Backends"><a class="docs-heading-anchor" href="#Backends">Backends</a><a id="Backends-1"></a><a class="docs-heading-anchor-permalink" href="#Backends" title="Permalink"></a></h2><p>When using components from this library you have to pass:</p><ul><li><code>ROCBackend()</code> from AMDGPU.jl package or</li><li><code>CUDABackend()</code> from CUDA.jl package</li></ul><p>to use respective GPU.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="encoding/">Encoding »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Wednesday 15 November 2023 15:11">Wednesday 15 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · NerfUtils.jl</title><meta name="title" content="Home · NerfUtils.jl"/><meta property="og:title" content="Home · NerfUtils.jl"/><meta property="twitter:title" content="Home · NerfUtils.jl"/><meta name="description" content="Documentation for NerfUtils.jl."/><meta property="og:description" content="Documentation for NerfUtils.jl."/><meta property="twitter:description" content="Documentation for NerfUtils.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>NerfUtils.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Requirements"><span>Requirements</span></a></li><li><a class="tocitem" href="#Backends"><span>Backends</span></a></li></ul></li><li><a class="tocitem" href="encoding/">Encoding</a></li><li><a class="tocitem" href="mlp/">MLP</a></li><li><a class="tocitem" href="rendering/">Rendering</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaNeuralGraphics/NerfUtils.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="NerfUtils.jl"><a class="docs-heading-anchor" href="#NerfUtils.jl">NerfUtils.jl</a><a id="NerfUtils.jl-1"></a><a class="docs-heading-anchor-permalink" href="#NerfUtils.jl" title="Permalink"></a></h1><p>Reusable NeRF components.</p><h2 id="Requirements"><a class="docs-heading-anchor" href="#Requirements">Requirements</a><a id="Requirements-1"></a><a class="docs-heading-anchor-permalink" href="#Requirements" title="Permalink"></a></h2><ul><li>Julia 1.9 or higher.</li><li>AMD or Nvidia GPU (supported by AMDGPU.jl or CUDA.jl respectively).</li></ul><h2 id="Backends"><a class="docs-heading-anchor" href="#Backends">Backends</a><a id="Backends-1"></a><a class="docs-heading-anchor-permalink" href="#Backends" title="Permalink"></a></h2><p>When using components from this library you have to pass:</p><ul><li><code>ROCBackend()</code> from AMDGPU.jl package or</li><li><code>CUDABackend()</code> from CUDA.jl package</li></ul><p>to use respective GPU.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="encoding/">Encoding »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 5 December 2023 14:29">Tuesday 5 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>