@bastani/atomic 0.5.11 → 0.5.12-1

package/.agents/skills/evaluation/SKILL.md

@@ -0,0 +1,251 @@
+---
+name: evaluation
+description: This skill should be used when the user asks to "evaluate agent performance", "build test framework", "measure agent quality", "create evaluation rubrics", or mentions LLM-as-judge, multi-dimensional evaluation, agent testing, or quality gates for agent pipelines. Part of the context engineering skill suite — also activates when the user mentions "context engineering" or "context-engineering" in the context of measuring agent effectiveness.
+---
+
+# Evaluation Methods for Agent Systems
+
+Evaluate agent systems differently from traditional software because agents make dynamic decisions, are non-deterministic between runs, and often lack single correct answers. Build evaluation frameworks that account for these characteristics, provide actionable feedback, catch regressions, and validate that context engineering choices achieve intended effects.
+
+## When to Activate
+
+Activate this skill when:
+- Testing agent performance systematically
+- Validating context engineering choices
+- Measuring improvements over time
+- Catching regressions before deployment
+- Building quality gates for agent pipelines
+- Comparing different agent configurations
+- Evaluating production systems continuously
+
+## Core Concepts
+
+Focus evaluation on outcomes rather than execution paths, because agents may find alternative valid routes to goals. Judge whether the agent achieves the right outcome via a reasonable process, not whether it followed a specific sequence of steps.
+
+Use multi-dimensional rubrics instead of single scores because one number hides critical failures in specific dimensions. Capture factual accuracy, completeness, citation accuracy, source quality, and tool efficiency as separate dimensions, then weight them for the use case.
+
+Deploy LLM-as-judge for scalable evaluation across large test sets while supplementing with human review to catch edge cases, hallucinations, and subtle biases that automated evaluation misses.
+
+**Performance Drivers: The 95% Finding**
+
+Apply the BrowseComp research finding when designing evaluation budgets: three factors explain 95% of browsing agent performance variance.
+
+| Factor | Variance Explained | Implication |
+|--------|-------------------|-------------|
+| Token usage | 80% | More tokens = better performance |
+| Number of tool calls | ~10% | More exploration helps |
+| Model choice | ~5% | Better models multiply efficiency |
+
+Act on these implications when designing evaluations:
+- **Set realistic token budgets**: Evaluate agents with production-realistic token limits, not unlimited resources, because token usage drives 80% of variance.
+- **Prioritize model upgrades over token increases**: Upgrading model versions provides larger gains than doubling token budgets on previous versions because better models use tokens more efficiently.
+- **Validate multi-agent architectures**: The finding supports distributing work across agents with separate context windows, so evaluate multi-agent setups against single-agent baselines.
+
+## Detailed Topics
+
+### Evaluation Challenges
+
+**Handle Non-Determinism and Multiple Valid Paths**
+
+Design evaluations that tolerate path variation because agents may take completely different valid paths to reach goals. One agent might search three sources while another searches ten; both may produce correct answers. Avoid checking for specific steps. Instead, define outcome criteria (correctness, completeness, quality) and score against those, treating the execution path as informational rather than evaluative.
+
+**Test Context-Dependent Failures**
+
+Evaluate across a range of complexity levels and interaction lengths because agent failures often depend on context in subtle ways. An agent might succeed on simple queries but fail on complex ones, work well with one tool set but fail with another, or degrade after extended interaction as context accumulates. Include simple, medium, complex, and very complex test cases to surface these patterns.
+
+**Score Composite Quality Dimensions Separately**
+
+Break agent quality into separate dimensions (factual accuracy, completeness, coherence, tool efficiency, process quality) and score each independently because an agent might score high on accuracy but low on efficiency, or vice versa. Then compute weighted aggregates tuned to use-case priorities. This approach reveals which dimensions need improvement rather than averaging away the signal.
+
+### Evaluation Rubric Design
+
+**Build Multi-Dimensional Rubrics**
+
+Define rubrics covering key dimensions with descriptive levels from excellent to failed. Include these core dimensions and adapt weights per use case:
+
+- Factual accuracy: Claims match ground truth (weight heavily for knowledge tasks)
+- Completeness: Output covers requested aspects (weight heavily for research tasks)
+- Citation accuracy: Citations match claimed sources (weight for trust-sensitive contexts)
+- Source quality: Uses appropriate primary sources (weight for authoritative outputs)
+- Tool efficiency: Uses right tools a reasonable number of times (weight for cost-sensitive systems)
+
+**Convert Rubrics to Numeric Scores**
+
+Map dimension assessments to numeric scores (0.0 to 1.0), apply per-dimension weights, and calculate weighted overall scores. Set passing thresholds based on use-case requirements, typically 0.7 for general use and 0.9 for high-stakes applications. Store individual dimension scores alongside the aggregate because the breakdown drives targeted improvement.
+
+### Evaluation Methodologies
+
+**Use LLM-as-Judge for Scale**
+
+Build LLM-based evaluation prompts that include: clear task description, the agent output under test, ground truth when available, an evaluation scale with explicit level descriptions, and a request for structured judgment with reasoning. LLM judges provide consistent, scalable evaluation across large test sets. Use a different model family than the agent being evaluated to avoid self-enhancement bias.
+
+**Supplement with Human Evaluation**
+
+Route edge cases, unusual queries, and a random sample of production traffic to human reviewers because humans notice hallucinated answers, system failures, and subtle biases that automated evaluation misses. Track patterns across human reviews to identify systematic issues and feed findings back into automated evaluation criteria.
+
+**Apply End-State Evaluation for Stateful Agents**
+
+For agents that mutate persistent state (files, databases, configurations), evaluate whether the final state matches expectations rather than how the agent got there. Define expected end-state assertions and verify them programmatically after each test run.
+
+### Test Set Design
+
+**Select Representative Samples**
+
+Start with small samples (20-30 cases) during early development when changes have dramatic impacts and low-hanging fruit is abundant. Scale to 50+ cases for reliable signal as the system matures. Sample from real usage patterns, add known edge cases, and ensure coverage across complexity levels.
+
+**Stratify by Complexity**
+
+Structure test sets across complexity levels to prevent easy examples from inflating scores:
+- Simple: single tool call, factual lookup
+- Medium: multiple tool calls, comparison logic
+- Complex: many tool calls, significant ambiguity
+- Very complex: extended interaction, deep reasoning, synthesis
+
+Report scores per stratum alongside overall scores to reveal where the agent actually struggles.
+
+### Context Engineering Evaluation
+
+**Validate Context Strategies Systematically**
+
+Run agents with different context strategies on the same test set and compare quality scores, token usage, and efficiency metrics. This isolates the effect of context engineering from other variables and prevents anecdote-driven decisions.
+
+**Run Degradation Tests**
+
+Test how context degradation affects performance by running agents at different context sizes. Identify performance cliffs where context becomes problematic and establish safe operating limits. Feed these limits back into context management strategies.
+
+### Continuous Evaluation
+
+**Build Automated Evaluation Pipelines**
+
+Integrate evaluation into the development workflow so evaluations run automatically on agent changes. Track results over time, compare versions, and block deployments that regress on key metrics.
+
+**Monitor Production Quality**
+
+Sample production interactions and evaluate them continuously. Set alerts for quality drops below warning (0.85 pass rate) and critical (0.70 pass rate) thresholds. Maintain dashboards showing trend analysis over time windows to detect gradual degradation.
+
+## Practical Guidance
+
+### Building Evaluation Frameworks
+
+Follow this sequence to build an evaluation framework, because skipping early steps leads to measurements that do not reflect real quality:
+
+1. Define quality dimensions relevant to the use case before writing any evaluation code, because dimensions chosen later tend to reflect what is easy to measure rather than what matters.
+2. Create rubrics with clear, descriptive level definitions so evaluators (human or LLM) produce consistent scores.
+3. Build test sets from real usage patterns and edge cases, stratified by complexity, with at least 50 cases for reliable signal.
+4. Implement automated evaluation pipelines that run on every significant change.
+5. Establish baseline metrics before making changes so improvements can be measured against a known reference.
+6. Run evaluations on all significant changes and compare against the baseline.
+7. Track metrics over time for trend analysis because gradual degradation is harder to notice than sudden drops.
+8. Supplement automated evaluation with human review on a regular cadence.
+
+### Avoiding Evaluation Pitfalls
+
+Guard against these common failures that undermine evaluation reliability:
+
+- **Overfitting to specific paths**: Evaluate outcomes, not specific steps, because agents find novel valid paths.
+- **Ignoring edge cases**: Include diverse test scenarios covering the full complexity spectrum.
+- **Single-metric obsession**: Use multi-dimensional rubrics because a single score hides dimension-specific failures.
+- **Neglecting context effects**: Test with realistic context sizes and histories rather than clean-room conditions.
+- **Skipping human evaluation**: Automated evaluation misses subtle issues that humans catch reliably.
+
+## Examples
+
+**Example 1: Simple Evaluation**
+```python
+def evaluate_agent_response(response, expected):
+    rubric = load_rubric()
+    scores = {}
+    for dimension, config in rubric.items():
+        scores[dimension] = assess_dimension(response, expected, dimension)
+    overall = weighted_average(scores, config["weights"])
+    return {"passed": overall >= 0.7, "scores": scores}
+```
+
+**Example 2: Test Set Structure**
+
+Test sets should span multiple complexity levels to ensure comprehensive evaluation:
+
+```python
+test_set = [
+    {
+        "name": "simple_lookup",
+        "input": "What is the capital of France?",
+        "expected": {"type": "fact", "answer": "Paris"},
+        "complexity": "simple",
+        "description": "Single tool call, factual lookup"
+    },
+    {
+        "name": "medium_query",
+        "input": "Compare the revenue of Apple and Microsoft last quarter",
+        "complexity": "medium",
+        "description": "Multiple tool calls, comparison logic"
+    },
+    {
+        "name": "multi_step_reasoning",
+        "input": "Analyze sales data from Q1-Q4 and create a summary report with trends",
+        "complexity": "complex",
+        "description": "Many tool calls, aggregation, analysis"
+    },
+    {
+        "name": "research_synthesis",
+        "input": "Research emerging AI technologies, evaluate their potential impact, and recommend adoption strategy",
+        "complexity": "very_complex",
+        "description": "Extended interaction, deep reasoning, synthesis"
+    }
+]
+```
+
+## Guidelines
+
+1. Use multi-dimensional rubrics, not single metrics
+2. Evaluate outcomes, not specific execution paths
+3. Cover complexity levels from simple to complex
+4. Test with realistic context sizes and histories
+5. Run evaluations continuously, not just before release
+6. Supplement LLM evaluation with human review
+7. Track metrics over time for trend detection
+8. Set clear pass/fail thresholds based on use case
+
+## Gotchas
+
+1. **Overfitting evals to specific code paths**: Tests pass but the agent fails on slight input variations. Write eval criteria against outcomes and semantics, not surface patterns, and rotate test inputs periodically.
+2. **LLM-judge self-enhancement bias**: Models rate their own outputs higher than independent judges do. Use a different model family as the evaluation judge than the model being evaluated.
+3. **Test set contamination**: Eval examples leak into training data or prompt templates, inflating scores. Keep eval sets versioned and separate from any data used in prompts or fine-tuning.
+4. **Metric gaming**: Optimizing for the metric rather than actual quality produces agents that score well but disappoint users. Cross-validate automated metrics against human judgments regularly.
+5. **Single-dimension scoring**: One aggregate number hides critical failures in specific dimensions. Always report per-dimension scores alongside the overall score, and fail the eval if any single dimension falls below its minimum threshold.
+6. **Eval set too small**: Fewer than 50 examples produces unreliable signal with high variance between runs. Scale the eval set to at least 50 cases and report confidence intervals.
+7. **Not stratifying by difficulty**: Easy examples inflate overall scores, masking failures on hard cases. Report scores per complexity stratum and weight the overall score to prevent easy-case dominance.
+8. **Treating eval as one-time**: Evaluation must be continuous, not a launch gate. Agent quality drifts as models update, tools change, and usage patterns evolve. Run evals on every change and on a regular production cadence.
+
+## Integration
+
+This skill connects to all other skills as a cross-cutting concern:
+
+- context-fundamentals - Evaluating context usage
+- context-degradation - Detecting degradation
+- context-optimization - Measuring optimization effectiveness
+- multi-agent-patterns - Evaluating coordination
+- tool-design - Evaluating tool effectiveness
+- memory-systems - Evaluating memory quality
+
+## References
+
+Internal reference:
+- [Metrics Reference](./references/metrics.md) - Read when: designing specific evaluation metrics, choosing scoring scales, or implementing weighted rubric calculations
+
+Internal skills:
+- All other skills connect to evaluation for quality measurement
+
+External resources:
+- LLM evaluation benchmarks - Read when: selecting or building benchmark suites for agent comparison
+- Agent evaluation research papers - Read when: adopting new evaluation methodologies or validating current approach
+- Production monitoring practices - Read when: setting up alerting, dashboards, or sampling strategies for live systems
+
+---
+
+## Skill Metadata
+
+**Created**: 2025-12-20
+**Last Updated**: 2026-03-17
+**Author**: Agent Skills for Context Engineering Contributors
+**Version**: 1.1.0

