Skip to content

Commit 71d9a2a

Browse files
author
committed
Deployed 37b7368 with MkDocs version: 1.6.1
1 parent 9b89ba9 commit 71d9a2a

File tree

6 files changed

+227
-199
lines changed

6 files changed

+227
-199
lines changed

‎getting-started/installation/index.html‎

Lines changed: 129 additions & 119 deletions
Large diffs are not rendered by default.

‎getting-started/quick-start/index.html‎

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,42 @@
33
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
44
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a>
55
<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a><span class=c1># 2. Create a virtual environment INSIDE this directory</span>
6-
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a>python<span class=w> </span>-m<span class=w> </span>venv<span class=w> </span>.venv
7-
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a>
8-
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a><span class=c1># 3. Activate the virtual environment</span>
9-
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=c1># For bash/zsh (macOS/Linux):</span>
10-
<a id=__codelineno-0-10 name=__codelineno-0-10 href=#__codelineno-0-10></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
11-
<a id=__codelineno-0-11 name=__codelineno-0-11 href=#__codelineno-0-11></a><span class=c1># For fish:</span>
12-
<a id=__codelineno-0-12 name=__codelineno-0-12 href=#__codelineno-0-12></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate.fish
13-
<a id=__codelineno-0-13 name=__codelineno-0-13 href=#__codelineno-0-13></a><span class=c1># On Windows:</span>
14-
<a id=__codelineno-0-14 name=__codelineno-0-14 href=#__codelineno-0-14></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate
15-
<a id=__codelineno-0-15 name=__codelineno-0-15 href=#__codelineno-0-15></a>
16-
<a id=__codelineno-0-16 name=__codelineno-0-16 href=#__codelineno-0-16></a><span class=c1># 4. Install dspy-code (always upgrade for latest features)</span>
17-
<a id=__codelineno-0-17 name=__codelineno-0-17 href=#__codelineno-0-17></a>pip<span class=w> </span>install<span class=w> </span>--upgrade<span class=w> </span>dspy-code
18-
<a id=__codelineno-0-18 name=__codelineno-0-18 href=#__codelineno-0-18></a>
19-
<a id=__codelineno-0-19 name=__codelineno-0-19 href=#__codelineno-0-19></a><span class=c1># 5. (Optional but recommended) Install provider SDKs via dspy-code extras</span>
20-
<a id=__codelineno-0-20 name=__codelineno-0-20 href=#__codelineno-0-20></a>
21-
<a id=__codelineno-0-21 name=__codelineno-0-21 href=#__codelineno-0-21></a><span class=c1># If you ONLY want local models (Ollama), you can skip this step.</span>
22-
<a id=__codelineno-0-22 name=__codelineno-0-22 href=#__codelineno-0-22></a>
23-
<a id=__codelineno-0-23 name=__codelineno-0-23 href=#__codelineno-0-23></a><span class=c1># OpenAI support</span>
24-
<a id=__codelineno-0-24 name=__codelineno-0-24 href=#__codelineno-0-24></a>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[openai]&quot;</span>
25-
<a id=__codelineno-0-25 name=__codelineno-0-25 href=#__codelineno-0-25></a>
26-
<a id=__codelineno-0-26 name=__codelineno-0-26 href=#__codelineno-0-26></a><span class=c1># Google Gemini support</span>
27-
<a id=__codelineno-0-27 name=__codelineno-0-27 href=#__codelineno-0-27></a>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[gemini]&quot;</span>
6+
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a><span class=c1># Recommended: Use uv (faster and more reliable)</span>
7+
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a>uv<span class=w> </span>venv
8+
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a>
9+
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=c1># Alternative: Use standard Python venv</span>
10+
<a id=__codelineno-0-10 name=__codelineno-0-10 href=#__codelineno-0-10></a><span class=c1># python -m venv .venv</span>
11+
<a id=__codelineno-0-11 name=__codelineno-0-11 href=#__codelineno-0-11></a>
12+
<a id=__codelineno-0-12 name=__codelineno-0-12 href=#__codelineno-0-12></a><span class=c1># 3. Activate the virtual environment</span>
13+
<a id=__codelineno-0-13 name=__codelineno-0-13 href=#__codelineno-0-13></a><span class=c1># For bash/zsh (macOS/Linux):</span>
14+
<a id=__codelineno-0-14 name=__codelineno-0-14 href=#__codelineno-0-14></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate
15+
<a id=__codelineno-0-15 name=__codelineno-0-15 href=#__codelineno-0-15></a><span class=c1># For fish:</span>
16+
<a id=__codelineno-0-16 name=__codelineno-0-16 href=#__codelineno-0-16></a><span class=nb>source</span><span class=w> </span>.venv/bin/activate.fish
17+
<a id=__codelineno-0-17 name=__codelineno-0-17 href=#__codelineno-0-17></a><span class=c1># On Windows:</span>
18+
<a id=__codelineno-0-18 name=__codelineno-0-18 href=#__codelineno-0-18></a>.venv<span class=se>\S</span>cripts<span class=se>\a</span>ctivate
19+
<a id=__codelineno-0-19 name=__codelineno-0-19 href=#__codelineno-0-19></a>
20+
<a id=__codelineno-0-20 name=__codelineno-0-20 href=#__codelineno-0-20></a><span class=c1># 4. Install dspy-code (always upgrade for latest features)</span>
21+
<a id=__codelineno-0-21 name=__codelineno-0-21 href=#__codelineno-0-21></a><span class=c1># Recommended: Use uv</span>
22+
<a id=__codelineno-0-22 name=__codelineno-0-22 href=#__codelineno-0-22></a>uv<span class=w> </span>pip<span class=w> </span>install<span class=w> </span>--upgrade<span class=w> </span>dspy-code
23+
<a id=__codelineno-0-23 name=__codelineno-0-23 href=#__codelineno-0-23></a>
24+
<a id=__codelineno-0-24 name=__codelineno-0-24 href=#__codelineno-0-24></a><span class=c1># Alternative: Use pip</span>
25+
<a id=__codelineno-0-25 name=__codelineno-0-25 href=#__codelineno-0-25></a><span class=c1># pip install --upgrade dspy-code</span>
26+
<a id=__codelineno-0-26 name=__codelineno-0-26 href=#__codelineno-0-26></a>
27+
<a id=__codelineno-0-27 name=__codelineno-0-27 href=#__codelineno-0-27></a><span class=c1># 5. (Optional but recommended) Install provider SDKs via dspy-code extras</span>
2828
<a id=__codelineno-0-28 name=__codelineno-0-28 href=#__codelineno-0-28></a>
29-
<a id=__codelineno-0-29 name=__codelineno-0-29 href=#__codelineno-0-29></a><span class=c1># Anthropic (paid key required)</span>
30-
<a id=__codelineno-0-30 name=__codelineno-0-30 href=#__codelineno-0-30></a>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[anthropic]&quot;</span>
31-
<a id=__codelineno-0-31 name=__codelineno-0-31 href=#__codelineno-0-31></a>
32-
<a id=__codelineno-0-32 name=__codelineno-0-32 href=#__codelineno-0-32></a><span class=c1># Or install all cloud providers at once</span>
33-
<a id=__codelineno-0-33 name=__codelineno-0-33 href=#__codelineno-0-33></a>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[llm-all]&quot;</span>
29+
<a id=__codelineno-0-29 name=__codelineno-0-29 href=#__codelineno-0-29></a><span class=c1># If you ONLY want local models (Ollama), you can skip this step.</span>
30+
<a id=__codelineno-0-30 name=__codelineno-0-30 href=#__codelineno-0-30></a>
31+
<a id=__codelineno-0-31 name=__codelineno-0-31 href=#__codelineno-0-31></a><span class=c1># If using uv (recommended):</span>
32+
<a id=__codelineno-0-32 name=__codelineno-0-32 href=#__codelineno-0-32></a>uv<span class=w> </span>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[openai]&quot;</span><span class=w> </span><span class=c1># OpenAI support</span>
33+
<a id=__codelineno-0-33 name=__codelineno-0-33 href=#__codelineno-0-33></a>uv<span class=w> </span>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[gemini]&quot;</span><span class=w> </span><span class=c1># Google Gemini support</span>
34+
<a id=__codelineno-0-34 name=__codelineno-0-34 href=#__codelineno-0-34></a>uv<span class=w> </span>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[anthropic]&quot;</span><span class=w> </span><span class=c1># Anthropic (paid key required)</span>
35+
<a id=__codelineno-0-35 name=__codelineno-0-35 href=#__codelineno-0-35></a>uv<span class=w> </span>pip<span class=w> </span>install<span class=w> </span><span class=s2>&quot;dspy-code[llm-all]&quot;</span><span class=w> </span><span class=c1># Or install all cloud providers at once</span>
36+
<a id=__codelineno-0-36 name=__codelineno-0-36 href=#__codelineno-0-36></a>
37+
<a id=__codelineno-0-37 name=__codelineno-0-37 href=#__codelineno-0-37></a><span class=c1># If using pip:</span>
38+
<a id=__codelineno-0-38 name=__codelineno-0-38 href=#__codelineno-0-38></a><span class=c1># pip install &quot;dspy-code[openai]&quot;</span>
39+
<a id=__codelineno-0-39 name=__codelineno-0-39 href=#__codelineno-0-39></a><span class=c1># pip install &quot;dspy-code[gemini]&quot;</span>
40+
<a id=__codelineno-0-40 name=__codelineno-0-40 href=#__codelineno-0-40></a><span class=c1># pip install &quot;dspy-code[anthropic]&quot;</span>
41+
<a id=__codelineno-0-41 name=__codelineno-0-41 href=#__codelineno-0-41></a><span class=c1># pip install &quot;dspy-code[llm-all]&quot;</span>
3442
</code></pre></div> <p>For more details, see the <a href=../installation/ >Installation Guide</a>.</p> <h2 id=step-1-navigate-to-your-project>Step 1: Navigate to Your Project</h2> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=c1># Go to your project directory</span>
3543
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=nb>cd</span><span class=w> </span>my-dspy-project
3644
<a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a>

