Skip to content

Commit 96eab6c

Browse files
committed
Merge branch 'main' of https://github.com/stanfordnlp/dspy
2 parents 1f23080 + dd34523 commit 96eab6c

File tree

10 files changed

+14
-62
lines changed

10 files changed

+14
-62
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,9 @@
1313

1414
----
1515

16-
DSPy is the open-source framework for **building high-quality, modular AI systems** by _programming—rather than prompting—language models_. It provides abstractions and algorithms for **optimizing the prompts and weights** in LM programs, ranging from simple classifiers to sophisticated RAG pipelines and Agent loops.
17-
18-
Instead of writing brittle LM-specific prompts, you write compositional code and use DSPy optimizers to teach different models like `GPT-4o` or `Llama-3.2` to **deliver higher quality outputs** or avoid specific failure patterns. In essence, DSPy optimizers then _compile your high-level code_ into low-level computations, prompts, or weight updates that **align your LM with your program’s structure and metrics**.
19-
20-
21-
DSPy stands for Declarative Self-improving Python. This [recent lecture](https://www.youtube.com/watch?v=JEMYuzrKLUw) is a good conceptual introduction. Our [Discord server](https://discord.gg/XCGy2WDCQB) is a great place to meet the community, seek help, or start contributing.
16+
DSPy is the open-source framework for _programming—rather than prompting—language models_. It allows you to iterate fast on **building modular AI systems** and provides algorithms for **optimizing their prompts and weights**, whether you're building simple classifiers, sophisticated RAG pipelines, or Agent loops.
2217

18+
DSPy stands for Declarative Self-improving Python. Instead of brittle prompts, you write compositional _Python code_ and use DSPy's tools to **teach your LM to deliver high-quality outputs**. This [lecture](https://www.youtube.com/watch?v=JEMYuzrKLUw) is a good conceptual introduction. Meet the community, seek help, or start contributing via our GitHub repo here and our [Discord server](https://discord.gg/XCGy2WDCQB).
2319

2420

2521
## Documentation: [dspy.ai](https://dspy.ai)

docs/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DSPy Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This website is built using [Material for MKDocs](https://squidfunk.github.io/mkdocs-material/), a Material UI inspired theme for MKDocs.
44

55
## Building docs locally
66

@@ -13,21 +13,27 @@ To build and test the documentation locally:
1313

1414
2. Install the necessary dependencies:
1515
```bash
16-
npm install
16+
pip install -r requirements.txt
1717
```
1818

1919
3. Run the build command:
2020
```bash
21-
npm run build
21+
mkdocs build
2222
```
2323

24-
This will generate a static build of the documentation site in the `build` directory. You can then serve this directory to view the site locally. If you see the build failing make sure to fix it before pushing.
24+
This will generate a static build of the documentation site in the `site` directory. You can then serve this directory to view the site locally using:
25+
26+
```bash
27+
mkdocs serve
28+
```
29+
30+
If you see the build failing make sure to fix it before pushing.
2531

2632
## Continuous Integration (CI) Build Checks
2733

2834
We have automated build checks set up in our CI pipeline to ensure the documentation builds successfully before merging changes. These checks:
2935

30-
1. Run the `npm run build` command
36+
1. Run the `mkdocs build` command
3137
2. Verify that the build completes without errors
3238
3. Help catch potential issues early in the development process
3339

docs/docs/blog/index.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/docs/deep-dive/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/docs/deep-dive/data-handling/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/docs/deep-dive/language_model_clients/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/docs/deep-dive/modules/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/docs/deep-dive/optimizers/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/docs/deep-dive/retrieval_models_clients/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ plugins:
102102
- social
103103
- search
104104
- mkdocstrings
105-
- blog
105+
# - blog
106106
- mkdocs-jupyter:
107107
ignore_h1_titles: True
108108
- redirects:

0 commit comments

Comments
 (0)