Deployed 0890466 with MkDocs version: 1.6.1

about/changelog/index.html

@@ -5,9 +5,12 @@
 <a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a>python<span class=w> </span>-m<span class=w> </span>venv<span class=w> </span>.venv
 <a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a>
 <a id=__codelineno-1-4 name=__codelineno-1-4 href=#__codelineno-1-4></a><span class=c1># Activate it</span>
-<a id=__codelineno-1-5 name=__codelineno-1-5 href=#__codelineno-1-5></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># On macOS/Linux</span>
-<a id=__codelineno-1-6 name=__codelineno-1-6 href=#__codelineno-1-6></a><span class=c1># OR</span>
-<a id=__codelineno-1-7 name=__codelineno-1-7 href=#__codelineno-1-7></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate<span class=w>  </span><span class=c1># On Windows</span>
+<a id=__codelineno-1-5 name=__codelineno-1-5 href=#__codelineno-1-5></a><span class=c1># For bash/zsh (macOS/Linux):</span>
+<a id=__codelineno-1-6 name=__codelineno-1-6 href=#__codelineno-1-6></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-1-7 name=__codelineno-1-7 href=#__codelineno-1-7></a><span class=c1># For fish shell:</span>
+<a id=__codelineno-1-8 name=__codelineno-1-8 href=#__codelineno-1-8></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate.fish
+<a id=__codelineno-1-9 name=__codelineno-1-9 href=#__codelineno-1-9></a><span class=c1># On Windows:</span>
+<a id=__codelineno-1-10 name=__codelineno-1-10 href=#__codelineno-1-10></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate
 </code></pre></div> <div class="admonition success"> <p class=admonition-title>Why .venv in the Project?</p> <p>When you create the virtual environment inside your project:</p> <ul> <li>All packages install to <code>my-dspy-project/.venv/</code></li> <li>All dspy-code data goes to <code>my-dspy-project/.dspy_code/</code></li> <li>Everything stays in one place!</li> </ul> <p><strong>Result</strong>: One directory = one complete project</p> </div> <h3 id=step-3-install-dspy-code>Step 3: Install DSPy Code</h3> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=c1># This installs into .venv/ in your project</span>
 <a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a>pip<span class=w> </span>install<span class=w> </span>dspy-code
 </code></pre></div> <p>That's it! DSPy Code is now installed in your project.</p> <h3 id=from-source>From Source</h3> <p>If you want the latest development version:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=c1># Clone the repository</span>
@@ -17,12 +20,12 @@
 <a id=__codelineno-3-5 name=__codelineno-3-5 href=#__codelineno-3-5></a><span class=c1># Install in development mode</span>
 <a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a>pip<span class=w> </span>install<span class=w> </span>-e<span class=w> </span>.
 </code></pre></div> <h2 id=install-dspy>Install DSPy</h2> <p>DSPy Code requires DSPy to be installed. If you don't have it yet:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a>pip<span class=w> </span>install<span class=w> </span>dspy
-</code></pre></div> <div class="admonition info"> <p class=admonition-title>DSPy Version</p> <p>DSPy Code works with any DSPy version (2.x, 3.x, or newer). It adapts to YOUR installed version!</p> </div> <h3 id=step-4-install-dspy-optional>Step 4: Install DSPy (Optional)</h3> <p>DSPy Code works with any version of DSPy you have installed:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a>pip<span class=w> </span>install<span class=w> </span>dspy-ai
+</code></pre></div> <div class="admonition info"> <p class=admonition-title>DSPy Version</p> <p>DSPy Code works with any DSPy version (2.x, 3.x, or newer). It adapts to YOUR installed version!</p> </div> <h3 id=step-4-install-dspy-optional>Step 4: Install DSPy (Optional)</h3> <p>DSPy Code works with any version of DSPy you have installed:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a>pip<span class=w> </span>install<span class=w> </span>dspy
 </code></pre></div> <div class="admonition info"> <p class=admonition-title>DSPy Version</p> <p>DSPy Code adapts to YOUR installed DSPy version! It indexes your specific version for accurate code generation and Q&amp;A.</p> </div> <h2 id=verify-installation>Verify Installation</h2> <p>Check that everything is installed correctly:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=c1># Make sure you&#39;re in your project directory</span>
 <a id=__codelineno-6-2 name=__codelineno-6-2 href=#__codelineno-6-2></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
 <a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a>
 <a id=__codelineno-6-4 name=__codelineno-6-4 href=#__codelineno-6-4></a><span class=c1># Activate your virtual environment if not already active</span>
