Skip to content

Commit f5b9136

Browse files
committed
Add the git repo link
1 parent 4160a06 commit f5b9136

File tree

3 files changed

+57
-18
lines changed

3 files changed

+57
-18
lines changed

docs/guides/openai-sdk-integration.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
**Works great with FREE Ollama (No API Keys Needed!)**
66

7+
> **Hands-on demo:** Clone the MIT-licensed companion repo [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai) to try the OpenAI Agents SDK with SuperOptiX Lite right away. The Code Reviewer example in that project mirrors this guide step by step.
8+
79
---
810

911
## 🎯 What is OpenAI Agents SDK?
@@ -940,6 +942,7 @@ A: Performance varies by use case, model, and hardware. OpenAI SDK typically has
940942
- **Ollama Setup**: `/docs/llm-setup.md`
941943
- **Multi-Framework Guide**: `/docs/guides/multi-framework.md`
942944
- **Universal GEPA**: `/plan/MULTI_FRAMEWORK_GEPA_STRATEGY.md`
945+
- **Hands-on Repo**: [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai) — clone this MIT-licensed companion project to try the OpenAI Agents SDK with SuperOptiX Lite and follow our Code Reviewer tutorial step by step.
943946

944947
---
945948

@@ -992,8 +995,9 @@ This comprehensive step-by-step tutorial teaches you how to:
992995
✅ Implement **automatic optimization loading** for production deployment
993996

994997
**Example project:** Code Reviewer Agent that detects security vulnerabilities
998+
**Hands-on repo:** [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai) — clone it to follow the tutorial with a fully wired SuperOptiX Lite playground.
995999

996-
**Time:** 30-45 minutes | **Difficulty:** Intermediate | **Prerequisites:** Python, Ollama
1000+
**Time:** 30-45 minutes | **Difficulty:** Intermediate | **Prerequisites:** Python, Ollama, Git access to the repo above
9971001

9981002
👉 **[Start the tutorial now](../tutorials/openai-sdk-gepa-optimization.md)**
9991003

docs/tutorials/openai-sdk-gepa-optimization.md

Lines changed: 52 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44

55
This comprehensive tutorial demonstrates how to create production-ready AI agents using the official OpenAI Agents SDK, integrate them with SuperOptiX, and achieve measurable performance improvements through GEPA (Genetic Evaluation-based Prompt Augmentation) optimization.
66

7+
> **Hands-on first:** Clone the live example repo and follow along step by step — every snippet in this guide comes straight from [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai). Use it as your working playground while you read.
8+
9+
---
10+
11+
## 🔗 Repo Spotlight
12+
13+
Looking for a complete, runnable example? Check out the open source companion repository [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai). It ships with:
14+
15+
- ✅ A production-ready Code Reviewer agent following this tutorial end-to-end
16+
- ✅ GEPA optimization workflow powered by the lightweight `superoptix_lite` package
17+
- ✅ Playbook-driven Agent Spec scenarios for SQL injection, memory leaks, error handling, and performance tuning
18+
- ✅ Automation scripts for baseline evaluation, optimization, and regression testing
19+
20+
We'll reference this repository throughout the tutorial so you can clone, copy, or adapt the same patterns instantly.
21+
722
---
823

924
## 📋 What You'll Learn
@@ -105,6 +120,8 @@ code-reviewer-tutorial/
105120
└── optimized/ # GEPA optimization results
106121
```
107122

123+
> **Quick start:** prefer cloning instead? `git clone https://github.com/SuperagenticAI/superoptix-lite-openai.git` to get the finished layout with baseline, optimization, and demo scripts already wired up.
124+
108125
---
109126

110127
## 📝 Step 2: Define Agent Playbook
@@ -309,8 +326,8 @@ import json
309326
from agents import Agent, Runner, OpenAIChatCompletionsModel
310327
from openai import AsyncOpenAI
311328
312-
# SuperOptiX integration
313-
from superoptix.core.base_component import BaseComponent
329+
# SuperOptiX Lite integration (matches superoptix-lite-openai repo)
330+
from openai_gepa.superoptix_lite import BaseComponent
314331
315332
316333
# ======================================================================
@@ -394,7 +411,7 @@ class CodeReviewerAgent:
394411

