Skip to content

Commit 29c4eec

Browse files
committed
Update docs
1 parent 1127bf0 commit 29c4eec

7 files changed

+28
-34
lines changed

api/tilelang.carver.arch.driver.cuda_driver.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,7 @@
843843
<dl class="py function">
844844
<dt class="sig sig-object py" id="tilelang.carver.arch.driver.cuda_driver.get_max_dynamic_shared_size_bytes">
845845
<span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.driver.cuda_driver.</span></span><span class="sig-name descname"><span class="pre">get_max_dynamic_shared_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_id</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">format</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">'bytes'</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">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><a class="headerlink" href="#tilelang.carver.arch.driver.cuda_driver.get_max_dynamic_shared_size_bytes" title="Permalink to this definition">#</a></dt>
846-
<dd><p>获取设备支持的最大动态共享内存大小</p>
846+
<dd><p>Get the maximum dynamic shared memory size in bytes, kilobytes, or megabytes.</p>
847847
</dd></dl>
848848

849849
<dl class="py function">

api/tilelang.language.proxy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@
456456
<p>Buffer proxy class for constructing tir buffer.</p>
457457
<dl class="py method">
458458
<dt class="sig sig-object py" id="tilelang.language.proxy.BufferProxy.from_ptr">
459-
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</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></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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">'float32'</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">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7fc573e792a0&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
459+
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</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></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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">'float32'</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">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f148544b910&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
460460
<dd><p>Create a buffer from a pointer, shape, and data type.</p>
461461
<dl class="field-list simple">
462462
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.tools.Analyzer.html

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@
407407
<span id="tilelang-tools-analyzer-module"></span><h1>tilelang.tools.Analyzer module<a class="headerlink" href="#module-tilelang.tools.Analyzer" title="Permalink to this heading">#</a></h1>
408408
<dl class="py class">
409409
<dt class="sig sig-object py" id="tilelang.tools.Analyzer.AnalysisResult">
410-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.tools.Analyzer.</span></span><span class="sig-name descname"><span class="pre">AnalysisResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">total_flops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_global_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">estimated_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tflops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bandwidth_GBps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult" title="Permalink to this definition">#</a></dt>
410+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.tools.Analyzer.</span></span><span class="sig-name descname"><span class="pre">AnalysisResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">total_flops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_global_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">estimated_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected_tflops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected_bandwidth_GBps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult" title="Permalink to this definition">#</a></dt>
411411
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
412412
<p>A data class to store the results of the analysis.
413413
.. attribute:: total_flops</p>
@@ -445,37 +445,27 @@
445445
<dt class="sig sig-object py" id="tilelang.tools.Analyzer.AnalysisResult.tflops">
446446
<span class="sig-name descname"><span class="pre">tflops</span></span><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult.tflops" title="Permalink to this definition">#</a></dt>
447447
<dd><p>Achieved TFLOPS (trillions of FLOPs per second).</p>
448-
<dl class="field-list simple">
449-
<dt class="field-odd">Type<span class="colon">:</span></dt>
450-
<dd class="field-odd"><p>float</p>
451-
</dd>
452-
</dl>
453448
</dd></dl>
454449

455450
<dl class="py attribute">
456451
<dt class="sig sig-object py" id="tilelang.tools.Analyzer.AnalysisResult.bandwidth_GBps">
457452
<span class="sig-name descname"><span class="pre">bandwidth_GBps</span></span><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult.bandwidth_GBps" title="Permalink to this definition">#</a></dt>
458453
<dd><p>Achieved memory bandwidth in GB/s.</p>
459-
<dl class="field-list simple">
460-
<dt class="field-odd">Type<span class="colon">:</span></dt>
461-
<dd class="field-odd"><p>float</p>
462-
</dd>
463-
</dl>
464454
</dd></dl>
465455

466456
<dl class="py attribute">
467457
<dt class="sig sig-object py" id="id0">
468-
<span class="sig-name descname"><span class="pre">bandwidth_GBps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#id0" title="Permalink to this definition">#</a></dt>
458+
<span class="sig-name descname"><span class="pre">estimated_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#id0" title="Permalink to this definition">#</a></dt>
469459
<dd></dd></dl>
470460

