Back to Ruflo

Quick Start Guide

v2/benchmark/docs/quick-start.md

3.6.302.3 KB
Original Source

Quick Start Guide

Get started with swarm benchmarking in 5 minutes!

šŸš€ Installation

bash
# Install the benchmark tool
cd benchmark/
pip install -e .

šŸŽÆ Your First Benchmark

1. Basic Benchmark

Run a simple benchmark with default settings:

bash
swarm-benchmark run "Build a user authentication system"

2. Specify Strategy

Choose a specific strategy for your task:

bash
swarm-benchmark run "Research cloud providers" --strategy research

3. Select Coordination Mode

Test different coordination patterns:

bash
swarm-benchmark run "Develop microservices" --mode distributed

4. View Results

Check your benchmark results:

bash
# List recent benchmarks
swarm-benchmark list

# Show specific benchmark details
swarm-benchmark show <benchmark-id>

šŸ“Š Understanding Output

After running a benchmark, you'll see:

āœ… Benchmark completed successfully!
šŸ“Š Results saved to: ./reports

The JSON output includes:

  • Task execution time: How long each task took
  • Resource usage: CPU and memory consumption
  • Success rate: Percentage of successful tasks
  • Quality scores: Accuracy and completeness metrics

šŸŽØ Common Scenarios

Development Tasks

bash
swarm-benchmark run "Create REST API with authentication" \
  --strategy development \
  --mode hierarchical \
  --max-agents 6

Research Tasks

bash
swarm-benchmark run "Analyze market trends" \
  --strategy research \
  --mode distributed \
  --parallel

Optimization Tasks

bash
swarm-benchmark run "Optimize database performance" \
  --strategy optimization \
  --mode hybrid \
  --monitor

šŸ”§ Quick Tips

  1. Use --parallel for faster execution with multiple agents
  2. Add --monitor to see real-time progress
  3. Use -v flag for verbose output
  4. Check ./reports/ for detailed JSON results

šŸ“š Next Steps

ā“ Need Help?