Skip to content

Latest commit

ย 

History

History
409 lines (314 loc) ยท 20.4 KB

File metadata and controls

409 lines (314 loc) ยท 20.4 KB

๐Ÿ“‹ Changelog

All notable changes to SuperOptiX will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.2.25] - 2026-04-15

Added

  • OpenAI Agents SDK Support - Full adoption of the new OpenAI Agents SDK as a first-class framework target alongside DSPy, Claude SDK, Pydantic AI, CrewAI, Google ADK, and DeepAgents.
  • New CLI command super agent pull --framework openai-agents to pull agents compatible with the OpenAI Agents SDK.
  • New CLI command super agent compile <agent> --framework openai-agents to compile SuperSpecs into OpenAI Agents SDK pipelines.
  • SuperSpec schema extensions for OpenAI Agents SDK configuration (spec.openai_agents).
  • New validators for OpenAI Agents SDK-specific settings including tracing, tracingoff, maxTurns, and handoffs.
  • Jinja2 pipeline templates for OpenAI Agents SDK: openai_pipeline_minimal.py.jinja2 and openai_pipeline_optimized.py.jinja2.

Changed

  • OpenAI SDK integration docs now clarify the distinction between the legacy OpenAI SDK and the new OpenAI Agents SDK.
  • Feature matrix updated to show OpenAI Agents SDK as a supported framework target.

Documentation

  • Added ADR (Architecture Decision Record) for OpenAI Harness Sandbox Adoption.
  • Added OpenAI Agents SDK adoption summary guide with migration details.

[0.2.24] - 2026-04-08

Added

  • Arize Phoenix observability integration for SuperOptiX framework runtimes via the shared Phoenix helper path.
  • Pullable DSPy demo agent arize-phoenix-demo for trace-first Phoenix demos with super agent pull arize-phoenix-demo.

Changed

  • Demo and examples navigation now includes a dedicated Arize Phoenix example page.
  • Observability docs now include a user-facing Phoenix walkthrough covering both super agent pull arize-phoenix-demo and adapting super agent pull developer with spec.phoenix.

Fixed

  • Phoenix session span setup now tolerates tracers that do not expose OpenInference-style set_input, avoiding runtime failure during traced DSPy runs.

Documentation

  • Added a detailed Arize Phoenix demo guide with setup, pull, compile, run, and troubleshooting steps.
  • Expanded observability documentation to show how to configure spec.phoenix in a pulled agent playbook.

[0.2.23] - 2026-03-28

Fixed

  • DSPy Ollama model normalization now strips ollama: and ollama/ prefixes before constructing LiteLLM-compatible ollama_chat/... model names.
  • DSPy local Qwen playbooks no longer fail immediately with invalid model names when using Ollama-backed runtimes.

[0.2.22] - 2026-03-28

Added

  • TurboAgents-backed Chroma retrieval support in the shared RAG path and GEPA vector-store layer.
  • TurboAgents integration docs and demo coverage for Chroma, LanceDB, and SurrealDB.
  • Source-checkout guidance for validating TurboAgents-backed RAG flows across SuperOptiX frameworks.

Changed

  • SuperOptiX demo playbooks now prefer Qwen local models for the current TurboAgents validation path.
  • SurrealDB seed tooling now writes TurboAgents-compatible payloads and matches runtime embedding truncation.
  • TurboAgents docs now describe SuperOptiX as the first full reference integration.

Fixed

  • TurboAgents SurrealDB auth is preserved in the shared RAG setup path.
  • DSPy runner and minimal pipeline template now pass api_base through to DSPy LM setup.
  • Dependency metadata now excludes compromised LiteLLM releases 1.82.7 and 1.82.8.

Security

  • SuperOptiX now blocks LiteLLM 1.82.7 and 1.82.8 in dependency resolution after the March 2026 PyPI compromise advisory.

[0.2.20] - 2026-03-15

๐Ÿš€ Added

  • Packaged Google ADK A2A demo assets and pull alias support for a2a-adk-demo.
  • Packaged Google ADK A2A server demo module for installed-package usage.