‎reference/commands/index.html‎

Lines changed: 24 additions & 14 deletions
Large diffs are not rendered by default.

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎sitemap.xml‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,154 +2,154 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://superagenticai.github.io/dspy-code/</loc>
5-
<lastmod>2025-11-26</lastmod>
5+
<lastmod>2025-11-27</lastmod>
66
</url>
77
<url>
88
<loc>https://superagenticai.github.io/dspy-code/about/</loc>
9-
<lastmod>2025-11-26</lastmod>
9+
<lastmod>2025-11-27</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://superagenticai.github.io/dspy-code/about/changelog/</loc>
13-
<lastmod>2025-11-26</lastmod>
13+
<lastmod>2025-11-27</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://superagenticai.github.io/dspy-code/about/contributing/</loc>
17-
<lastmod>2025-11-26</lastmod>
17+
<lastmod>2025-11-27</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://superagenticai.github.io/dspy-code/about/license/</loc>
21-
<lastmod>2025-11-26</lastmod>
21+
<lastmod>2025-11-27</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://superagenticai.github.io/dspy-code/about/why-dspy-code/</loc>
25-
<lastmod>2025-11-26</lastmod>
25+
<lastmod>2025-11-27</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://superagenticai.github.io/dspy-code/advanced/cicd/</loc>
29-
<lastmod>2025-11-26</lastmod>
29+
<lastmod>2025-11-27</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://superagenticai.github.io/dspy-code/advanced/custom-modules/</loc>
33-
<lastmod>2025-11-26</lastmod>
33+
<lastmod>2025-11-27</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://superagenticai.github.io/dspy-code/advanced/deployment/</loc>
37-
<lastmod>2025-11-26</lastmod>
37+
<lastmod>2025-11-27</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://superagenticai.github.io/dspy-code/advanced/mcp-integration/</loc>
41-
<lastmod>2025-11-26</lastmod>
41+
<lastmod>2025-11-27</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://superagenticai.github.io/dspy-code/getting-started/first-program/</loc>
45-
<lastmod>2025-11-26</lastmod>
45+
<lastmod>2025-11-27</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://superagenticai.github.io/dspy-code/getting-started/installation/</loc>
49-
<lastmod>2025-11-26</lastmod>
49+
<lastmod>2025-11-27</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://superagenticai.github.io/dspy-code/getting-started/quick-start/</loc>
53-
<lastmod>2025-11-26</lastmod>
53+
<lastmod>2025-11-27</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://superagenticai.github.io/dspy-code/getting-started/understanding/</loc>
57-
<lastmod>2025-11-26</lastmod>
57+
<lastmod>2025-11-27</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://superagenticai.github.io/dspy-code/guide/adapters/</loc>
61-
<lastmod>2025-11-26</lastmod>
61+
<lastmod>2025-11-27</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://superagenticai.github.io/dspy-code/guide/async-streaming/</loc>
65-
<lastmod>2025-11-26</lastmod>
65+
<lastmod>2025-11-27</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://superagenticai.github.io/dspy-code/guide/creating-gold-data/</loc>
69-
<lastmod>2025-11-26</lastmod>
69+
<lastmod>2025-11-27</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://superagenticai.github.io/dspy-code/guide/evaluation/</loc>
73-
<lastmod>2025-11-26</lastmod>
73+
<lastmod>2025-11-27</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://superagenticai.github.io/dspy-code/guide/generating-code/</loc>
77-
<lastmod>2025-11-26</lastmod>
77+
<lastmod>2025-11-27</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://superagenticai.github.io/dspy-code/guide/interactive-mode/</loc>
81-
<lastmod>2025-11-26</lastmod>
81+
<lastmod>2025-11-27</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://superagenticai.github.io/dspy-code/guide/model-connection/</loc>
85-
<lastmod>2025-11-26</lastmod>
85+
<lastmod>2025-11-27</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://superagenticai.github.io/dspy-code/guide/natural-language-commands/</loc>
89-
<lastmod>2025-11-26</lastmod>
89+
<lastmod>2025-11-27</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://superagenticai.github.io/dspy-code/guide/optimization/</loc>
93-
<lastmod>2025-11-26</lastmod>
93+
<lastmod>2025-11-27</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://superagenticai.github.io/dspy-code/guide/project-management/</loc>
97-
<lastmod>2025-11-26</lastmod>
97+
<lastmod>2025-11-27</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://superagenticai.github.io/dspy-code/guide/retrievers/</loc>
101-
<lastmod>2025-11-26</lastmod>
101+
<lastmod>2025-11-27</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://superagenticai.github.io/dspy-code/guide/running-programs/</loc>
105-
<lastmod>2025-11-26</lastmod>
105+
<lastmod>2025-11-27</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://superagenticai.github.io/dspy-code/guide/slash-commands/</loc>
109-
<lastmod>2025-11-26</lastmod>
109+
<lastmod>2025-11-27</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://superagenticai.github.io/dspy-code/guide/validation/</loc>
113-
<lastmod>2025-11-26</lastmod>
113+
<lastmod>2025-11-27</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://superagenticai.github.io/dspy-code/reference/commands/</loc>
117-
<lastmod>2025-11-26</lastmod>
117+
<lastmod>2025-11-27</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://superagenticai.github.io/dspy-code/reference/configuration/</loc>
121-
<lastmod>2025-11-26</lastmod>
121+
<lastmod>2025-11-27</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://superagenticai.github.io/dspy-code/reference/faq/</loc>
125-
<lastmod>2025-11-26</lastmod>
125+
<lastmod>2025-11-27</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://superagenticai.github.io/dspy-code/reference/security/</loc>
129-
<lastmod>2025-11-26</lastmod>
129+
<lastmod>2025-11-27</lastmod>
130130
</url>
131131
<url>
132132
<loc>https://superagenticai.github.io/dspy-code/reference/templates/</loc>
133-
<lastmod>2025-11-26</lastmod>
133+
<lastmod>2025-11-27</lastmod>
134134
</url>
135135
<url>
136136
<loc>https://superagenticai.github.io/dspy-code/reference/troubleshooting/</loc>
137-
<lastmod>2025-11-26</lastmod>
137+
<lastmod>2025-11-27</lastmod>
138138
</url>
139139
<url>
140140
<loc>https://superagenticai.github.io/dspy-code/tutorials/gepa-optimization/</loc>
141-
<lastmod>2025-11-26</lastmod>
141+
<lastmod>2025-11-27</lastmod>
142142
</url>
143143
<url>
144144
<loc>https://superagenticai.github.io/dspy-code/tutorials/question-answering/</loc>
145-
<lastmod>2025-11-26</lastmod>
145+
<lastmod>2025-11-27</lastmod>
146146
</url>
147147
<url>
148148
<loc>https://superagenticai.github.io/dspy-code/tutorials/rag-system/</loc>
149-
<lastmod>2025-11-26</lastmod>
149+
<lastmod>2025-11-27</lastmod>
150150
</url>
151151
<url>
152152
<loc>https://superagenticai.github.io/dspy-code/tutorials/sentiment-analyzer/</loc>
153-
<lastmod>2025-11-26</lastmod>
153+
<lastmod>2025-11-27</lastmod>
154154
</url>
155155
</urlset>

‎sitemap.xml.gz‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)