mirror of
				https://github.com/ml-explore/mlx.git
				synced 2025-11-04 18:48:15 +08:00 
			
		
		
		
	rebase
This commit is contained in:
		
							
								
								
									
										113
									
								
								docs/build/html/genindex.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										113
									
								
								docs/build/html/genindex.html
									
									
									
									
										vendored
									
									
								
							@@ -7,7 +7,7 @@
 | 
			
		||||
  <head>
 | 
			
		||||
    <meta charset="utf-8" />
 | 
			
		||||
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 | 
			
		||||
    <title>Index — MLX 0.23.1 documentation</title>
 | 
			
		||||
    <title>Index — MLX 0.23.2 documentation</title>
 | 
			
		||||
  
 | 
			
		||||
  
 | 
			
		||||
  
 | 
			
		||||
@@ -15,30 +15,27 @@
 | 
			
		||||
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
 | 
			
		||||
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
 | 
			
		||||
  </script>
 | 
			
		||||
  <!--
 | 
			
		||||
    this give us a css class that will be invisible only if js is disabled
 | 
			
		||||
  -->
 | 
			
		||||
  <noscript>
 | 
			
		||||
    <style>
 | 
			
		||||
      .pst-js-only { display: none !important; }
 | 
			
		||||
 | 
			
		||||
    </style>
 | 
			
		||||
  </noscript>
 | 
			
		||||
  
 | 
			
		||||
  <!-- Loaded before other Sphinx assets -->
 | 
			
		||||
  <link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 | 
			
		||||
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 | 
			
		||||
  <link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
 | 
			
		||||
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
 | 
			
		||||
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
 | 
			
		||||
 | 
			
		||||
  
 | 
			
		||||
  <link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
 | 
			
		||||
  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
 | 
			
		||||
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
 | 
			
		||||
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
 | 
			
		||||
 | 
			
		||||
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
 | 
			
		||||
    <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
 | 
			
		||||
    <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
 | 
			
		||||
  
 | 
			
		||||
  <!-- So that users can add custom icons -->
 | 
			
		||||
  <script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
 | 
			
		||||
  <!-- Pre-loaded scripts that we'll load fully later -->
 | 
			
		||||
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 | 
			
		||||
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
 | 
			
		||||
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 | 
			
		||||
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
 | 
			
		||||
  <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 | 
			
		||||
 | 
			
		||||
    <script src="_static/documentation_options.js?v=8e7411ea"></script>
 | 
			
		||||
    <script src="_static/documentation_options.js?v=9900918c"></script>
 | 
			
		||||
    <script src="_static/doctools.js?v=9a2dae69"></script>
 | 
			
		||||
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
 | 
			
		||||
    <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
 | 
			
		||||
@@ -48,7 +45,6 @@
 | 
			
		||||
    <link rel="search" title="Search" href="search.html" />
 | 
			
		||||
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
 | 
			
		||||
  <meta name="docsearch:language" content="en"/>
 | 
			
		||||
  <meta name="docsearch:version" content="0.23.1" />
 | 
			
		||||
  </head>
 | 
			
		||||
  
 | 
			
		||||
  
 | 
			
		||||
@@ -64,8 +60,19 @@
 | 
			
		||||
    <i class="fa-solid fa-arrow-up"></i>Back to top</button>
 | 
			
		||||
 | 
			
		||||
  
 | 
			
		||||
  <dialog id="pst-search-dialog">
 | 
			
		||||
    
 | 
			
		||||
  <input type="checkbox"
 | 
			
		||||
          class="sidebar-toggle"
 | 
			
		||||
          id="pst-primary-sidebar-checkbox"/>
 | 
			
		||||
  <label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
 | 
			
		||||
  
 | 
			
		||||
  <input type="checkbox"
 | 
			
		||||
          class="sidebar-toggle"
 | 
			
		||||
          id="pst-secondary-sidebar-checkbox"/>
 | 
			
		||||
  <label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
 | 
			
		||||
  
 | 
			
		||||
  <div class="search-button__wrapper">
 | 
			
		||||
    <div class="search-button__overlay"></div>
 | 
			
		||||
    <div class="search-button__search-container">
 | 
			
		||||
<form class="bd-search d-flex align-items-center"
 | 
			
		||||
      action="search.html"
 | 
			
		||||
      method="get">
 | 
			
		||||
@@ -73,6 +80,7 @@
 | 
			
		||||
  <input type="search"
 | 
			
		||||
         class="form-control"
 | 
			
		||||
         name="q"
 | 
			
		||||
         id="search-input"
 | 
			
		||||
         placeholder="Search..."
 | 
			
		||||
         aria-label="Search..."
 | 
			
		||||
         autocomplete="off"
 | 
			
		||||
@@ -80,8 +88,8 @@
 | 
			
		||||
         autocapitalize="off"
 | 
			
		||||
         spellcheck="false"/>
 | 
			
		||||
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 | 
			
		||||
</form>
 | 
			
		||||
  </dialog>
 | 
			
		||||
</form></div>
 | 
			
		||||
  </div>
 | 
			
		||||
 | 
			
		||||
  <div class="pst-async-banner-revealer d-none">
 | 
			
		||||
  <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
 | 
			
		||||
@@ -99,8 +107,7 @@
 | 
			
		||||
      
 | 
			
		||||
        
 | 
			
		||||
      
 | 
			
		||||
      <dialog id="pst-primary-sidebar-modal"></dialog>
 | 
			
		||||
      <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
 | 
			
		||||
      <div class="bd-sidebar-primary bd-sidebar">
 | 
			
		||||
        
 | 
			
		||||
 | 
			
		||||
  
 | 
			
		||||
