module.rst

docs/_sources/index.rst.txt

@@ -1,7 +1,4 @@
-.. phi-3-vision-mlx documentation master file, created by
-   sphinx-quickstart on Sun Jul  7 23:52:18 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. phi-3-vision-mlx documentation master file
 
 Welcome to phi-3-vision-mlx's documentation!
 ============================================
@@ -10,23 +7,6 @@ Phi-3-MLX is a versatile AI framework that leverages both the Phi-3-Vision multi
 
 `View the project on GitHub <https://github.com/JosefAlbers/Phi-3-Vision-MLX>`_
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents
-
-   install
-   generate
-   train
-   agent
-   toolchain
-   benchmark
-
-.. toctree::
-   :maxdepth: 1
-   :caption: API Reference
-
-   module
-
 Features
 --------
 
@@ -40,18 +20,25 @@ Features
 - LoRA fine-tuning capabilities
 - API integration for extended functionality (e.g., image generation, text-to-speech)
 
-Recent Updates: Phi-3 Mini Improvements
----------------------------------------
+Usage
+-----
+.. toctree::
+   :maxdepth: 2
 
-Microsoft has recently released significant updates to the Phi-3 Mini model, dramatically improving its capabilities:
+   install
+   generate
+   train
+   agent
+   toolchain
+   benchmark
+
+API Reference
+-------------
 
-- Substantially enhanced code understanding in Python, C++, Rust, and TypeScript
-- Improved post-training for better-structured output
-- Enhanced multi-turn instruction following
-- Added support for the `<|system|>` tag
-- Improved reasoning and long-context understanding
+.. toctree::
+   :maxdepth: 1
 
-For detailed benchmark results, please refer to the tables in the README.
+   module
 
 License
 -------

docs/_sources/module.rst.txt

@@ -11,10 +11,30 @@ Agent
 Functions
 ---------
 
-add_code
+load
+^^^^
+
+.. autofunction:: phi_3_vision_mlx.load
+
+generate
 ^^^^^^^^
 
-.. autofunction:: phi_3_vision_mlx.add_code
+.. autofunction:: phi_3_vision_mlx.generate
+
+execute
+^^^^^^^
+
+.. autofunction:: phi_3_vision_mlx.execute
+
+train_lora
+^^^^^^^^^^
+
+.. autofunction:: phi_3_vision_mlx.train_lora
+
+test_lora
+^^^^^^^^^
+
+.. autofunction:: phi_3_vision_mlx.test_lora
 
 benchmark
 ^^^^^^^^^
@@ -26,32 +46,12 @@ chatui
 
 .. autofunction:: phi_3_vision_mlx.chatui
 
-execute
-^^^^^^^
-
-.. autofunction:: phi_3_vision_mlx.execute
-
-generate
-^^^^^^^^
-
-.. autofunction:: phi_3_vision_mlx.generate
-
 get_api
 ^^^^^^^
 
 .. autofunction:: phi_3_vision_mlx.get_api
 
-load
-^^^^
-
-.. autofunction:: phi_3_vision_mlx.load
-
-test_lora
-^^^^^^^^^
-
-.. autofunction:: phi_3_vision_mlx.test_lora
-
-train_lora
-^^^^^^^^^^
+add_code
+^^^^^^^^
 
-.. autofunction:: phi_3_vision_mlx.train_lora
+.. autofunction:: phi_3_vision_mlx.add_code

docs/agent.html

@@ -46,7 +46,6 @@ <h1 class="logo"><a href="index.html">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a></li>
@@ -60,7 +59,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>

docs/benchmark.html

@@ -46,7 +46,6 @@ <h1 class="logo"><a href="index.html">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a></li>
@@ -55,7 +54,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>

docs/generate.html

@@ -46,7 +46,6 @@ <h1 class="logo"><a href="index.html">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Text Generation</a><ul>
@@ -60,7 +59,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>

docs/genindex.html

@@ -43,7 +43,6 @@ <h1 class="logo"><a href="index.html">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a></li>
@@ -52,7 +51,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>

docs/index.html

