debian-mirror-gitlab/derailed-benchmarks/lib/derailed_benchmarks/stats_from_dir.rb
2019-10-07 21:24:36 +05:30

104 lines
3 KiB
Ruby

# frozen_string_literal: true
require 'bigdecimal'
require 'statistics'
module DerailedBenchmarks
# A class used to read several benchmark files
# it will parse each file, then sort by average
# time of benchmarks. It can be used to find
# the fastest and slowest examples and give information
# about them such as what the percent difference is
# and if the results are statistically significant
#
# Example:
#
# branch_info = {}
# branch_info["loser"] = { desc: "Old commit", time: Time.now, file: dir.join("loser.bench.txt"), name: "loser" }
# branch_info["winner"] = { desc: "I am the new commit", time: Time.now + 1, file: dir.join("winner.bench.txt"), name: "winner" }
# stats = DerailedBenchmarks::StatsFromDir.new(branch_info)
#
# stats.newest.average # => 10.5
# stats.oldest.average # => 11.0
# stats.significant? # => true
# stats.x_faster # => "1.0476"
class StatsFromDir
FORMAT = "%0.4f"
attr_reader :stats, :oldest, :newest
def initialize(hash)
@files = []
hash.each do |branch, info_hash|
file = info_hash.fetch(:file)
desc = info_hash.fetch(:desc)
time = info_hash.fetch(:time)
@files << StatsForFile.new(file: file, desc: desc, time: time, name: branch)
end
@files.sort_by! { |f| f.time }
@oldest = @files.first
@newest = @files.last
end
def call
@files.each(&:call)
@stats = statistical_test
self
end
def statistical_test(series_1=oldest.values, series_2=newest.values)
StatisticalTest::KSTest.two_samples(
group_one: series_1,
group_two: series_2
)
end
def significant?
@stats[:alternative]
end
def d_max
@stats[:d_max].to_f
end
def d_critical
@stats[:d_critical].to_f
end
def x_faster
FORMAT % (oldest.average/newest.average).to_f
end
def percent_faster
FORMAT % (((oldest.average - newest.average) / oldest.average).to_f * 100)
end
def change_direction
newest.average < oldest.average ? "FASTER" : "SLOWER"
end
def banner(io = Kernel)
io.puts
if significant?
io.puts "❤️ ❤️ ❤️ (Statistically Significant) ❤️ ❤️ ❤️"
else
io.puts "👎👎👎(NOT Statistically Significant) 👎👎👎"
end
io.puts
io.puts "[#{newest.name}] #{newest.desc.inspect} - (#{newest.average} seconds)"
io.puts " #{change_direction} by:"
io.puts " #{x_faster}x [older/newer]"
io.puts " #{percent_faster}\% [(older - newer) / older * 100]"
io.puts "[#{oldest.name}] #{oldest.desc.inspect} - (#{oldest.average} seconds)"
io.puts
io.puts "Iterations per sample: #{ENV["TEST_COUNT"]}"
io.puts "Samples: #{newest.values.length}"
io.puts
io.puts "Test type: Kolmogorov Smirnov"
io.puts "Is significant? (max > critical): #{significant?}"
io.puts "D critical: #{d_critical}"
io.puts "D max: #{d_max}"
io.puts
end
end
end