examples/README.md

ACE Framework Examples

Navigation guide for all ACE examples. Each directory has its own detailed README.

🎯 Getting Started

New to ACE? Start with these:

• simple_ace_example.py - Minimal ACE usage (5 minutes)
• seahorse_emoji_ace.py - Self-reflection demo
• Quick Start Guide - Step-by-step tutorial

🧩 Integrations

Add ACE learning to existing systems:

Browser Automation (browser-use)

browser-use/ - Self-improving browser agents

• simple_ace_agent.py - Basic ACEAgent usage
• domain-checker/ - Domain availability automation
• form-filler/ - Form filling automation
• online-shopping/ - E-commerce automation

📖 See browser-use/README.md for full guide

LangChain Integration

langchain/ - Wrap LangChain chains/agents with learning

• simple_chain_example.py - Basic chain + ACE
• agent_with_tools_example.py - Agent with tools

📖 See langchain/README.md for patterns

Custom Integration

custom_integration_example.py - Pattern for any agent

Shows the three-step integration: Inject → Execute → Learn

Pipeline Composition

pipeline_composition/ - Build custom ACE pipelines

• compose_custom_pipeline.py - Mix and match steps, add custom steps, use build_steps()

📊 Advanced Topics

Production Learning

helicone/ - Learn from Helicone observability logs

• Parse production LLM traces
• Replay-based learning (cost-effective)
• Tool selection analysis

📖 See helicone/README.md

Prompt Engineering

prompts/ - Compare ACE prompt versions

• compare_v1_v2_prompts.py - v1.0 vs v2.0
• advanced_prompts_v2.py - Advanced techniques

Skillbook Management

• skillbook_persistence.py - Save and load learned strategies

🗂️ Examples by Use Case

Use Case	Example
Q&A systems	simple_ace_example.py
Browser automation	browser-use/
LangChain workflows	langchain/
Custom agents	custom_integration_example.py
Custom pipelines	pipeline_composition/
Production learning	helicone/
Prompt optimization	prompts/

🚀 Quick Start

# 1. Install
pip install ace-framework

# 2. Set API key
export OPENAI_API_KEY="your-api-key"

# 3. Run example
python examples/simple_ace_example.py

# Browser examples (contributors: uv sync --group demos)
uv run python examples/browser-use/simple_ace_agent.py

📚 Documentation

Note: Documentation has been reorganized. Previous top-level docs (QUICK_START.md, INTEGRATION_GUIDE.md, etc.) have moved to docs/getting-started/, docs/guides/, and docs/api/. Old versions are archived in docs/old_docs/.

• Quick Start Guide - 5-minute tutorial
• Integration Guide - Add ACE to existing agents
• API Reference - Complete API
• Complete ACE Guide - Deep dive

🔧 Adapting Examples

Each example is documented for easy adaptation:

1. Browser automation: Copy browser-use/TEMPLATE.py
2. LangChain: See langchain/README.md patterns
3. Custom agent: Follow custom_integration_example.py
4. Other: Check subdirectory READMEs for guidance

❓ Need Help?

• GitHub Issues
• Discord Community
• Check subdirectory READMEs for specific guidance