@@ -45,7 +45,6 @@ <h1 class="logo"><a href="#">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a></li>
@@ -54,7 +53,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>
@@ -98,8 +96,23 @@ <h3 id="searchlabel">Quick search</h3>
 <h1>Welcome to phi-3-vision-mlx’s documentation!<a class="headerlink" href="#welcome-to-phi-3-vision-mlx-s-documentation" title="Link to this heading">¶</a></h1>
 <p>Phi-3-MLX is a versatile AI framework that leverages both the Phi-3-Vision multimodal model and the recently updated Phi-3-Mini-128K language model, optimized for Apple Silicon using the MLX framework.</p>
 <p><a class="reference external" href="https://github.com/JosefAlbers/Phi-3-Vision-MLX">View the project on GitHub</a></p>
+<section id="features">
+<h2>Features<a class="headerlink" href="#features" title="Link to this heading">¶</a></h2>
+<ul class="simple">
+<li><p>Support for the newly updated Phi-3-Mini-128K (language-only) model</p></li>
+<li><p>Integration with Phi-3-Vision (multimodal) model</p></li>
+<li><p>Optimized performance on Apple Silicon using MLX</p></li>
+<li><p>Batched generation for processing multiple prompts</p></li>
+<li><p>Flexible agent system for various AI tasks</p></li>
+<li><p>Custom toolchains for specialized workflows</p></li>
+<li><p>Model quantization for improved efficiency</p></li>
+<li><p>LoRA fine-tuning capabilities</p></li>
+<li><p>API integration for extended functionality (e.g., image generation, text-to-speech)</p></li>
+</ul>
+</section>
+<section id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a><ul>
@@ -129,38 +142,15 @@ <h1>Welcome to phi-3-vision-mlx’s documentation!<a class="headerlink" href="#w
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
 </div>
+</section>
+<section id="api-reference">
+<h2>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>
 </ul>
 </div>
-<section id="features">
-<h2>Features<a class="headerlink" href="#features" title="Link to this heading">¶</a></h2>
-<ul class="simple">
-<li><p>Support for the newly updated Phi-3-Mini-128K (language-only) model</p></li>
-<li><p>Integration with Phi-3-Vision (multimodal) model</p></li>
-<li><p>Optimized performance on Apple Silicon using MLX</p></li>
-<li><p>Batched generation for processing multiple prompts</p></li>
-<li><p>Flexible agent system for various AI tasks</p></li>
-<li><p>Custom toolchains for specialized workflows</p></li>
-<li><p>Model quantization for improved efficiency</p></li>
-<li><p>LoRA fine-tuning capabilities</p></li>
-<li><p>API integration for extended functionality (e.g., image generation, text-to-speech)</p></li>
-</ul>
-</section>
-<section id="recent-updates-phi-3-mini-improvements">
-<h2>Recent Updates: Phi-3 Mini Improvements<a class="headerlink" href="#recent-updates-phi-3-mini-improvements" title="Link to this heading">¶</a></h2>
-<p>Microsoft has recently released significant updates to the Phi-3 Mini model, dramatically improving its capabilities:</p>
-<ul class="simple">
-<li><p>Substantially enhanced code understanding in Python, C++, Rust, and TypeScript</p></li>
-<li><p>Improved post-training for better-structured output</p></li>
-<li><p>Enhanced multi-turn instruction following</p></li>
-<li><p>Added support for the <cite>&lt;|system|&gt;</cite> tag</p></li>
-<li><p>Improved reasoning and long-context understanding</p></li>
-</ul>
-<p>For detailed benchmark results, please refer to the tables in the README.</p>
 </section>
 <section id="license">
 <h2>License<a class="headerlink" href="#license" title="Link to this heading">¶</a></h2>

docs/install.html

@@ -46,7 +46,6 @@ <h1 class="logo"><a href="index.html">phi-3-vision-mlx</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="generate.html">Text Generation</a></li>
@@ -55,7 +54,6 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="toolchain.html">Custom Toolchains</a></li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmark</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="module.html">Classes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="module.html#functions">Functions</a></li>