docs update

This commit is contained in:
Awni Hannun
2024-08-10 09:24:35 -07:00
committed by CircleCI Docs
parent 8f68182d95
commit d8f7b8cda6
724 changed files with 14529 additions and 11046 deletions

View File

@@ -79,7 +79,7 @@ $(function() {
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="steel__gemm__masked_8h_source.html">steel_gemm_masked.h</a>&gt;</code></p>
<p><code>#include &lt;<a class="el" href="kernels_2gemv__masked_8h_source.html">gemv_masked.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
@@ -91,6 +91,14 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a73e9612a619885cbc97cbd8f40df71e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bf336d472bc677028250f76b9cdc08c" id="r_a4bf336d472bc677028250f76b9cdc08c"><td class="memItemLeft" align="right" valign="top">constexpr METAL_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bf336d472bc677028250f76b9cdc08c">operator bool</a> () const constant</td></tr>
<tr class="separator:a4bf336d472bc677028250f76b9cdc08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3723c1e70e46beefd283ce6317416cb" id="r_ad3723c1e70e46beefd283ce6317416cb"><td class="memItemLeft" align="right" valign="top">constexpr METAL_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3723c1e70e46beefd283ce6317416cb">operator bool</a> ()</td></tr>
<tr class="separator:ad3723c1e70e46beefd283ce6317416cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafbf8a3201e1cc1abf74dd1f1b7272cd" id="r_aafbf8a3201e1cc1abf74dd1f1b7272cd"><td class="memItemLeft" align="right" valign="top">constexpr METAL_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aafbf8a3201e1cc1abf74dd1f1b7272cd">operator bool</a> () const threadgroup</td></tr>
<tr class="separator:aafbf8a3201e1cc1abf74dd1f1b7272cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73e9612a619885cbc97cbd8f40df71e7" id="r_a73e9612a619885cbc97cbd8f40df71e7"><td class="memItemLeft" align="right" valign="top">constexpr METAL_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73e9612a619885cbc97cbd8f40df71e7">operator bool</a> () const device</td></tr>
<tr class="separator:a73e9612a619885cbc97cbd8f40df71e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bf336d472bc677028250f76b9cdc08c" id="r_a4bf336d472bc677028250f76b9cdc08c"><td class="memItemLeft" align="right" valign="top">constexpr METAL_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bf336d472bc677028250f76b9cdc08c">operator bool</a> () const constant</td></tr>
<tr class="separator:a4bf336d472bc677028250f76b9cdc08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -99,7 +107,32 @@ Public Attributes</h2></td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad3723c1e70e46beefd283ce6317416cb" name="ad3723c1e70e46beefd283ce6317416cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3723c1e70e46beefd283ce6317416cb">&#9670;&#160;</a></span>operator bool() <span class="overload">[1/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#ad3723c1e70e46beefd283ce6317416cb">&#9670;&#160;</a></span>operator bool() <span class="overload">[1/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr METAL_FUNC _NoMask::operator bool </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad3723c1e70e46beefd283ce6317416cb" name="ad3723c1e70e46beefd283ce6317416cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3723c1e70e46beefd283ce6317416cb">&#9670;&#160;</a></span>operator bool() <span class="overload">[2/8]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -124,7 +157,32 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a4bf336d472bc677028250f76b9cdc08c" name="a4bf336d472bc677028250f76b9cdc08c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf336d472bc677028250f76b9cdc08c">&#9670;&#160;</a></span>operator bool() <span class="overload">[2/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf336d472bc677028250f76b9cdc08c">&#9670;&#160;</a></span>operator bool() <span class="overload">[3/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr METAL_FUNC _NoMask::operator bool </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4bf336d472bc677028250f76b9cdc08c" name="a4bf336d472bc677028250f76b9cdc08c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf336d472bc677028250f76b9cdc08c">&#9670;&#160;</a></span>operator bool() <span class="overload">[4/8]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -149,7 +207,32 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a73e9612a619885cbc97cbd8f40df71e7" name="a73e9612a619885cbc97cbd8f40df71e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73e9612a619885cbc97cbd8f40df71e7">&#9670;&#160;</a></span>operator bool() <span class="overload">[3/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a73e9612a619885cbc97cbd8f40df71e7">&#9670;&#160;</a></span>operator bool() <span class="overload">[5/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr METAL_FUNC _NoMask::operator bool </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a73e9612a619885cbc97cbd8f40df71e7" name="a73e9612a619885cbc97cbd8f40df71e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73e9612a619885cbc97cbd8f40df71e7">&#9670;&#160;</a></span>operator bool() <span class="overload">[6/8]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -174,7 +257,32 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="aafbf8a3201e1cc1abf74dd1f1b7272cd" name="aafbf8a3201e1cc1abf74dd1f1b7272cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafbf8a3201e1cc1abf74dd1f1b7272cd">&#9670;&#160;</a></span>operator bool() <span class="overload">[4/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#aafbf8a3201e1cc1abf74dd1f1b7272cd">&#9670;&#160;</a></span>operator bool() <span class="overload">[7/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr METAL_FUNC _NoMask::operator bool </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aafbf8a3201e1cc1abf74dd1f1b7272cd" name="aafbf8a3201e1cc1abf74dd1f1b7272cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafbf8a3201e1cc1abf74dd1f1b7272cd">&#9670;&#160;</a></span>operator bool() <span class="overload">[8/8]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -213,7 +321,8 @@ Public Attributes</h2></td></tr>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>mlx/backend/metal/kernels/<a class="el" href="kernels_2gemv__masked_8h_source.html">gemv_masked.h</a></li>
<li>mlx/backend/metal/kernels/steel/gemm/kernels/<a class="el" href="steel__gemm__masked_8h_source.html">steel_gemm_masked.h</a></li>
</ul>
</div><!-- contents -->