analyze/example_usage.sh

#!/bin/bash
# Example: How to use compare_experiments.py to compare two experiments

echo "=================================================="
echo "🔬 Experiment Comparison Tool - Usage Examples"
echo "=================================================="
echo ""

# Example 1: Compare WITH and WITHOUT vision experiments (recommended: use --tag)
echo "Example 1: Compare WITH vs WITHOUT Vision (using --tag)"
echo "-----------------------------------"
echo ""
echo "python analyze/src/compare_experiments.py \\"
echo "  examples/circle_packing/results/results_circle_packing_WITH_vision_20260114_065819 \\"
echo "  examples/circle_packing/results/results_circle_packing_WITHOUT_vision_20260114_070110 \\"
echo "  --labels \"WITH Vision\" \"WITHOUT Vision\" \\"
echo "  --tag vision_comparison"
echo ""
echo "# Output: analyze/outputs/vision_comparison/"
echo ""

# Example 2: Compare auxiliary metrics experiments
echo "Example 2: Compare 7 metrics vs 4 metrics"
echo "-----------------------------------"
echo ""
echo "python analyze/src/compare_experiments.py \\"
echo "  examples/circle_packing/results/results_circle_packing_NO_vision_WITH_aux_20260118_072141 \\"
echo "  examples/circle_packing/results/results_circle_packing_NO_vision_WITH_refined_aux_20260118_205215 \\"
echo "  --labels \"All 7 Metrics\" \"Refined 4 Metrics\" \\"
echo "  --tag aux_7vs4"
echo ""
echo "# Output: analyze/outputs/aux_7vs4/"
echo ""

# Example 3: Simple usage (default settings)
echo "Example 3: Simple usage (default output to analyze/outputs/)"
echo "-----------------------------------"
echo ""
echo "python analyze/src/compare_experiments.py \\"
echo "  path/to/exp1 \\"
echo "  path/to/exp2"
echo ""
echo "# Output: analyze/outputs/"
echo ""

# Example 4: Fully custom output path
echo "Example 4: Fully custom output path"
echo "-----------------------------------"
echo ""
echo "python analyze/src/compare_experiments.py \\"
echo "  path/to/exp1 \\"
echo "  path/to/exp2 \\"
echo "  --labels \"Exp A\" \"Exp B\" \\"
echo "  --output-dir custom/path/my_comparison"
echo ""
echo "# Output: custom/path/my_comparison/"
echo ""

echo "=================================================="
echo "💡 Tips:"
echo "  - Recommended to use --tag parameter to organize different comparison experiments"
echo "  - Use --help to view all parameters"
echo "  - Use 'uv run python ...' if project uses uv"
echo ""
echo "📊 Output directory priority:"
echo "  --output-dir > --tag > default(analyze/outputs)"
echo "=================================================="