Documentation

comparison

Comparison utilities for TF vs CF benchmark results.

Functions

function
compare_latency_results(result: LatencyBenchmarkResult, category: str | None = None) → ComparisonResult

Compare TF vs CF query latency.

Compare TF vs CF query latency. Args: result: Latency benchmark result containing measurements category: Optional category to filter by Returns: ComparisonResult with latency comparison statistics
Parameters
  • result: LatencyBenchmarkResult
  • category: str | None= None
function
compare_load_times(result: MemoryBenchmarkResult) → ComparisonResult

Compare TF vs CF load times.

Compare TF vs CF load times. Args: result: Memory benchmark result containing measurements Returns: ComparisonResult with load time comparison statistics
Parameters
  • result: MemoryBenchmarkResult
function
compare_memory_results(result: MemoryBenchmarkResult, mode: Literal[('single', 'spawn', 'fork')] = 'single') → ComparisonResult

Compare TF vs CF memory usage for a specific mode.

Compare TF vs CF memory usage for a specific mode. Args: result: Memory benchmark result containing measurements mode: Benchmark mode to compare Returns: ComparisonResult with memory comparison statistics
Parameters
  • result: MemoryBenchmarkResult
  • mode: Literal[('single', 'spawn', 'fork')]= 'single'
function
compute_latency_stats_by_category(measurements: list[QueryMeasurement], queries: list, category: str, implementation: Literal[('TF', 'CF')]) → LatencyStatistics

Compute latency statistics for a category of patterns.

Compute latency statistics for a category of patterns. Args: measurements: All query measurements patterns: All search queries category: Category to filter by implementation: Implementation to filter by Returns: LatencyStatistics for the category
Parameters
  • measurements: list[QueryMeasurement]
  • queries: list
  • category: str
  • implementation: Literal[('TF', 'CF')]
function
compute_latency_stats_by_query(measurements: list[QueryMeasurement], query_id: str, implementation: Literal[('TF', 'CF')]) → LatencyStatistics

Compute latency statistics for a specific pattern and implementation.

Compute latency statistics for a specific pattern and implementation. Args: measurements: All query measurements query_id: Pattern ID to filter by implementation: Implementation to filter by Returns: LatencyStatistics for the pattern
Parameters
  • measurements: list[QueryMeasurement]
  • query_id: str
  • implementation: Literal[('TF', 'CF')]
function
format_comparison_summary(comparison: ComparisonResult) → str

Format a comparison result as a human-readable summary.

Format a comparison result as a human-readable summary. Args: comparison: ComparisonResult to format Returns: Formatted string summary
Parameters
  • comparison: ComparisonResult