benchee v0.99.0 Release Notes

Release Date: 2019-03-28 // about 5 years ago
  • ๐Ÿš€ The "we're almost 1.0!" release - all the last small features, a bag of polish and deprecation warnings. If you run this release succesfully without deprecation warnings you should be safe to upgrade to 1.0.0, if not - it's a bug :)

    ๐Ÿ’ฅ Breaking Changes (User Facing)

    • ๐Ÿ”„ changed official Elixir compatibility to ~> 1.6, 1.4+ should still work but aren't guaranteed or tested against.

    ๐Ÿ”‹ Features (User Facing)

    • the console comparison now also displays the absolute difference in the average (like +12 ms) so that you have an idea to how much time that translates to in your applications not just that it's 100x faster
    • ๐Ÿ“š Overhaul of README, documentation, update samples etc. - a whole lot of things have also been marked @doc false as they're considered internal

    ๐Ÿ›  Bugfixes (User Facing)

    • โœ‚ Remove double empty line after configuration display
    • ๐Ÿ›  Fix some wrong type specs

    ๐Ÿ’ฅ Breaking Changes (Plugins)

    • Scenario made it to the big leagues, it's no longer Benchee.Benchmark.Scenario but Benchee.Scenario - as it is arguably one of our most important data structures.
    • The Scenario struct had some keys changed (last time before 2.0 I promise!) - instead of :run_times/:run_time_statistics you now have one run_time_data key that contains Benchee.CollectionData which has the keys :samples and :statistics. Same for memory_usage. This was done to be able to handle different kinds of measurements more uniformly as we will add more of them.

    ๐Ÿ”‹ Features (Plugins)

    • Benchee.Statistics comes with 3 new values: :relative_more, :relative_less, :absolute_difference so that you don't have to calculate these relative values yourself :)