-<a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># For fish: source .venv/bin/activate.fish</span>
 <a id=__codelineno-6-6 name=__codelineno-6-6 href=#__codelineno-6-6></a>
 <a id=__codelineno-6-7 name=__codelineno-6-7 href=#__codelineno-6-7></a><span class=c1># Check DSPy Code</span>
 <a id=__codelineno-6-8 name=__codelineno-6-8 href=#__codelineno-6-8></a>dspy-code<span class=w> </span>--help
@@ -57,7 +60,7 @@
 </code></pre></div> <h3 id=for-google-gemini>For Google Gemini</h3> <div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a>pip<span class=w> </span>install<span class=w> </span>google-generativeai
 </code></pre></div> <h3 id=for-semantic-similarity-metrics>For Semantic Similarity Metrics</h3> <div class=highlight><pre><span></span><code><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a>pip<span class=w> </span>install<span class=w> </span>sentence-transformers<span class=w> </span>scikit-learn
 </code></pre></div> <div class="admonition tip"> <p class=admonition-title>Install as Needed</p> <p>Don't worry about installing these now. DSPy Code will tell you if you need something and show you exactly how to install it!</p> </div> <h2 id=troubleshooting>Troubleshooting</h2> <h3 id=command-not-found-dspy-code>"command not found: dspy-code"</h3> <p>If you see this error:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=c1># Make sure your virtual environment is activated</span>
-<a id=__codelineno-13-2 name=__codelineno-13-2 href=#__codelineno-13-2></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-13-2 name=__codelineno-13-2 href=#__codelineno-13-2></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># For fish: source .venv/bin/activate.fish</span>
 <a id=__codelineno-13-3 name=__codelineno-13-3 href=#__codelineno-13-3></a>
 <a id=__codelineno-13-4 name=__codelineno-13-4 href=#__codelineno-13-4></a><span class=c1># Verify installation</span>
 <a id=__codelineno-13-5 name=__codelineno-13-5 href=#__codelineno-13-5></a>pip<span class=w> </span>list<span class=w> </span><span class=p>|</span><span class=w> </span>grep<span class=w> </span>dspy-code
@@ -67,7 +70,7 @@
 </code></pre></div> <h3 id=running-from-wrong-directory>Running from Wrong Directory</h3> <p>If you see security warnings when starting dspy-code:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a>🚨 SECURITY WARNING
 <a id=__codelineno-14-2 name=__codelineno-14-2 href=#__codelineno-14-2></a>You are running dspy-code from your home directory!
 </code></pre></div> <p><strong>Solution</strong>: Always run from your project directory:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
-<a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># For fish: source .venv/bin/activate.fish</span>
 <a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a>dspy-code
 </code></pre></div> <h3 id=python-version-too-old>Python Version Too Old</h3> <p>If you see an error about Python version:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=c1># Check your Python version</span>
 <a id=__codelineno-16-2 name=__codelineno-16-2 href=#__codelineno-16-2></a>python<span class=w> </span>--version
@@ -85,7 +88,7 @@
 <a id=__codelineno-17-7 name=__codelineno-17-7 href=#__codelineno-17-7></a>python<span class=w> </span>-m<span class=w> </span>venv<span class=w> </span>.venv<span class=w>     </span><span class=c1># ✅ Do this!</span>
 </code></pre></div> <h3 id=permission-denied>Permission Denied</h3> <p>If you get permission errors, <strong>don't use --user or sudo</strong>. Use a virtual environment:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
 <a id=__codelineno-18-2 name=__codelineno-18-2 href=#__codelineno-18-2></a>python<span class=w> </span>-m<span class=w> </span>venv<span class=w> </span>.venv