๐Ÿ”„ Changed

  • Updated A2A docs and README to reflect DSPy, Pydantic AI, and Google ADK demo coverage.
  • Prepared the follow-up package release so installed users can pull the Google ADK A2A demo without a source checkout.

[0.2.19] - 2026-03-15

๐Ÿš€ Added

  • Core A2A v1 support as a native SuperOptiX protocol capability.
  • super agent serve <name> --protocol a2a for exposing compiled agents over A2A.
  • A2A client and server bridges with Agent Card generation and task-oriented interoperability.
  • Packaged A2A demos for DSPy and Pydantic AI, plus pullable demo agents.

๐Ÿ”„ Changed

  • Replaced the old Agenspy-oriented protocol path with a neutral runtime and protocol architecture.
  • Updated the website and docs to present A2A as a first-class top-level SuperOptiX capability.

๐Ÿ“š Documentation

  • Added dedicated A2A v1 introduction, guide, demo guide, and integration checklist documentation.
  • Added website navigation and landing page coverage for A2A support.

[0.2.12] - 2026-03-04

๐Ÿš€ Added

  • SurrealDB GraphRAG demo playbooks for all supported frameworks (DSPy, OpenAI, Claude SDK, Microsoft, PydanticAI, CrewAI, Google ADK, DeepAgents).
  • Lean SurrealDB parity checks in test matrix for both RAG and GraphRAG playbooks.

๐Ÿ”„ Changed

  • SurrealDB docs rewritten for beginner-first setup and troubleshooting.
  • SurrealDB docs now use source-independent seeding commands via python -m superoptix.agents.demo.setup_surrealdb_seed.
  • SurrealDB examples index updated to reflect full feature coverage.

๐Ÿ› Fixed

  • DSPy SurrealDB runtime compile/run parity in demo flow.
  • SurrealDB GraphRAG feature detection compatibility (RELATE probe parsing).
  • SurrealDB graph traversal query compatibility for parser variants that reject wildcard ->* syntax.

๐Ÿ“š Documentation

  • Added explicit SurrealDB feature coverage map with tags and runnable commands (vector, hybrid, GraphRAG, multi, temporal, server embeddings, live utility, MCP tool, capability gating).
  • Added beginner-friendly runbooks for SurrealDB local and Docker workflows with expected outputs and error-to-fix steps.

[0.2.9] - 2026-02-21

๐Ÿš€ Added

  • SurrealDB RAG Integration: Added native SurrealDB retriever support in runner-managed RAG flows
    • Added surrealdb retriever setup/query/document-ingest paths in RAGMixin
    • Added SurrealDB vector store adapter for GEPA RAG (surrealdb_store.py)
    • Added SuperSpec validation/schema support for surrealdb retriever type
  • Framework Demo Agents: Added new SurrealDB RAG demo playbooks for:
    • DSPy embedded mode: rag_surrealdb_demo
    • DSPy Docker mode: rag_surrealdb_docker_demo
    • PydanticAI: rag_surrealdb_pydanticai_demo
    • CrewAI: rag_surrealdb_crewai_demo
    • Google ADK: rag_surrealdb_adk_demo

๐Ÿ”„ Changed

  • Framework Pipeline RAG Context Injection: Updated minimal pipeline templates to inject retrieved SurrealDB context for:
    • pydantic_ai_pipeline_minimal.py.jinja2
    • crewai_pipeline_minimal.py.jinja2
    • google_adk_pipeline_minimal.py.jinja2
  • SurrealDB URL Handling: Improved URL normalization for SurrealDB server endpoints to reduce transport/path mismatch issues.

๐Ÿ“š Documentation

  • Added detailed SurrealDB documentation pages:
    • Embedded demo guide
    • Docker demo guide
    • Framework guide for DSPy, PydanticAI, CrewAI, and Google ADK
  • Updated docs navigation and examples index with SurrealDB sections and quick-start workflows.

โœ… Tests

  • Added SurrealDB vector store tests in tests/test_surrealdb_vector_store.py.

[0.1.0b17] - 2025-08-18