471461
<dl class="py attribute">
472-
<dt class="sig sig-object py" id="id1">
473-
<span class="sig-name descname"><span class="pre">estimated_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#id1" title="Permalink to this definition">#</a></dt>
462+
<dt class="sig sig-object py" id="tilelang.tools.Analyzer.AnalysisResult.expected_bandwidth_GBps">
463+
<span class="sig-name descname"><span class="pre">expected_bandwidth_GBps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult.expected_bandwidth_GBps" title="Permalink to this definition">#</a></dt>
474464
<dd></dd></dl>
475465

476466
<dl class="py attribute">
477-
<dt class="sig sig-object py" id="id2">
478-
<span class="sig-name descname"><span class="pre">tflops</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#id2" title="Permalink to this definition">#</a></dt>
467+
<dt class="sig sig-object py" id="tilelang.tools.Analyzer.AnalysisResult.expected_tflops">
468+
<span class="sig-name descname"><span class="pre">expected_tflops</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#tilelang.tools.Analyzer.AnalysisResult.expected_tflops" title="Permalink to this definition">#</a></dt>
479469
<dd></dd></dl>
480470

481471
<dl class="py attribute">
@@ -484,8 +474,8 @@
484474
<dd></dd></dl>
485475

486476
<dl class="py attribute">
487-
<dt class="sig sig-object py" id="id3">
488-
<span class="sig-name descname"><span class="pre">total_global_bytes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#id3" title="Permalink to this definition">#</a></dt>
477+
<dt class="sig sig-object py" id="id1">
478+
<span class="sig-name descname"><span class="pre">total_global_bytes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#id1" title="Permalink to this definition">#</a></dt>
489479
<dd></dd></dl>
490480

491481
</dd></dl>
@@ -593,11 +583,11 @@
593583
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.estimated_time"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
594584
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.tflops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.tflops</span></code></a></li>
595585
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.bandwidth_GBps"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.bandwidth_GBps</span></code></a></li>
596-
<li><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.bandwidth_GBps</span></code></a></li>
597-
<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
598-
<li><a class="reference internal" href="#id2"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.tflops</span></code></a></li>
586+
<li><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
587+
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.expected_bandwidth_GBps"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.expected_bandwidth_GBps</span></code></a></li>
588+
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.expected_tflops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.expected_tflops</span></code></a></li>
599589
<li><a class="reference internal" href="#tilelang.tools.Analyzer.AnalysisResult.total_flops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_flops</span></code></a></li>
600-
<li><a class="reference internal" href="#id3"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_global_bytes</span></code></a></li>
590+
<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_global_bytes</span></code></a></li>
601591
</ul>
602592
</li>
603593
<li><a class="reference internal" href="#tilelang.tools.Analyzer.Analyzer"><code class="docutils literal notranslate"><span class="pre">Analyzer</span></code></a><ul>

api/tilelang.tools.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -415,11 +415,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
415415
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.estimated_time"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
416416
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.tflops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.tflops</span></code></a></li>
417417
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.bandwidth_GBps"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.bandwidth_GBps</span></code></a></li>
418-
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id0"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.bandwidth_GBps</span></code></a></li>
419-
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id1"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
420-
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id2"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.tflops</span></code></a></li>
418+
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id0"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.estimated_time</span></code></a></li>
419+
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.expected_bandwidth_GBps"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.expected_bandwidth_GBps</span></code></a></li>
420+
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.expected_tflops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.expected_tflops</span></code></a></li>
421421
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.AnalysisResult.total_flops"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_flops</span></code></a></li>
422-
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id3"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_global_bytes</span></code></a></li>
422+
<li class="toctree-l3"><a class="reference internal" href="tilelang.tools.Analyzer.html#id1"><code class="docutils literal notranslate"><span class="pre">AnalysisResult.total_global_bytes</span></code></a></li>
423423
</ul>
424424
</li>
425425
<li class="toctree-l2"><a class="reference internal" href="tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.Analyzer"><code class="docutils literal notranslate"><span class="pre">Analyzer</span></code></a><ul>

0 commit comments

Comments
 (0)