Skip to content

Commit e445a13

Browse files
committed
Update Optimas docs
1 parent 259e0e9 commit e445a13

File tree

6 files changed

+90
-9
lines changed

6 files changed

+90
-9
lines changed

docs/environment-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Virtual environments isolate project dependencies, preventing conflicts between
194194
=== "⚡ uv (Recommended)"
195195
```bash
196196
# Install SuperOptiX
197-
uv pip install superoptix --prerelease=allow
197+
uv pip install superoptix
198198

199199
# Install with optional dependencies
200200
uv pip install "superoptix[vectordb,ui,observability]"
@@ -485,7 +485,7 @@ which pip
485485
curl -LsSf https://astral.sh/uv/install.sh | sh
486486

487487
# Use uv instead of pip
488-
uv pip install superoptix --prerelease=allow
488+
uv pip install superoptix
489489
```
490490

491491
=== "📦 Using Conda for Better Dependency Resolution"

docs/examples/agents/optimas-examples.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ title: Optimas Examples
66

77
Working examples and demos for all Optimas integration targets. These examples have been verified to work correctly with the latest SuperOptiX version.
88

9+
Background reading and references:
10+
11+
- Optimas website: [optimas.stanford.edu](https://optimas.stanford.edu)
12+
- Optimas paper (Wu et al., 2025): [arXiv: 2507.03041](https://www.arxiv.org/pdf/2507.03041)
13+
- DSPy: [dspy.ai](https://dspy.ai)
14+
- CrewAI: [docs.crewai.com](https://docs.crewai.com)
15+
- AutoGen: [microsoft.github.io/autogen](https://microsoft.github.io/autogen/)
16+
- OpenAI Agent SDK: [platform.openai.com/docs/agents](https://platform.openai.com/docs/agents)
17+
- LiteLLM: [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm)
18+
919
## 🚀 Quick Demo
1020

1121
### Pull Demo Playbooks

docs/guides/optimas-integration.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,67 @@ title: Optimas Integration Guide
66

77
SuperOptiX integrates seamlessly with the **Optimas** framework, enabling you to use advanced prompt optimization techniques (OPRO, MIPRO, COPRO) with multiple LLM frameworks including **OpenAI SDK**, **CrewAI**, **AutoGen**, and **DSPy**.
88

9+
> About Optimas: Optimas optimizes compound AI systems using globally aligned Local Reward Functions (LRFs) so that local improvements translate to higher end‑to‑end performance. Learn more on the official site and paper:
10+
11+
- Optimas website: [optimas.stanford.edu](https://optimas.stanford.edu)
12+
- Optimas paper (Wu et al., 2025): [arXiv: 2507.03041](https://www.arxiv.org/pdf/2507.03041)
13+
14+
Related frameworks supported by this guide:
15+
16+
- DSPy: [dspy.ai](https://dspy.ai)
17+
- CrewAI: [docs.crewai.com](https://docs.crewai.com)
18+
- AutoGen: [microsoft.github.io/autogen](https://microsoft.github.io/autogen/)
19+
- OpenAI Agent SDK: [platform.openai.com/docs/agents](https://platform.openai.com/docs/agents)
20+
- LiteLLM (used by some targets): [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm)
21+
22+
## What Optimas is (and why it matters)
23+
24+
[Optimas](https://optimas.stanford.edu) is a unified optimization framework for compound AI systems:
25+
26+
- Learns a Local Reward Function (LRF) per component that remains globally aligned, so local updates are safe and beneficial to the whole system. This enables efficient optimization without always running the entire pipeline. See: [arXiv: 2507.03041](https://www.arxiv.org/pdf/2507.03041).
27+
- Supports heterogeneous configuration types:
28+
- Prompts and textual instructions via metric‑guided search
29+
- Hyperparameters and discrete choices (e.g., top‑k, tool/model selection, routing)
30+
- Model parameters where supported (e.g., RL with PPO)
31+
- Works across frameworks via target adapters: [OpenAI Agent SDK](https://platform.openai.com/docs/agents), [CrewAI](https://docs.crewai.com), [AutoGen](https://microsoft.github.io/autogen/), and [DSPy](https://dspy.ai)
32+
- Compound‑system optimization: operates across multiple components and tools, not just single prompts
33+
- Multiple optimizers available: OPRO (single‑iteration), MIPRO (multi‑iteration), COPRO (cooperative)
34+
35+
## What this unlocks
36+
37+
- Optimize prompts, hyperparameters, model parameters, and model routers across compound AI systems
38+
- Run OPRO, MIPRO, and COPRO optimization loops through a single CLI workflow
39+
- Keep your preferred agent stack (DSPy, CrewAI, AutoGen, OpenAI SDK) and get consistent optimization behavior
40+
41+
## Why this is impactful
42+
43+
- Globally aligned local rewards: maximizing a component’s local reward increases overall system quality, improving data efficiency by reducing full system runs
44+
- Heterogeneous updates across prompts, hyperparameters, routing/model selection, and (where applicable) model parameters via RL
45+
- Reported average relative improvement of 11.92% across five compound systems with theoretical guarantees and strong empirical results:
46+
- Optimas site: [optimas.stanford.edu](https://optimas.stanford.edu)
47+
- Paper: [arXiv: 2507.03041](https://www.arxiv.org/pdf/2507.03041)
48+
49+
## Where Optimas fits in SuperOptiX
50+
51+
Optimas integrates into the standard SuperOptiX lifecycle:
52+
53+
1. Compile your agent for a specific target
54+
2. Evaluate to establish a baseline
55+
3. Optimize with Optimas (OPRO/MIPRO/COPRO) using the same CLI across targets
56+
4. Run the optimized agent
57+
58+
This extends optimization beyond prompts to hyperparameters, model selection/routing, and parameters where supported.
59+
60+
- Focus‑aligned: SuperOptiX is built for optimization; Optimas operationalizes it across agents and tools
61+
- Beyond prompts: optimize prompts, hyperparameters, parameters, and routers for production workflows
62+
- One CLI to rule them all: compile → evaluate → optimize → run across all targets
63+
64+
## Optimas vs. DSPy (complementary)
65+
66+
- [DSPy](https://dspy.ai) is a framework for composing LLM pipelines and programmatic teleprompting
67+
- Optimas is an optimization engine that runs globally aligned local updates across multi‑component systems, regardless of the underlying framework (including DSPy)
68+
- In practice: build in your preferred stack; use Optimas to optimize end‑to‑end. If using DSPy, try `--optimizer mipro` for deeper prompt refinement (OPRO and COPRO also supported)
69+
970
## 🚀 Quick Start
1071

1172
### 1. Install SuperOptiX with Optimas Support
@@ -447,4 +508,14 @@ SUPEROPTIX_OPRO_COMPILE_TIMEOUT=300
447508
- [CLI Reference](../reference/cli.md) - Complete command reference
448509
- [Agent Development](../guides/agent-development.md) - Building custom agents
449510

511+
## 📖 External References
512+
513+
- Optimas website: [optimas.stanford.edu](https://optimas.stanford.edu)
514+
- Optimas paper (Wu et al., 2025): [arXiv: 2507.03041](https://www.arxiv.org/pdf/2507.03041)
515+
- DSPy: [dspy.ai](https://dspy.ai)
516+
- CrewAI: [docs.crewai.com](https://docs.crewai.com)
517+
- AutoGen: [microsoft.github.io/autogen](https://microsoft.github.io/autogen/)
518+
- OpenAI Agent SDK: [platform.openai.com/docs/agents](https://platform.openai.com/docs/agents)
519+
- LiteLLM: [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm)
520+
450521

docs/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Choose your preferred method:
6161
curl -LsSf https://astral.sh/uv/install.sh | sh
6262
6363
# Install SuperOptiX
64-
uv pip install superoptix --prerelease=allow
64+
uv pip install superoptix
6565
6666
# Verify installation
6767
super --help

docs/setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Choose your preferred installation method:
3939
### Install SuperOptiX with UV
4040
```bash
4141
# Basic installation
42-
uv pip install superoptix --prerelease=allow
42+
uv pip install superoptix
4343

4444
# With specific extras
4545
uv pip install "superoptix[ui,vectordb,observability]"
4646

4747
# Latest from PyPI
48-
uv pip install superoptix --prerelease=allow
48+
uv pip install superoptix
4949
```
5050

5151
=== "🐍 Pip"
@@ -93,7 +93,7 @@ Choose your preferred installation method:
9393
curl -LsSf https://astral.sh/uv/install.sh | sh
9494

9595
# Install SuperOptiX
96-
uv pip install superoptix --prerelease=allow
96+
uv pip install superoptix
9797
```
9898

9999
### Using Conda
@@ -121,7 +121,7 @@ Choose your preferred installation method:
121121
curl -LsSf https://astral.sh/uv/install.sh | sh
122122

123123
# Install SuperOptiX
124-
uv pip install superoptix --prerelease=allow
124+
uv pip install superoptix
125125
```
126126

127127
### CentOS/RHEL/Fedora
@@ -136,7 +136,7 @@ Choose your preferred installation method:
136136
curl -LsSf https://astral.sh/uv/install.sh | sh
137137

138138
# Install SuperOptiX
139-
uv pip install superoptix --prerelease=allow
139+
uv pip install superoptix
140140
```
141141

142142
=== "🪟 Windows"

docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ pip install --upgrade pip
129129
pip search superoptix
130130

131131
# Install from PyPI
132-
pip install superoptix --prerelease=allow
132+
pip install superoptix
133133
```
134134

135135
## 🚀 Still Having Issues?

0 commit comments

Comments
 (0)