« Changelog History


bench-show v0.2.0 Release Notes

Release Date: 2018-10-12 // over 5 years ago

  • 🚀 Release Notes

    • 📦 Due to a bug in the statistics package, reporting may crash on certain inputs with a vector index out of bounds message. The bug has been fixed and will be available in an upcoming release.

    💥 Breaking Changes

    • 📦 The package bench-graph has been renamed to bench-show to reflect the fact that it now includes text reports as well. This includes the change of module name BenchGraph to BenchShow.
    • 🚚 The bgraph API has been removed and replaced by graph
    • The way output file is generated has changed. Now field name or group name being plotted or both may be suffixed to the output file name automatically. The estimator type (e.g. mean or median) is also suffixed to the filename.
    • 🔄 Changes to Config record:
      • chartTitle field has been renamed to title.
      • The type of outputDir is now a Maybe.
      • comparisonStyle has been replaced by presentation
      • ComparisonStyle has been replaced by Presentation
      • sortBenchmarks has been replaced by selectBenchmarks. The new function can be defined as follows in terms of an older definition: selectBenchmarks = \g -> sortBenchmarks $ either error (map fst) $ f (ColumnIndex 0)
      • sortBenchGroups has been replaced by selectGroups
      • setYScale field has been broken down into two fields fieldRanges and fieldTicks. Now you also need to specify which fields' scale you want to set.

    ✨ Enhancements

    • A report API has been added to generate textual reports
    • More ways to compare groups have been added, including percent and percent difference
    • Now we can show multiple fields as columns in a single benchmark group report
    • Field units are now automatically selected based on the range of values
    • ➕ Additions to Config record type:
      • selectFields added to select the fields to be plotted and to change their presentation order.
      • selectBenchmarks can now sort the results based on values corresponding to any field or benchmark group.
      • new fields added: diffStrategy, verbose, estimator, threshold