package/.agents/skills/evaluation/references/metrics.md

@@ -0,0 +1,339 @@
+# Evaluation Reference: Metrics and Implementation
+
+This document provides implementation details for evaluation metrics and evaluation systems.
+
+## Core Metric Definitions
+
+### Factual Accuracy
+
+Factual accuracy measures whether claims in agent output match ground truth.
+
+```
+Excellent (1.0): All claims verified against ground truth, no errors
+Good (0.8): Minor errors that do not affect main conclusions
+Acceptable (0.6): Major claims correct, minor inaccuracies present
+Poor (0.3): Significant factual errors in key claims
+Failed (0.0): Fundamental factual errors that invalidate output
+```
+
+Calculation approach:
+- Extract claims from output
+- Verify each claim against ground truth
+- Weight claims by importance (major claims more weight)
+- Calculate weighted average of claim accuracy
+
+### Completeness
+
+Completeness measures whether output covers all requested aspects.
+
+```
+Excellent (1.0): All requested aspects thoroughly covered
+Good (0.8): Most aspects covered with minor gaps
+Acceptable (0.6): Key aspects covered, some gaps
+Poor (0.3): Major aspects missing from output
+Failed (0.0): Fundamental aspects not addressed
+```
+
+### Citation Accuracy
+
+Citation accuracy measures whether cited sources match claimed sources.
+
+```
+Excellent (1.0): All citations accurate and complete
+Good (0.8): Minor citation formatting issues
+Acceptable (0.6): Major citations accurate
+Poor (0.3): Significant citation problems
+Failed (0.0): Citations missing or completely incorrect
+```
+
+### Source Quality
+
+Source quality measures whether appropriate primary sources were used.
+
+```
+Excellent (1.0): Primary authoritative sources
+Good (0.8): Mostly primary sources with some secondary
+Acceptable (0.6): Mix of primary and secondary sources
+Poor (0.3): Mostly secondary or unreliable sources
+Failed (0.0): No credible sources cited
+```
+
+### Tool Efficiency
+
+Tool efficiency measures whether the agent used appropriate tools a reasonable number of times.
+
+```
+Excellent (1.0): Optimal tool selection and call count
+Good (0.8): Good tool selection with minor inefficiencies
+Acceptable (0.6): Appropriate tools with some redundancy
+Poor (0.3): Wrong tools or excessive call counts
+Failed (0.0): Severe tool misuse or extremely excessive calls
+```
+
+## Rubric Implementation
+
+```python
+EVALUATION_DIMENSIONS = {
+    "factual_accuracy": {
+        "weight": 0.30,
+        "description": "Claims match ground truth",
+        "levels": {
+            "excellent": 1.0,
+            "good": 0.8,
+            "acceptable": 0.6,
+            "poor": 0.3,
+            "failed": 0.0
+        }
+    },
+    "completeness": {
+        "weight": 0.25,
+        "description": "All requested aspects covered",
+        "levels": {
+            "excellent": 1.0,
+            "good": 0.8,
+            "acceptable": 0.6,
+            "poor": 0.3,
+            "failed": 0.0
+        }
+    },
+    "citation_accuracy": {
+        "weight": 0.15,
+        "description": "Citations match sources",
+        "levels": {
+            "excellent": 1.0,
+            "good": 0.8,
+            "acceptable": 0.6,
+            "poor": 0.3,
+            "failed": 0.0
+        }
+    },
+    "source_quality": {
+        "weight": 0.10,
+        "description": "Appropriate primary sources used",
+        "levels": {
+            "excellent": 1.0,
+            "good": 0.8,
+            "acceptable": 0.6,
+            "poor": 0.3,
+            "failed": 0.0
+        }
+    },
+    "tool_efficiency": {
+        "weight": 0.20,
+        "description": "Right tools used reasonably",
+        "levels": {
+            "excellent": 1.0,
+            "good": 0.8,
+            "acceptable": 0.6,
+            "poor": 0.3,
+            "failed": 0.0
+        }
+    }
+}
+
+def calculate_overall_score(dimension_scores, rubric):
+    """Calculate weighted overall score from dimension scores."""
+    total_weight = 0
+    weighted_sum = 0
+    
+    for dimension, score in dimension_scores.items():
+        if dimension in rubric:
+            weight = rubric[dimension]["weight"]
+            weighted_sum += score * weight
+            total_weight += weight
+    
+    return weighted_sum / total_weight if total_weight > 0 else 0
+```
+
+## Test Set Management
+
+```python
+class TestSet:
+    def __init__(self, name):
+        self.name = name
+        self.tests = []
+        self.tags = {}
+    
+    def add_test(self, test_case):
+        """Add test case to test set."""
+        self.tests.append(test_case)
+        
+        # Index by tags
+        for tag in test_case.get("tags", []):
+            if tag not in self.tags:
+                self.tags[tag] = []
+            self.tags[tag].append(len(self.tests) - 1)
+    
+    def filter(self, **criteria):
+        """Filter tests by criteria."""
+        filtered = []
+        for test in self.tests:
+            match = True
+            for key, value in criteria.items():
+                if test.get(key) != value:
+                    match = False
+                    break
+            if match:
+                filtered.append(test)
+        return filtered
+    
+    def get_complexity_distribution(self):
+        """Get distribution of tests by complexity."""
+        distribution = {}
+        for test in self.tests:
+            complexity = test.get("complexity", "medium")
+            distribution[complexity] = distribution.get(complexity, 0) + 1
+        return distribution
+```
+
+## Evaluation Runner
+
+```python
+class EvaluationRunner:
+    def __init__(self, test_set, rubric, agent):
+        self.test_set = test_set
+        self.rubric = rubric
+        self.agent = agent
+        self.results = []
+    
+    def run_all(self, verbose=False):
+        """Run evaluation on all tests."""
+        self.results = []
+        
+        for i, test in enumerate(self.test_set.tests):
+            if verbose:
+                print(f"Running test {i+1}/{len(self.test_set.tests)}")
+            
+            result = self.run_test(test)
+            self.results.append(result)
+        
+        return self.summarize()
+    
+    def run_test(self, test):
+        """Run single evaluation test."""
+        # Get agent output
+        output = self.agent.run(test["input"])
+        
+        # Evaluate
+        evaluation = self.evaluate_output(output, test)
+        
+        return {
+            "test": test,
+            "output": output,
+            "evaluation": evaluation
+        }
+    
+    def evaluate_output(self, output, test):
+        """Evaluate agent output against test."""
+        ground_truth = test.get("expected", {})
+        
+        dimension_scores = {}
+        for dimension, config in self.rubric.items():
+            score = self.evaluate_dimension(
+                output, ground_truth, dimension, config
+            )
+            dimension_scores[dimension] = score
+        
+        overall = calculate_overall_score(dimension_scores, self.rubric)
+        
+        return {
+            "overall_score": overall,
+            "dimension_scores": dimension_scores,
+            "passed": overall >= 0.7
+        }
+    
+    def summarize(self):
+        """Summarize evaluation results."""
+        if not self.results:
+            return {"error": "No results"}
+        
+        passed = sum(1 for r in self.results if r["evaluation"]["passed"])
+        
+        dimension_totals = {}
+        for dimension in self.rubric.keys():
+            dimension_totals[dimension] = {
+                "total": 0,
+                "count": 0
+            }
+        
+        for result in self.results:
+            for dimension, score in result["evaluation"]["dimension_scores"].items():
+                if dimension in dimension_totals:
+                    dimension_totals[dimension]["total"] += score
+                    dimension_totals[dimension]["count"] += 1
+        
+        dimension_averages = {}
+        for dimension, data in dimension_totals.items():
+            if data["count"] > 0:
+                dimension_averages[dimension] = data["total"] / data["count"]
+        
+        return {
+            "total_tests": len(self.results),
+            "passed": passed,
+            "failed": len(self.results) - passed,
+            "pass_rate": passed / len(self.results) if self.results else 0,
+            "dimension_averages": dimension_averages,
+            "failures": [
+                r for r in self.results 
+                if not r["evaluation"]["passed"]
+            ]
+        }
+```
+
+## Production Monitoring
+
+```python
+class ProductionMonitor:
+    def __init__(self, sample_rate=0.01):
+        self.sample_rate = sample_rate
+        self.samples = []
+        self.alert_thresholds = {
+            "pass_rate_warning": 0.85,
+            "pass_rate_critical": 0.70
+        }
+    
+    def sample_and_evaluate(self, query, output):
+        """Sample production interaction for evaluation."""
+        if random.random() > self.sample_rate:
+            return None
+        
+        evaluation = evaluate_output(output, {}, EVALUATION_RUBRIC)
+        
+        sample = {
+            "query": query[:200],
+            "output_preview": output[:200],
+            "score": evaluation["overall_score"],
+            "passed": evaluation["passed"],
+            "timestamp": current_timestamp()
+        }
+        
+        self.samples.append(sample)
+        return sample
+    
+    def get_metrics(self):
+        """Calculate current metrics from samples."""
+        if not self.samples:
+            return {"status": "insufficient_data"}
+        
+        passed = sum(1 for s in self.samples if s["passed"])
+        pass_rate = passed / len(self.samples)
+        
+        avg_score = sum(s["score"] for s in self.samples) / len(self.samples)
+        
+        return {
+            "sample_count": len(self.samples),
+            "pass_rate": pass_rate,
+            "average_score": avg_score,
+            "status": self._get_status(pass_rate)
+        }
+    
+    def _get_status(self, pass_rate):
+        """Get status based on pass rate."""
+        if pass_rate < self.alert_thresholds["pass_rate_critical"]:
+            return "critical"
+        elif pass_rate < self.alert_thresholds["pass_rate_warning"]:
+            return "warning"
+        else:
+            return "healthy"
+```
+