benchmark-plot 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 114e9d216ecac8f1ff8af12dc422bbdbb37b7bf5
-  data.tar.gz: 7d3e52515be9d788f46ee623e32981a6239829dc
+  metadata.gz: ad54756fcf89b2ae23e8f8993bb4738c37ce339d
+  data.tar.gz: ae95a1da2c424dc44c7c96b030bc90414a923966
 SHA512:
-  metadata.gz: 7880f2edf6bf4698847951bd230400496efcf472d8377ac745c714569d006d081b47f3e68cbdd58013a9bdc11ec53d56352ee029959f91590def4144b3b8836a
-  data.tar.gz: e7166e9ce00753a6725ea5a58adff933fe2d711c3dde657687702b2447bf27f9c549e134c0fce03b1d00063623877afbfbd222920c9fe44a9b9e4ae42b835a45
+  metadata.gz: 3594f791ad1d9267ba901febd3366a5be3d56274ee7c4f2b604a80f085891626db1df27fbfafcb02996638b056573132eb197d6b3f105fe7317200b899846b80
+  data.tar.gz: ef3d1b36344b03d0ce0bf5a85ab9e79f469298aee10f912b34b620c7290a20dc2ecd33f66bcd8be472a9e5ed646f09082d1ed1ca59b568c7bbc83ddc9a5703e6

data/.gitignore

@@ -28,7 +28,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/HISTORY.md

@@ -1,3 +1,10 @@
 # 0.1
 
-* First gem release. Support for basic args and options.
+* First gem release. Support for basic args and options.
+
+# 0.1.1
+
+* Remove uncalled for puts statement from plotter.rb.
+* Add more examples.
+* More options and default Y axis label of 'Seconds'.
+* Lots of documentation.

data/README.md

@@ -1,6 +1,46 @@
 # benchmark-plot
+
 A Ruby benchmark extension to allow comparative plotting of benchmarks.
 
+# Usage
+
+This gem is mainly useful for benchmarking code over a number of inputs. This input should be supplied in the form of an object capable of calling `#each`.
+
+Sample benchmarking script:
+
+``` ruby
+require 'benchmark/plot'
+
+class TestArray
+  attr_reader :arr
+
+  def initialize arr
+    @arr = arr
+  end
+
+  def to_s
+    @arr.size.to_s
+  end
+end
+
+test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
+test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) }
+
+Benchmark.plot(test_data) do |x|
+  x.report("map.flatten") do |data|
+    data.arr.map { [nil]  }.flatten
+  end
+
+  x.report("flat_map") do |data|
+    data.arr.flat_map { [nil] }
+  end
+end
+```
+
+Output:
+
+![Benchmarks](examples/mapflat_vs_flat_map/benchmark_plot_graph.png)
+
 # Acknowledgements
 
-@tgxworld for providing the co-working space during the Open Source Breakfast Hack during Red Dot Ruby Conf 2016 where this gem was built.
+[@tgxworld](https://github.com/tgxworld) for providing the co-working space during the Open Source Breakfast Hack during Red Dot Ruby Conference 2016 where this gem was built.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'

data/benchmark-plot.gemspec

@@ -6,9 +6,8 @@ require 'benchmark/plot/version.rb'
 Benchmark::Plot::DESCRIPTION = <<MSG
 benchmark-plot is an extension to the Ruby standard benchmarking library.
 
-It let's you easily create plots in the form of PNG images of any code that you
-want to benchmark over a varied number of inputs. It also supports comparative
-benchmarking.
+It let's you easily create plots of any code that you want to benchmark over 
+a varied number of inputs. It also supports comparative benchmarking.
 MSG
 
 Gem::Specification.new do |spec|

data/examples/mapflat_vs_flat_map/flat_vs_flat_map.rb

@@ -1,12 +1,26 @@
+require 'benchmark/plot'
+
+class TestArray
+  attr_reader :arr
+
+  def initialize arr
+    @arr = arr
+  end
+
+  def to_s
+    @arr.size.to_s
+  end
+end
+
 test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
-test_data.map! {|e| Array.new(e) {|i| i} }
+test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) }
 
 Benchmark.plot(test_data) do |x|
   x.report("map.flatten") do |data|
-    data.map { [nil]  }.flatten
+    data.arr.map { [nil]  }.flatten
   end
 
   x.report("flat_map") do |data|
-    data.flat_map { [nil] }
+    data.arr.flat_map { [nil] }
   end
-end
+end

data/examples/matrix_vs_nmatrix/matrix_multiplication/matrix_multiplication.rb

@@ -0,0 +1,19 @@
+require 'benchmark/plot'
+require 'matrix'
+require 'nmatrix'
+require 'nmatrix/atlas'
+
+sizes = [5, 10, 50, 100, 150, 200]
+
+Benchmark.plot sizes, title: "Matrix multiplication",
+  file_name: "matrix_multiplication" do |x|
+  x.report "NMatrix with ATLAS" do |size|
+    n = NMatrix.new([size,size], [1]*size*size, dtype: :float32)
+    n.dot(n)
+  end
+
+  x.report "Matrix" do |size|
+    n = Matrix[*[[1]*size]*size]
+    n * n
+  end
+end

data/examples/nmatrix_vs_narray/matrix_creation.rb

@@ -0,0 +1,3 @@
+require 'numo-narray'
+require 'nmatrix'
+

data/lib/benchmark/plot.rb

@@ -6,6 +6,53 @@ require 'benchmark/plot/report_maker'
 require 'benchmark/plot/version'
 
 module Benchmark