๐Ÿ”ง Fixed

  • Agent Naming Consistency: Fixed inconsistent agent IDs (hyphens vs underscores) across all GEPA agents
    • Standardized all agent IDs to use underscores to match filename convention
    • Fixed: advanced_math_gepa, enterprise_extractor_gepa, medical_assistant_gepa, contract_analyzer_gepa, privacy_delegate_gepa, data_science_gepa, security_analyzer_gepa, gepa_demo
  • Genies Tier Optimization Bug: Fixed input_field variable scope error in DSPy Genies pipeline template
    • Resolved "name 'input_field' is not defined" error during optimization
    • Added proper variable scoping in train() and evaluate() methods
    • Genies tier agents now optimize successfully with BootstrapFewShot, SIMBA, and BetterTogether optimizers

๐Ÿ“š Documentation

  • Comprehensive GEPA Documentation: Added detailed documentation for all 8 GEPA agents across multiple domains
    • Mathematics: advanced_math_gepa, data_science_gepa
    • Healthcare: medical_assistant_gepa
    • Legal: contract_analyzer_gepa
    • Enterprise: enterprise_extractor_gepa
    • Security: security_analyzer_gepa, privacy_delegate_gepa
    • Demo: gepa_demo
  • DSPy Optimizers Quick Start Guide: Added comprehensive quick start commands for all 8 DSPy optimizers
    • Complete workflows (pull, compile, optimize, test) for each optimizer
    • Domain-specific examples and use cases
    • Performance comparisons and best practices
  • GEPA Limitations Documentation: Added critical guidance about GEPA compatibility
    • Clear warning that GEPA doesn't work with tool-calling agents (Genies tier+)
    • Detailed explanation of why (complex output formats, tool call parsing issues)
    • Alternative optimizer recommendations for each tier
    • Agent tier compatibility table

๐Ÿš€ Enhanced

  • Ready-to-Run Commands: All documentation now includes copy-paste commands with proper timeouts
  • Agent Discovery: Complete tables of all available agents organized by domain and optimizer
  • Practical Examples: Real-world goals and use cases for every agent type

[0.1.0b16] - 2025-01-07

๐Ÿš€ Added

  • ๐ŸŽ Apple Silicon GPT-OSS Support: MLX-LM v0.26.3 now provides native Apple Silicon support for GPT-OSS models
    • No More Mixed Precision Issues: MLX-LM handles MXFP4 quantization properly on Apple Silicon
    • Native Performance: GPT-OSS models now run natively without CPU fallback
    • Multiple Backend Options: Users can choose between MLX (native) and Ollama (performance)
  • ๐Ÿ†• GPT-OSS Model Support: Added support for OpenAI's latest open-source models (GPT-OSS-20B and GPT-OSS-120B)
  • MLX Model Evaluation: Added super model mlx evaluate command for benchmarking MLX models using LM-Eval integration
  • MLX Model Fusion: Added super model mlx fuse command for fusing finetuned adapters into base models
  • Backend-Specific Commands: Reorganized model commands with super model mlx, super model vllm, super model sglang subcommands
  • Advanced MLX Features: Support for evaluation tasks (mmlu, arc, hellaswag, etc.), fusion with dequantization, GGUF export, and HuggingFace upload
  • vLLM High-Performance Inference: Added super model vllm serve, super model vllm generate, super model vllm benchmark, and super model vllm quantize commands for production-grade inference
  • vLLM Advanced Features: Support for multi-GPU serving, streaming generation, performance benchmarking, and model quantization (AWQ, GPTQ, SqueezeLLM)
  • vLLM Optional Dependency: Added vLLM as optional dependency with pip install superoptix[vllm] for Linux systems with NVIDIA GPUs
  • SGLang Streaming & Optimization: Added super model sglang serve, super model sglang generate, super model sglang optimize, and super model sglang benchmark commands for streaming and optimization
  • SGLang Advanced Features: Support for streaming generation, performance optimization (O0-O3), advanced batching, and real-time inference
  • SGLang Optional Dependency: Added SGLang as optional dependency with pip install superoptix[sglang] for Linux systems with NVIDIA GPUs
  • MLX Experimental Features: Added experimental super model convert and super model quantize commands for MLX model conversion and quantization (see MLX_EXPERIMENTAL_FEATURES.md)
  • Auto-installation: Enhanced super model run with automatic model installation and backend detection