-<a id=__codelineno-18-3 name=__codelineno-18-3 href=#__codelineno-18-3></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-18-3 name=__codelineno-18-3 href=#__codelineno-18-3></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># For fish: source .venv/bin/activate.fish</span>
 <a id=__codelineno-18-4 name=__codelineno-18-4 href=#__codelineno-18-4></a>pip<span class=w> </span>install<span class=w> </span>dspy-code
 </code></pre></div> <h2 id=next-steps>Next Steps</h2> <p>Now that you have DSPy Code installed, let's run it!</p> <p><a href=../quick-start/ class="md-button md-button--primary">Quick Start Guide →</a></p> <h2 id=system-specific-notes>System-Specific Notes</h2> <h3 id=macos>macOS</h3> <p>DSPy Code works great on macOS. If you use Homebrew:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a><span class=c1># Install Python (if needed)</span>
 <a id=__codelineno-19-2 name=__codelineno-19-2 href=#__codelineno-19-2></a>brew<span class=w> </span>install<span class=w> </span>python@3.11

about/index.html

@@ -2,9 +2,12 @@
 <a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
 <a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a>
 <a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=c1># Activate your virtual environment</span>
-<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate<span class=w>  </span><span class=c1># macOS/Linux</span>
-<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a><span class=c1># OR</span>
-<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate<span class=w>  </span><span class=c1># Windows</span>
+<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a><span class=c1># For bash/zsh (macOS/Linux):</span>
+<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
+<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a><span class=c1># For fish shell:</span>
+<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate.fish
+<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=c1># On Windows:</span>
+<a id=__codelineno-0-10 name=__codelineno-0-10 href=#__codelineno-0-10></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate
 </code></pre></div> <div class="admonition tip"> <p class=admonition-title>Always Activate Your Venv</p> <p>Make sure your virtual environment is activated before running dspy-code. You should see <code>(.venv)</code> in your terminal prompt.</p> </div> <h2 id=step-2-start-the-cli>Step 2: Start the CLI</h2> <p>Open your terminal and run:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a>dspy-code
 </code></pre></div> <p>You'll see a beautiful welcome screen with the DSPy version and helpful tips.</p> <div class="admonition success"> <p class=admonition-title>What You'll See</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>✓ DSPy Version: 3.0.4
 <a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a>

getting-started/installation/index.html

@@ -93,7 +93,7 @@
 <a id=__codelineno-17-5 name=__codelineno-17-5 href=#__codelineno-17-5></a>class ChainOfThought(Predict):
 <a id=__codelineno-17-6 name=__codelineno-17-6 href=#__codelineno-17-6></a>    def __init__(self, signature, rationale_type=None, **config):
 <a id=__codelineno-17-7 name=__codelineno-17-7 href=#__codelineno-17-7></a>        ...
-</code></pre></div> <h2 id=how-optimization-works>How Optimization Works</h2> <h3 id=gepa-overview>GEPA Overview</h3> <p>GEPA (Genetic Prompt Evolution Algorithm) optimizes DSPy programs by:</p> <ol> <li><strong>Evaluation</strong>: Test current performance</li> <li><strong>Reflection</strong>: Analyze failures</li> <li><strong>Evolution</strong>: Generate better prompts</li> <li><strong>Selection</strong>: Keep best versions</li> <li><strong>Iteration</strong>: Repeat until optimal</li> </ol> <h3 id=optimization-process>Optimization Process</h3> <p><strong>1. Prepare Data:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a>/generate data 50 for sentiment analysis
+</code></pre></div> <h2 id=how-optimization-works>How Optimization Works</h2> <h3 id=gepa-overview>GEPA Overview</h3> <p>GEPA (Genetic Pareto) optimizes DSPy programs by:</p> <ol> <li><strong>Evaluation</strong>: Test current performance</li> <li><strong>Reflection</strong>: Analyze failures</li> <li><strong>Evolution</strong>: Generate better prompts</li> <li><strong>Selection</strong>: Keep best versions</li> <li><strong>Iteration</strong>: Repeat until optimal</li> </ol> <h3 id=optimization-process>Optimization Process</h3> <p><strong>1. Prepare Data:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a>/generate data 50 for sentiment analysis
 <a id=__codelineno-18-2 name=__codelineno-18-2 href=#__codelineno-18-2></a>/save-data sentiment_data.jsonl
 </code></pre></div> <p><strong>2. Generate Optimization Script:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a>/optimize sentiment_analyzer.py sentiment_data.jsonl
 </code></pre></div> <p><strong>3. Run GEPA:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-20-1 name=__codelineno-20-1 href=#__codelineno-20-1></a><span class=kn>from</span><span class=w> </span><span class=nn>dspy.teleprompt</span><span class=w> </span><span class=kn>import</span> <span class=n>GEPA</span>