+  # Create a plot of the benchmarked code over a varied number of inputs.
+  #
+  # @param test_data [Enumerable] An object containing the data that is to be 
+  #   used for the benchmarking. This object must be Enumerable, i.e. it must
+  #   have the `#each` method defined. Each of the constituent objects of 
+  #   `test_data` should have a `#to_s` method defined, which will be used for
+  #   populating the X axis labels.
+  # @param [Hash] opts The options for configuring the graph.
+  # @option opts [Symbol, String] :title (:Benchmarks) Title of the graph.
+  # @option opts [Symbol, String] :file_name (:benchmark_plot_graph) Name of 
+  #   file to which plot is written.
+  # @option opts [Symbol] :time (:real) The kind of time that should be displayed
+  #   on the graph. Can be `:real` for elapsed real time, `:stime` for System 
+  #   CPU time, `:utime` for User CPU time, `:cstime` for System CPU time of children,
+  #   `:cutime` for User CPU time of children, and `:total` for the total time
+  #   that is `:utime + :stime + :cutime + :cstime`.
+  # @option opts [TrueClass, FalseClass] :x_labels (true) Whether you want X-axis
+  #   labels or not.
+  # @option opts [String, Symbol] :x_axis_label (nil) X-axis label string.
+  # @example Benchmark map{}.flatten vs. flat_map
+  #   require 'benchmark/plot'
+  #   class TestArray
+  #      attr_reader :arr
+  # 
+  #      def initialize arr
+  #        @arr = arr
+  #      end
+  # 
+  #      # The to_s method is called for populating the X axis labels.
+  #      def to_s
+  #        @arr.size.to_s
+  #      end
+  #    end
+  # 
+  #    test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
+  #    test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) }
+  # 
+  #    Benchmark.plot(test_data) do |x|
+  #      x.report("map.flatten") do |data|
+  #         # Here `data` will be of an object of type `TestArray`.
+  #        data.arr.map { [nil]  }.flatten
+  #      end
+  # 
+  #     x.report("flat_map") do |data|
+  #       data.arr.flat_map { [nil] }
+  #     end
+  #   end
   def self.plot test_data, opts={}, &block
     include Benchmark::Plot
 

data/lib/benchmark/plot/plotter.rb

@@ -7,6 +7,7 @@ module Benchmark
         @title     = opts[:title] || :Benchmarks
         @time      = opts[:time] || :real
         @x_labels  = opts[:x_labels] || true
+        @x_axis_label = opts[:x_axis_label]
         @test_data = test_data
       end
 
@@ -22,8 +23,9 @@ module Benchmark
           plot.data label, time_data
         end
         positions = Array.new(@test_data.size) { |i| i }
-        puts positions.zip(@test_data.map(&:to_s)).to_h
         plot.labels = positions.zip(@test_data.map(&:to_s)).to_h if @x_labels
+        plot.x_axis_label = @x_axis_label if @x_axis_label
+        plot.y_axis_label = 'Seconds'
         plot.write("#{@file_name}.png")
       end
 

data/lib/benchmark/plot/version.rb

@@ -1,5 +1,5 @@
 module Benchmark
   module Plot
-    VERSION = "0.1"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-plot
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Sameer Deshmukh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gruff
@@ -24,12 +24,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  benchmark-plot is an extension to the Ruby standard benchmarking library.
-
-  It let's you easily create plots in the form of PNG images of any code that you
-  want to benchmark over a varied number of inputs. It also supports comparative
-  benchmarking.
+description: "benchmark-plot is an extension to the Ruby standard benchmarking library.\n\nIt
+  let's you easily create plots of any code that you want to benchmark over \na varied
+  number of inputs. It also supports comparative benchmarking.\n"
 email:
 - sameer.deshmukh93@gmail.com
 executables: []
@@ -40,11 +37,13 @@ files:
 - HISTORY.md
 - LICENSE
 - README.md
+- Rakefile
 - benchmark-plot.gemspec
-- examples/flat_vs_flat_map.rb
 - examples/mapflat_vs_flat_map/benchmark_plot_graph.png
 - examples/mapflat_vs_flat_map/flat_vs_flat_map.rb
-- examples/matrix_benchmarks.rb
+- examples/matrix_vs_nmatrix/matrix_multiplication/matrix_multiplication.png
+- examples/matrix_vs_nmatrix/matrix_multiplication/matrix_multiplication.rb
+- examples/nmatrix_vs_narray/matrix_creation.rb
 - lib/benchmark/plot.rb
 - lib/benchmark/plot/plotter.rb
 - lib/benchmark/plot/report_maker.rb

data/examples/flat_vs_flat_map.rb

@@ -1,26 +0,0 @@
-require 'benchmark/plot'
-
-class TestArray
-  attr_reader :arr
-
-  def initialize arr
-    @arr = arr
-  end
-
-  def to_s
-    @arr.size.to_s
-  end
-end
-
-test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
-test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) }
-
-Benchmark.plot(test_data) do |x|
-  x.report("map.flatten") do |data|
-    data.arr.map { [nil]  }.flatten
-  end
-
-  x.report("flat_map") do |data|
-    data.arr.flat_map { [nil] }
-  end
-end

data/examples/matrix_benchmarks.rb

@@ -1,14 +0,0 @@
-require 'nmatrix'
-require 'matrix'
-
-test_data = [5,10,15,20,25,30,35]
-
-Benchmark.plot(test_data) do |x, data|
-  x.report("nmatrix creation") do
-    Array.new(data) { |i|  i }
-  end
-
-  x.report("matrix creation") do
-    Array.new(data) { |i|  i }
-  end
-end