Update docs

Author: github-actions[bot]

_sources/autoapi/tilelang/tools/plot_layout/index.rst.txt

@@ -16,27 +16,28 @@ Functions
 Module Contents
 ---------------
 
-.. py:function:: plot_layout(layout, save_directory='./tmp', name = 'layout', colormap = 'RdPu', verbose = False, formats = 'png')
+.. py:function:: plot_layout(layout, save_directory='./tmp', name = 'layout', colormap = None, verbose = False, formats = 'pdf')
 
-   Plot the layout of a buffer.
+   Plot the layout mapping as a 2D grid visualization.
 
-   :param layout: The layout object that describes how indices are mapped.
-   :type layout: T.Layout
-   :param save_directory: The directory where the output images will be saved (default is "./tmp").
+   Dispatches to Fragment-specific or Layout-specific plotting based on the
+   type of the layout object.
+
+   :param layout: The layout object to visualize.
+   :type layout: T.Layout or T.Fragment
+   :param save_directory: Output directory (default "./tmp").
    :type save_directory: str, optional
-   :param name: The base name of the output files (default is "layout").
+   :param name: Base filename for saved images (default "layout").
    :type name: str, optional
-   :param colormap: The colormap to use for visualization (default is "RdPu").
+   :param colormap: Matplotlib colormap name. Defaults to "RdPu" for Fragment, "Spectral" for Layout.
    :type colormap: str, optional
-   :param verbose: If True, prints additional information about the mapping (default is False).
+   :param verbose: If True, print mapping details.
    :type verbose: bool, optional
-   :param formats: The formats to save the image in (default is "png").
+   :param formats: Output format(s): "pdf", "png", "svg", "all", or comma-separated (default "pdf").
    :type formats: str | list[str], optional
 
-   :rtype: None
-
 
-.. py:function:: plot_fragment_tv(frag, save_directory = None, name = 'layout', apply_idx_fn=lambda *args: args, colormap = 'RdPu', item_scale = 0.75, formats = 'png', dpi=80)
+.. py:function:: plot_fragment_tv(frag, save_directory = None, name = 'layout', apply_idx_fn=lambda *args: args, colormap = 'RdPu', item_scale = 0.75, formats = 'pdf', dpi=80)
 
    Plot fragment in terms of thread and local index mapping.
    :param frag: The fragment object that describes how indices are mapped.
@@ -51,7 +52,7 @@ Module Contents
    :type colormap: str, optional
    :param item_scale: The scale factor for each item in the plot (default is 0.75).
    :type item_scale: float, optional
-   :param formats: The formats to save the image in (default is "png").
+   :param formats: The formats to save the image in (default is "pdf").
    :type formats: str | list[str], optional
    :param dpi: The resolution in dots per inch for the saved image (default is 80).
    :type dpi: int, optional

autoapi/tilelang/tools/plot_layout/index.html

@@ -556,7 +556,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.tools.plot_layout.plot_layout" title="tilelang.tools.plot_layout.plot_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_layout</span></code></a>(layout[, save_directory, name, colormap, ...])</p></td>
-<td><p>Plot the layout of a buffer.</p></td>
+<td><p>Plot the layout mapping as a 2D grid visualization.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#tilelang.tools.plot_layout.plot_fragment_tv" title="tilelang.tools.plot_layout.plot_fragment_tv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_fragment_tv</span></code></a>(frag[, save_directory, name, ...])</p></td>
 <td><p>Plot fragment in terms of thread and local index mapping.</p></td>
@@ -569,17 +569,19 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.tools.plot_layout.plot_layout">
-<span class="sig-prename descclassname"><span class="pre">tilelang.tools.plot_layout.</span></span><span class="sig-name descname"><span class="pre">plot_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layout</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'./tmp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'layout'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'RdPu'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</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">formats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'png'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.plot_layout.plot_layout" title="Link to this definition">¶</a></dt>
-<dd><p>Plot the layout of a buffer.</p>
+<span class="sig-prename descclassname"><span class="pre">tilelang.tools.plot_layout.</span></span><span class="sig-name descname"><span class="pre">plot_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layout</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'./tmp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'layout'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</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">formats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'pdf'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.plot_layout.plot_layout" title="Link to this definition">¶</a></dt>
+<dd><p>Plot the layout mapping as a 2D grid visualization.</p>
+<p>Dispatches to Fragment-specific or Layout-specific plotting based on the
+type of the layout object.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>layout</strong> (<em>T.Layout</em>) – The layout object that describes how indices are mapped.</p></li>
-<li><p><strong>save_directory</strong> (<em>str</em><em>, </em><em>optional</em>) – The directory where the output images will be saved (default is “./tmp”).</p></li>
-<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The base name of the output files (default is “layout”).</p></li>
-<li><p><strong>colormap</strong> (<em>str</em><em>, </em><em>optional</em>) – The colormap to use for visualization (default is “RdPu”).</p></li>
-<li><p><strong>verbose</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a><em>, </em><em>optional</em>) – If True, prints additional information about the mapping (default is False).</p></li>
-<li><p><strong>formats</strong> (<em>str</em><em> | </em><em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – The formats to save the image in (default is “png”).</p></li>
+<li><p><strong>layout</strong> (<em>T.Layout</em><em> or </em><em>T.Fragment</em>) – The layout object to visualize.</p></li>
+<li><p><strong>save_directory</strong> (<em>str</em><em>, </em><em>optional</em>) – Output directory (default “./tmp”).</p></li>
+<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – Base filename for saved images (default “layout”).</p></li>
+<li><p><strong>colormap</strong> (<em>str</em><em>, </em><em>optional</em>) – Matplotlib colormap name. Defaults to “RdPu” for Fragment, “Spectral” for Layout.</p></li>
+<li><p><strong>verbose</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a><em>, </em><em>optional</em>) – If True, print mapping details.</p></li>
+<li><p><strong>formats</strong> (<em>str</em><em> | </em><em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Output format(s): “pdf”, “png”, “svg”, “all”, or comma-separated (default “pdf”).</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
@@ -590,7 +592,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.tools.plot_layout.plot_fragment_tv">
-<span class="sig-prename descclassname"><span class="pre">tilelang.tools.plot_layout.</span></span><span class="sig-name descname"><span class="pre">plot_fragment_tv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'layout'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apply_idx_fn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">lambda</span> <span class="pre">*args:</span> <span class="pre">...</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'RdPu'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.75</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'png'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dpi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">80</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.plot_layout.plot_fragment_tv" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">tilelang.tools.plot_layout.</span></span><span class="sig-name descname"><span class="pre">plot_fragment_tv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'layout'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apply_idx_fn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">lambda</span> <span class="pre">*args:</span> <span class="pre">...</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'RdPu'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.75</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'pdf'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dpi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">80</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.tools.plot_layout.plot_fragment_tv" title="Link to this definition">¶</a></dt>
 <dd><p>Plot fragment in terms of thread and local index mapping.
 :param frag: The fragment object that describes how indices are mapped.
 :type frag: T.Fragment
@@ -604,7 +606,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 :type colormap: str, optional
 :param item_scale: The scale factor for each item in the plot (default is 0.75).
 :type item_scale: float, optional
-:param formats: The formats to save the image in (default is “png”).
+:param formats: The formats to save the image in (default is “pdf”).
 :type formats: str | list[str], optional
 :param dpi: The resolution in dots per inch for the saved image (default is 80).
 :type dpi: int, optional</p>