395412
class CodeReviewerComponent(BaseComponent):
396413
"""
397-
SuperOptiX wrapper for OpenAI SDK agent.
414+
SuperOptiX Lite wrapper for OpenAI SDK agent.
398415
399416
Makes the native agent compatible with GEPA optimization by:
400417
- Inheriting from BaseComponent
@@ -409,7 +426,7 @@ class CodeReviewerComponent(BaseComponent):
409426
**kwargs
410427
):
411428
"""
412-
Initialize SuperOptiX component.
429+
Initialize SuperOptiX Lite component.
413430
414431
Args:
415432
instructions: Agent instructions (GEPA optimizes this!)
@@ -418,7 +435,7 @@ class CodeReviewerComponent(BaseComponent):
418435
# Default instructions from playbook persona
419436
default_instructions = self._build_default_instructions()
420437

421-
# Initialize BaseComponent
438+
# Initialize BaseComponent from superoptix_lite (lightweight GEPA harness)
422439
super().__init__(
423440
name="code_reviewer",
424441
description="AI code reviewer for security and performance analysis",
@@ -715,9 +732,9 @@ def create_code_reviewer_agent(
715732
- `Agent` for definition, `Runner.run()` for execution
716733
- Direct integration with Ollama via `OpenAIChatCompletionsModel`
717734

718-
**Part 2: SuperOptiX Integration**
735+
**Part 2: SuperOptiX Lite Integration**
719736
- `CodeReviewerComponent` wraps native agent
720-
- `BaseComponent` provides GEPA compatibility
737+
- `BaseComponent` from `superoptix_lite` provides GEPA compatibility (same module shipped in `superoptix-lite-openai`)
721738
- `variable` field contains optimizable instructions
722739

723740
**Part 3: Pipeline**
@@ -1282,6 +1299,28 @@ optimizer:
12821299
12831300
---
12841301
1302+
## 📚 About SuperOptiX Lite
1303+
1304+
This tutorial mirrors the lightweight framework distributed with [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai):
1305+
1306+
**Included**
1307+
- ✅ `BaseComponent` scaffolding for GEPA-compatible variables
1308+
- ✅ Minimal config loader for auto-loading optimized instructions
1309+
- ✅ OpenAI Agents SDK integration wired for Ollama endpoints
1310+
1311+
**Not Included (Full SuperOptiX)**
1312+
- ❌ UniversalGEPA optimizer and multi-framework compilers
1313+
- ❌ Advanced RAG optimization, memory systems, or Orchestra tooling
1314+
- ❌ CLI workflows (`super` command) and observability integrations
1315+
1316+
Need the full stack? Install the production framework with:
1317+
1318+
```bash
1319+
pip install "superoptix[frameworks-openai]"
1320+
```
1321+
1322+
---
1323+
12851324
## 📚 Additional Resources
12861325

12871326
### Documentation
@@ -1290,12 +1329,12 @@ optimizer:
12901329
- [GEPA Paper](https://arxiv.org/abs/xxxx.xxxxx)
12911330

12921331
### Example Code
1293-
- [Complete Tutorial Code](https://github.com/superoptix/examples/openai-gepa)
1332+
- [SuperOptiX Lite OpenAI Demo](https://github.com/SuperagenticAI/superoptix-lite-openai)
12941333
- [More Agent Examples](https://docs.superoptix.ai/examples)
12951334

1296-
### Community
1297-
- [Discord Community](https://discord.gg/superoptix)
1298-
- [GitHub Discussions](https://github.com/superoptix/superoptix/discussions)
1335+
### Support
1336+
- Connect with us via [superoptix.ai](https://superoptix.ai) for product updates and contact options
1337+
- Licensing questions: [licensing@super-agentic.ai](mailto:licensing@super-agentic.ai)
12991338

13001339
---
13011340

@@ -1313,12 +1352,6 @@ Your agent is now production-ready and self-optimizing! 🚀
13131352

13141353
## 📝 Tutorial Summary
13151354

1316-
**Time Invested**: 30-45 minutes
1317-
**Lines of Code**: ~600 (agent + pipeline)
1318-
**Test Coverage**: 4 BDD scenarios
1319-
**Final Pass Rate**: 100%
1320-
**Optimization**: Automatic loading
1321-
13221355
**What You Built**:
13231356
A production-ready code reviewer agent that:
13241357
- Uses official OpenAI SDK patterns
@@ -1327,4 +1360,6 @@ A production-ready code reviewer agent that:
13271360
- Works with local Ollama models
13281361
- Achieves measurable performance improvements
13291362

1363+
👉 Keep iterating in the [`superoptix-lite-openai`](https://github.com/SuperagenticAI/superoptix-lite-openai) repository. It tracks this tutorial line-for-line, giving you a ready-made playground for experiments, upgrades, and commits you can bring back into your full SuperOptiX projects.
1364+
13301365
Ready to build more? Check out our [other tutorials](/tutorials/)!

resources/favicon.png

806 Bytes
Loading

0 commit comments

Comments
 (0)