All Versions
10
Latest Version
Avg Release Cycle
67 days
Latest Release
1934 days ago
Changelog History
Changelog History
-
v0.3.1 Changes
January 12, 2020๐ Bug Fixes
report
andgraph
generation now works even when number of samples is less than 3
-
v0.3.0 Changes
July 25, 2019๐ฅ Breaking Changes
- The signature of
selectBenchmarks
has changed, use 'Nothing' as the second argument of the benchmark generator function to port old code without any impact. - โ Removed the broken 'Percent' constructor from
GroupStyle
. UsePercentDiff
instead to make relative comparisons. - The behavior of
PercentDiff
has changed, it now computes the % from the lower value instead of from the baseline. - 0๏ธโฃ The default
diffStrategy
has been changed toSingleEstimator
instead ofMinEstimator
.
๐ Deprecations
- ๐ Config fields
title
andtitleAnnotations
have been deprecated, please usemkTitle
instead.
๐ Bug Fixes
- ๐
GroupStyle Absolute
now honors theMinEstimator
setting. WhenMinEstimator
is set, the groups being compared to baseline now display the value based on the estimator which provides closest estimate to the baseline.
โจ Enhancements
- โ Add a CLI executable to generate textual reports and graphs from criterion or gauge csv output file.
- โ Add
Multiples
as a comparison option, the group being compared is shown as a multiple of the baseline. - โ Add ability to omit the baseline group from the results when we are doing a relative comparison among groups.
- โ Add the ability to sort the benchmarks using a different criterion than the one used to present the benchmarks in the final report output.
- โ Add
mkTitle
config option to use a function for generating a custom report title.
- The signature of
-
v0.2.2 Changes
October 30, 2018- ๐ Allow additional annotations to title to be controlled via config
- ๐ Better error handling
-
v0.2.1 Changes
October 21, 2018- ๐ฆ Use new version of
statistics
package.
- ๐ฆ Use new version of
-
v0.2.0 Changes
October 12, 2018๐ Release Notes
- ๐ฆ Due to a bug in the
statistics
package, reporting may crash on certain inputs with avector 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 tobench-show
to reflect the fact that it now includes text reports as well. This includes the change of module nameBenchGraph
toBenchShow
. - ๐ The
bgraph
API has been removed and replaced bygraph
- 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 totitle
.- The type of
outputDir
is now aMaybe
. comparisonStyle
has been replaced bypresentation
ComparisonStyle
has been replaced byPresentation
sortBenchmarks
has been replaced byselectBenchmarks
. 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 byselectGroups
setYScale
field has been broken down into two fieldsfieldRanges
andfieldTicks
. 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
- ๐ฆ Due to a bug in the
-
v0.1.4 Changes
September 22, 2018- ๐ Fix a bug resulting in a bogus error, something like "Field [time] found at different indexes.." even though the field has exactly the same index at all places.
-
v0.1.3 Changes
July 17, 2018- โ Add maxrss plotting support
-
v0.1.2 Changes
July 13, 2018๐ Fixed a bug that caused missing graphs in some cases when multiple iterations of a benchmark are present in the bechmark results file.
๐ Better error reporting to pinpoint errors when a problem occurs.
-
v0.1.1 Changes
July 12, 2018- ๐ Support GHC 8.4
-
v0.1.0 Changes
May 22, 2018- ๐ Initial release