๐Ÿ”ง Updated

  • MLX Dependencies: Updated to MLX-LM v0.26.3 for native GPT-OSS support on Apple Silicon
  • Model Management: Enhanced MLX backend with better error handling and format validation
  • CLI Improvements: Simplified UX by removing --force flags for cleaner commands

๐Ÿ› Fixed

  • Apple Silicon Compatibility: Resolved mixed precision issues that prevented GPT-OSS models from running on Apple Silicon
  • HuggingFace Backend Limitations: Documented that HuggingFace backend still has mixed precision issues on Apple Silicon

๐Ÿ“š Documentation

  • Apple Silicon Guide: Updated documentation to reflect GPT-OSS support via MLX-LM and Ollama backends
  • Performance Comparison: Added performance metrics comparing MLX-LM vs Ollama vs HuggingFace backends

[0.1.0b11] - 2025-01-06

๐Ÿš€ Added

  • Simplified Model Installation: Completely redesigned model installation system for MLX and HuggingFace backends
  • Detailed Progress Display: Added file-by-file download progress for large models with safetensors/bin files
  • Improved Model Detection: Fixed model detection logic to properly identify installed models vs metadata-only downloads

๐Ÿ”ง Updated

  • MLX Backend: Simplified installation using direct snapshot_download with single-threaded progress display
  • HuggingFace Backend: Streamlined installation with detailed file-by-file progress for large models
  • CLI Integration: Enhanced super model install command with proper model detection and progress display
  • Model Detection Logic: Fixed detection to require actual model files (.safetensors, .bin) not just config files

๐Ÿ› Fixed

  • Model Installation Issues: Resolved problems with large model downloads getting stuck at "Fetching files: 0%"
  • False Positive Detection: Fixed issue where models with only metadata were incorrectly shown as "installed"
  • Progress Display: Fixed missing detailed progress for individual model file downloads

๐Ÿ“š Documentation

  • Installation Guide: Updated SIMPLE_MODEL_INSTALLATION.md with new simplified approach
  • Testing Scripts: Added test_simple_install.py for validating model installation functionality

๐Ÿ”„ Changed

  • Installation Approach: Removed complex validation and progress tracking in favor of simple, reliable downloads
  • Progress Display: Switched from custom progress bars to standard HuggingFace Hub progress display
  • Error Handling: Simplified error handling with clear, actionable error messages

๐ŸŽฏ Technical Details

  • Single-Threaded Downloads: Uses max_workers=1 to force detailed progress display for large models
  • Direct Download: Uses snapshot_download without complex parameters for reliability
  • Proper Detection: Checks for actual model files in snapshots directory, not just metadata

[0.1.0] - 2024-12-XX

๐ŸŽ‰ Initial Release

This is the first release of SuperOptiX - "The Kubernetes of Agentic AI"!

๐Ÿš€ Added

๐Ÿ—๏ธ Core Framework

  • DSPy-Native Architecture: Built on DSPy 3.0 for self-improving agent programs
  • Agent Playbook System: Declarative agent configuration with YAML
  • Multi-Agent Orchestration: Sophisticated agent coordination and workflow management
  • Memory Systems: Long-term, short-term, and episodic memory backends
  • Evaluation Framework: Built-in testing and quality metrics for agents

๐Ÿ› ๏ธ CLI Tools

  • super init: Initialize new agentic projects with full scaffolding
  • super agent create: Generate agent templates and configurations
  • super compile: Compile agents with DSPy optimization
  • super orchestra: Multi-agent orchestration and deployment
  • super run: Execute individual agents and agent workflows

๐ŸŽฏ Agent Templates

  • Business & Consulting: Strategy consultants, business analysts, change managers
  • Software Development: Developers, QA engineers, DevOps, architects
  • Healthcare: Medical assistants, health educators, mental health coaches
  • Education: Tutors, instructors, study coaches across multiple subjects
  • Finance: Financial advisors, budget analysts, investment researchers
  • Marketing: Content creators, SEO specialists, campaign strategists
  • Legal: Contract analyzers, compliance checkers, legal researchers
  • And many more! (20+ industry categories)

