Skip to content

Commit

Permalink
deploy: fdcb7d1
Browse files Browse the repository at this point in the history
  • Loading branch information
@liruilong940607
liruilong940607 committed Aug 26, 2024
1 parent bfbd585 commit 0d7c9f8
Show file tree
Hide file tree
Showing 11 changed files with 91 additions and 116 deletions.
Binary file modified main/.doctrees/apis/utils.doctree
View file
Binary file not shown.
Binary file modified main/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified main/.doctrees/migration/migration_legacy.doctree
View file
Binary file not shown.
179 changes: 88 additions & 91 deletions main/_modules/gsplat/rendering.html
View file

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions main/_sources/apis/utils.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,4 @@ Below are the basic functions that supports the rasterization.

.. autofunction:: accumulate

.. autofunction:: rasterization_legacy_wrapper

.. autofunction:: rasterization_inria_wrapper
5 changes: 1 addition & 4 deletions main/_sources/migration/migration_legacy.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ of `v0.1.11` are available at `here <https://docs.gsplat.studio/versions/0.1.11/
you can still call the old APIs in `v1.0.0` but they are deprecated and will be removed in
the future.

Below we demonstrate the API changes on a couple of use cases. If you want to take a closer
look on the detailed API changes, we provide a wrapper function :func:`rasterization_legacy_wrapper`
on top of the old API from `v0.1.11`, that
aligns with the new API :func:`rasterization` in `v1.0.0`.
Below we demonstrate the API changes on a couple of use cases.

Basic Usage
------------------
Expand Down
12 changes: 0 additions & 12 deletions main/apis/utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -674,17 +674,6 @@ <h1>Utils<a class="headerlink" href="#utils" title="Link to this heading">¶</a>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="gsplat.rasterization_legacy_wrapper">
<span class="sig-name descname"><span class="pre">rasterization_legacy_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">means</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quats</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scales</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacities</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewmats</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">near_plane</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></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.01</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps2d</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></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.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sh_degree</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></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">tile_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backgrounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></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"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><span class="pre">Dict</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/gsplat/rendering.html#rasterization_legacy_wrapper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gsplat.rasterization_legacy_wrapper" title="Link to this definition"></a></dt>
<dd><p>Wrapper for old version gsplat.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This function exists for comparision purpose only. So we skip collecting
the intermidiate variables, and only return an empty dict.</p>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="gsplat.rasterization_inria_wrapper">
<span class="sig-name descname"><span class="pre">rasterization_inria_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">means</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quats</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scales</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacities</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewmats</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">near_plane</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></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.01</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">far_plane</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps2d</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></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.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sh_degree</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></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">backgrounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></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"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><span class="pre">Dict</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/gsplat/rendering.html#rasterization_inria_wrapper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gsplat.rasterization_inria_wrapper" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -770,7 +759,6 @@ <h1>Utils<a class="headerlink" href="#utils" title="Link to this heading">¶</a>
<li><a class="reference internal" href="#gsplat.rasterize_to_pixels"><code class="docutils literal notranslate"><span class="pre">rasterize_to_pixels()</span></code></a></li>
<li><a class="reference internal" href="#gsplat.rasterize_to_indices_in_range"><code class="docutils literal notranslate"><span class="pre">rasterize_to_indices_in_range()</span></code></a></li>
<li><a class="reference internal" href="#gsplat.accumulate"><code class="docutils literal notranslate"><span class="pre">accumulate()</span></code></a></li>
<li><a class="reference internal" href="#gsplat.rasterization_legacy_wrapper"><code class="docutils literal notranslate"><span class="pre">rasterization_legacy_wrapper()</span></code></a></li>
<li><a class="reference internal" href="#gsplat.rasterization_inria_wrapper"><code class="docutils literal notranslate"><span class="pre">rasterization_inria_wrapper()</span></code></a></li>
</ul>
</li>
Expand Down
2 changes: 0 additions & 2 deletions main/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,8 +429,6 @@ <h2>R</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="apis/utils.html#gsplat.rasterization_legacy_wrapper">rasterization_legacy_wrapper() (in module gsplat)</a>
</li>
<li><a href="apis/utils.html#gsplat.rasterize_to_indices_in_range">rasterize_to_indices_in_range() (in module gsplat)</a>
</li>
<li><a href="apis/utils.html#gsplat.rasterize_to_pixels">rasterize_to_pixels() (in module gsplat)</a>
Expand Down
5 changes: 1 addition & 4 deletions main/migration/migration_legacy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -323,10 +323,7 @@ <h1>Migrate from gsplat v0.1.11<a class="headerlink" href="#migrate-from-gsplat-
of <cite>v0.1.11</cite> are available at <a class="reference external" href="https://docs.gsplat.studio/versions/0.1.11/">here</a>. Note
you can still call the old APIs in <cite>v1.0.0</cite> but they are deprecated and will be removed in
the future.</p>
<p>Below we demonstrate the API changes on a couple of use cases. If you want to take a closer
look on the detailed API changes, we provide a wrapper function <a class="reference internal" href="../apis/utils.html#gsplat.rasterization_legacy_wrapper" title="gsplat.rasterization_legacy_wrapper"><code class="xref py py-func docutils literal notranslate"><span class="pre">rasterization_legacy_wrapper()</span></code></a>
on top of the old API from <cite>v0.1.11</cite>, that
aligns with the new API <a class="reference internal" href="../apis/rasterization.html#gsplat.rasterization" title="gsplat.rasterization"><code class="xref py py-func docutils literal notranslate"><span class="pre">rasterization()</span></code></a> in <cite>v1.0.0</cite>.</p>
<p>Below we demonstrate the API changes on a couple of use cases.</p>
<section id="basic-usage">
<h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Link to this heading"></a></h2>
<p>In <cite>v0.1.11</cite>, a basic rasterization workflow is:</p>
Expand Down
Binary file modified main/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion main/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 0d7c9f8

Please sign in to comment.