@@ -129,18 +136,22 @@
 | 
			
		||||
      
 | 
			
		||||
    
 | 
			
		||||
    
 | 
			
		||||
    <img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.23.1 documentation - Home"/>
 | 
			
		||||
    <img src="_static/mlx_logo_dark.png" class="logo__image only-dark pst-js-only" alt="MLX 0.23.1 documentation - Home"/>
 | 
			
		||||
    <img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.23.2 documentation - Home"/>
 | 
			
		||||
    <script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.23.2 documentation - Home"/>`);</script>
 | 
			
		||||
  
 | 
			
		||||
  
 | 
			
		||||
</a></div>
 | 
			
		||||
        <div class="sidebar-primary-item">
 | 
			
		||||
 | 
			
		||||
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
 <i class="fa-solid fa-magnifying-glass"></i>
 | 
			
		||||
 <span class="search-button__default-text">Search</span>
 | 
			
		||||
 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 | 
			
		||||
</button></div>
 | 
			
		||||
 <script>
 | 
			
		||||
 document.write(`
 | 
			
		||||
   <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
    <i class="fa-solid fa-magnifying-glass"></i>
 | 
			
		||||
    <span class="search-button__default-text">Search</span>
 | 
			
		||||
    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 | 
			
		||||
   </button>
 | 
			
		||||
 `);
 | 
			
		||||
 </script></div>
 | 
			
		||||
        <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
 | 
			
		||||
    <div class="bd-toc-item navbar-nav active">
 | 
			
		||||
        <p aria-level="2" class="caption" role="heading"><span class="caption-text">Install</span></p>
 | 
			
		||||
@@ -510,6 +521,7 @@
 | 
			
		||||
<li class="toctree-l1 has-children"><a class="reference internal" href="python/nn.html">Neural Networks</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 | 
			
		||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.value_and_grad.html">mlx.nn.value_and_grad</a></li>
 | 
			
		||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.quantize.html">mlx.nn.quantize</a></li>
 | 
			
		||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.average_gradients.html">mlx.nn.average_gradients</a></li>
 | 
			
		||||
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/module.html">Module</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 | 
			
		||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.training.html">mlx.nn.Module.training</a></li>
 | 
			
		||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.state.html">mlx.nn.Module.state</a></li>
 | 
			
		||||
@@ -721,14 +733,9 @@
 | 
			
		||||
  
 | 
			
		||||
  
 | 
			
		||||
  <div class="sidebar-primary-items__end sidebar-primary__section">
 | 
			
		||||
      <div class="sidebar-primary-item">
 | 
			
		||||
<div id="ethical-ad-placement"
 | 
			
		||||
      class="flat"
 | 
			
		||||
      data-ea-publisher="readthedocs"
 | 
			
		||||
      data-ea-type="readthedocs-sidebar"
 | 
			
		||||
      data-ea-manual="true">
 | 
			
		||||
</div></div>
 | 
			
		||||
  </div>
 | 
			
		||||
  
 | 
			
		||||
  <div id="rtd-footer-container"></div>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
      </div>
 | 
			
		||||
@@ -792,16 +799,24 @@
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
  <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
 | 
			
		||||
  <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
 | 
			
		||||
  <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
 | 
			
		||||
</button>
 | 
			
		||||
<script>
 | 
			
		||||
document.write(`
 | 
			
		||||
  <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
 | 
			
		||||
    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
 | 
			
		||||
    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
 | 
			
		||||
  </button>
 | 
			
		||||
`);
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
<script>
 | 
			
		||||
document.write(`
 | 
			
		||||
  <button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
 | 
			
		||||
    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
 | 
			
		||||
</button>
 | 
			
		||||
  </button>
 | 
			
		||||
`);
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
</div></div>
 | 
			
		||||
      
 | 
			
		||||
@@ -1030,6 +1045,8 @@
 | 
			
		||||
      <li><a href="cpp/ops.html#_CPPv410atleast_3dRK5array14StreamOrDevice">atleast_3d (C++ function)</a>, <a href="cpp/ops.html#_CPPv410atleast_3dRKNSt6vectorI5arrayEE14StreamOrDevice">[1]</a>
 | 
			
		||||
</li>
 | 
			
		||||
      <li><a href="python/_autosummary/mlx.core.atleast_3d.html#mlx.core.atleast_3d">atleast_3d() (in module mlx.core)</a>
 | 
			
		||||
</li>
 | 
			
		||||
      <li><a href="python/_autosummary/mlx.nn.average_gradients.html#mlx.nn.average_gradients">average_gradients() (in module mlx.nn)</a>
 | 
			
		||||
</li>
 | 
			
		||||
      <li><a href="python/nn/_autosummary/mlx.nn.AvgPool1d.html#mlx.nn.AvgPool1d">AvgPool1d (class in mlx.nn)</a>
 | 
			
		||||
</li>
 | 
			
		||||
@@ -2548,8 +2565,8 @@ By MLX Contributors
 | 
			
		||||
  </div>
 | 
			
		||||
  
 | 
			
		||||
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
 | 
			
		||||
  <script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
 | 
			
		||||
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
 | 
			
		||||
  <script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
 | 
			
		||||
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
 | 
			
		||||
 | 
			
		||||
  <footer class="bd-footer">
 | 
			
		||||
  </footer>
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user