๐Ÿง  Memory & Context

  • Redis Backend: Scalable memory storage for production deployments
  • Vector Memory: Semantic memory search and retrieval
  • Context Management: Intelligent context window optimization
  • Memory Persistence: Long-term agent memory across sessions

๐Ÿ” Observability & Debugging

  • Real-time Monitoring: Agent performance and behavior tracking
  • Token Usage Analytics: Cost and performance optimization
  • Debug Dashboard: Visual debugging tools for agent development
  • Comprehensive Logging: Detailed execution traces and metrics

๐Ÿงช Testing & Quality

  • Agent BDD: Behavior-driven development for agents
  • Automated Evaluation: Quality metrics and regression testing
  • Performance Benchmarks: Agent performance measurement tools
  • Safety Checks: Built-in guardrails and safety validation

๐Ÿ”Œ Integrations

  • DSPy 3.0: Full integration with latest DSPy features
  • MLFlow: Experiment tracking and model management
  • FastAPI: Production-ready API deployment
  • Streamlit: Rapid UI development for agent interfaces

๐Ÿ“š Documentation & Examples

  • Comprehensive Guides: Step-by-step tutorials and documentation
  • Code Examples: Real-world agent implementations
  • Best Practices: Industry-standard development patterns
  • API Reference: Complete API documentation

๐ŸŽฏ Key Features

  • ๐Ÿ”ฅ Evaluation-First Development: Every agent is testable and measurable
  • ๐Ÿš€ Auto-Optimization: DSPy-powered prompt and pipeline optimization
  • ๐ŸŽผ Orchestration: Kubernetes-style multi-agent coordination
  • ๐Ÿ›ก๏ธ Production-Ready: Enterprise-grade reliability and monitoring
  • ๐Ÿ”ง Modular Design: Swap components, models, and tools at runtime
  • ๐Ÿ“Š Rich Analytics: Comprehensive performance and quality metrics

๏ฟฝ๏ฟฝ Highlights

  • 200+ Agent Templates: Pre-built agents for every industry
  • DSPy 3.0 Integration: Leverage the latest in self-improving programs
  • Enterprise Security: Built-in security best practices and compliance
  • Cloud-Native: Designed for modern cloud deployments
  • Developer Experience: Intuitive CLI and comprehensive tooling

๐Ÿ“ฆ Installation

pip install superoptix

๐Ÿš€ Quick Start

# Create your first agentic system
super init my_agent_system
cd my_agent_system

# Create and run an agent
super agent create customer_service --template=support
super run customer_service "How can I help you today?"

๐Ÿค Community


Release Notes Format

For each release, we document:

๐Ÿš€ Added

New features and capabilities

๐Ÿ”„ Changed

Changes to existing functionality

๐Ÿ—‘๏ธ Deprecated

Features that will be removed in future versions

๐Ÿ› Fixed

Bug fixes and issue resolutions

๐Ÿ”’ Security

Security-related improvements and fixes

โšก Performance

Performance improvements and optimizations


Unreleased Features Preview

๐Ÿ”ฎ Coming Soon

v0.2.0 - "Agent Intelligence"

  • Advanced Reasoning: Multi-step reasoning capabilities
  • Tool Integration: Enhanced tool calling and API integration
  • Visual Agents: Image and video processing capabilities
  • Agent Marketplace: Community-driven agent sharing platform

v0.3.0 - "Enterprise Scale"

  • Kubernetes Deployment: Native K8s orchestration
  • Enterprise SSO: Advanced authentication and authorization
  • Audit Logging: Comprehensive audit trails
  • SLA Monitoring: Service level agreement tracking

v0.4.0 - "AI Evolution"

  • Self-Improving Agents: Agents that evolve based on usage
  • Federated Learning: Cross-agent knowledge sharing
  • Custom Models: Support for fine-tuned and custom models
  • Agent Analytics: Advanced analytics and insights

๐ŸŽฏ Stay Updated: Watch our repository and join our community to stay informed about the latest releases and features!

๐Ÿค Contribute: Help us build the future of agentic AI by contributing to SuperOptiX!