Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Cron] Sync and update documentation content #923

Merged
merged 1 commit into from
Jul 5, 2023
Merged

[Cron] Sync and update documentation content #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 0 additions & 109 deletions website/src/pages/api/master/taichi/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1524,15 +1524,6 @@
</code>
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.copy_from">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.copy_from()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.fill">
<code class="docutils literal notranslate">
Expand All @@ -1551,24 +1542,6 @@
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_paddle">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.from_paddle()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_torch">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.from_torch()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.get_scalar_field">
<code class="docutils literal notranslate">
Expand All @@ -1578,15 +1551,6 @@
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.parent">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.parent()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.to_numpy">
<code class="docutils literal notranslate">
Expand Down Expand Up @@ -4848,11 +4812,6 @@
MatrixField
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.copy_from">
copy_from
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.fill">
fill
Expand All @@ -4863,26 +4822,11 @@
from_numpy
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_paddle">
from_paddle
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_torch">
from_torch
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.get_scalar_field">
get_scalar_field
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.parent">
parent
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.to_numpy">
to_numpy
Expand Down Expand Up @@ -8045,18 +7989,6 @@
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.copy_from">
<span class="sig-name descname"><span class="pre">copy_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.copy_from" title="Permalink to this definition">#</a></dt>
<dd><p>Copies all elements from another field.</p>
<p>The shape of the other field needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>other</strong> (<a class="reference internal" href="#taichi.Field" title="taichi.Field"><em>Field</em></a>) – The source field.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.fill">
<span class="sig-name descname"><span class="pre">fill</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.fill" title="Permalink to this definition">#</a></dt>
Expand All @@ -8081,30 +8013,6 @@
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.from_paddle">
<span class="sig-name descname"><span class="pre">from_paddle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.from_paddle" title="Permalink to this definition">#</a></dt>
<dd><p>Loads all elements from a paddle tensor.</p>
<p>The shape of the paddle tensor needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>arr</strong> (<em>paddle.Tensor</em>) – The source paddle tensor.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.from_torch">
<span class="sig-name descname"><span class="pre">from_torch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.from_torch" title="Permalink to this definition">#</a></dt>
<dd><p>Loads all elements from a torch tensor.</p>
<p>The shape of the torch tensor needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>arr</strong> (<em>torch.tensor</em>) – The source torch tensor.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.get_scalar_field">
<span class="sig-name descname"><span class="pre">get_scalar_field</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">indices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.get_scalar_field" title="Permalink to this definition">#</a></dt>
Expand All @@ -8122,23 +8030,6 @@
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.parent" title="Permalink to this definition">#</a></dt>
<dd><p>Gets an ancestor of the representative SNode in the SNode tree.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>n</strong> (<em>int</em>) – the number of levels going up from the representative SNode.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The n-th parent of the representative SNode.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#taichi.SNode" title="taichi.SNode">SNode</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.to_numpy">
<span class="sig-name descname"><span class="pre">to_numpy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.to_numpy" title="Permalink to this definition">#</a></dt>
Expand Down
109 changes: 0 additions & 109 deletions website/src/pages/api/v1.6.0/taichi/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1504,15 +1504,6 @@
</code>
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.copy_from">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.copy_from()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.fill">
<code class="docutils literal notranslate">
Expand All @@ -1531,24 +1522,6 @@
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_paddle">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.from_paddle()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_torch">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.from_torch()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.get_scalar_field">
<code class="docutils literal notranslate">
Expand All @@ -1558,15 +1531,6 @@
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.parent">
<code class="docutils literal notranslate">
<span class="pre">
MatrixField.parent()
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.to_numpy">
<code class="docutils literal notranslate">
Expand Down Expand Up @@ -4789,11 +4753,6 @@
MatrixField
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.copy_from">
copy_from
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.fill">
fill
Expand All @@ -4804,26 +4763,11 @@
from_numpy
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_paddle">
from_paddle
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.from_torch">
from_torch
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.get_scalar_field">
get_scalar_field
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.parent">
parent
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#taichi.MatrixField.to_numpy">
to_numpy
Expand Down Expand Up @@ -7927,18 +7871,6 @@
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.copy_from">
<span class="sig-name descname"><span class="pre">copy_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.copy_from" title="Permalink to this definition">#</a></dt>
<dd><p>Copies all elements from another field.</p>
<p>The shape of the other field needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>other</strong> (<a class="reference internal" href="#taichi.Field" title="taichi.Field"><em>Field</em></a>) – The source field.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.fill">
<span class="sig-name descname"><span class="pre">fill</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.fill" title="Permalink to this definition">#</a></dt>
Expand All @@ -7963,30 +7895,6 @@
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.from_paddle">
<span class="sig-name descname"><span class="pre">from_paddle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.from_paddle" title="Permalink to this definition">#</a></dt>
<dd><p>Loads all elements from a paddle tensor.</p>
<p>The shape of the paddle tensor needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>arr</strong> (<em>paddle.Tensor</em>) – The source paddle tensor.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.from_torch">
<span class="sig-name descname"><span class="pre">from_torch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.from_torch" title="Permalink to this definition">#</a></dt>
<dd><p>Loads all elements from a torch tensor.</p>
<p>The shape of the torch tensor needs to be the same as <cite>self</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>arr</strong> (<em>torch.tensor</em>) – The source torch tensor.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.get_scalar_field">
<span class="sig-name descname"><span class="pre">get_scalar_field</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">indices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.get_scalar_field" title="Permalink to this definition">#</a></dt>
Expand All @@ -8004,23 +7912,6 @@
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.parent" title="Permalink to this definition">#</a></dt>
<dd><p>Gets an ancestor of the representative SNode in the SNode tree.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>n</strong> (<em>int</em>) – the number of levels going up from the representative SNode.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The n-th parent of the representative SNode.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#taichi.SNode" title="taichi.SNode">SNode</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="taichi.MatrixField.to_numpy">
<span class="sig-name descname"><span class="pre">to_numpy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#taichi.MatrixField.to_numpy" title="Permalink to this definition">#</a></dt>
Expand Down