jashmenn-apriori 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-30
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nate Murray
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,121 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+attic/c_ext_test1/MyTest/MyTest.c
+attic/c_ext_test1/MyTest/extconf.rb
+attic/c_ext_test1/mytest.rb
+attic/test.c
+config/hoe.rb
+config/requirements.rb
+examples/01_simple_example.rb
+examples/02_small_file_example.rb
+examples/03_large_file_example.rb
+examples/test_data/market_basket_basic_test.dat
+ext/Apriori.c
+ext/Makefile
+ext/apriori/doc/apriori.html
+ext/apriori/doc/arem.gp
+ext/apriori/doc/c_rev.gp
+ext/apriori/doc/chi2.tex
+ext/apriori/doc/copying
+ext/apriori/doc/line.gif
+ext/apriori/doc/uparrow.gif
+ext/apriori/ex/flg2set
+ext/apriori/ex/hdr2set
+ext/apriori/ex/readme
+ext/apriori/ex/row2set
+ext/apriori/ex/rulesort
+ext/apriori/ex/tab2set
+ext/apriori/ex/test.app
+ext/apriori/ex/test.rul
+ext/apriori/ex/test1.rul
+ext/apriori/ex/test1.tab
+ext/apriori/ex/test2.tab
+ext/apriori/ex/test3.tab
+ext/apriori/ex/test4.tab
+ext/apriori/ex/test5.tab
+ext/apriori/ex/tid2set
+ext/apriori/ex/xhdr2set
+ext/apriori/src/apriori.c
+ext/apriori/src/apriori.dsp
+ext/apriori/src/apriori.dsw
+ext/apriori/src/apriori.mak
+ext/apriori/src/istree.c
+ext/apriori/src/istree.h
+ext/apriori/src/makefile
+ext/apriori/src/tract.c
+ext/apriori/src/tract.h
+ext/apriori_wrapper.c
+ext/apriori_wrapper.h
+ext/extconf.rb
+ext/math/doc/copying
+ext/math/src/chi2.c
+ext/math/src/chi2.h
+ext/math/src/choose.c
+ext/math/src/choose.h
+ext/math/src/gamma.c
+ext/math/src/gamma.h
+ext/math/src/intexp.c
+ext/math/src/intexp.h
+ext/math/src/makefile
+ext/math/src/math.mak
+ext/math/src/normal.c
+ext/math/src/normal.h
+ext/math/src/radfn.c
+ext/math/src/radfn.h
+ext/math/src/zeta.c
+ext/math/src/zeta.h
+ext/pre-clean.rb
+ext/pre-setup.rb
+ext/util/doc/copying
+ext/util/src/listops.c
+ext/util/src/listops.h
+ext/util/src/makefile
+ext/util/src/memsys.c
+ext/util/src/memsys.h
+ext/util/src/nstats.c
+ext/util/src/nstats.h
+ext/util/src/params.c
+ext/util/src/params.h
+ext/util/src/parse.c
+ext/util/src/parse.h
+ext/util/src/scan.c
+ext/util/src/scan.h
+ext/util/src/symtab.c
+ext/util/src/symtab.h
+ext/util/src/tabscan.c
+ext/util/src/tabscan.h
+ext/util/src/util.mak
+ext/util/src/vecops.c
+ext/util/src/vecops.h
+lib/apriori.rb
+lib/apriori/adapter.rb
+lib/apriori/association_rule.rb
+lib/apriori/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/apriori.rake
+tasks/attic.rake
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+tasks/install.rake
+test/apriori_test.rb
+test/fixtures/market_basket_results_test.txt
+test/fixtures/market_basket_string_test.txt
+test/fixtures/results.txt
+test/fixtures/sample.txt
+test/test_helper.rb
+test/unit/test_apriori.rb
+test/unit/test_itemsets_and_parsing.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,139 @@
+= apriori
+
+* This project can be found at: http://github.com/jashmenn/apriori/tree/master
+* Christian Borgelt's original C code can be found at: http://www.borgelt.net/apriori.html
+
+== DESCRIPTION:
+
+Ruby Apriori is a library to efficiently find item association rules within
+large sets of transactions. This library provides a Ruby interface to Christian
+Borgelt's C implementation of this algorithm.
+
+From Christian Borgelt's Apriori:http://www.borgelt.net/apriori.html documentation: 
+
+  Association rule induction is a powerful method for so-called market basket
+  analysis, which aims at finding regularities in the shopping behavior of
+  customers.
+
+  With the induction of association rules one tries to find sets of
+  products that are frequently bought together, so that from the presence of
+  certain products in a shopping cart one can infer (with a high probability)
+  that certain other products are present. 
+
+  An association rule is a rule like "If a customer buys wine and bread, he often
+  buys cheese, too."
+
+  An association rule states that if we pick a customer at random and find out
+  that he selected certain items (bought certain products, chose certain options
+  etc.), we can be confident, quantified by a percentage, that he also selected
+  certain other items (bought certain other products, chose certain other options
+  etc.).
+
+This Ruby library provides a convenient way to use this algorithm from Ruby.
+
+Original Apriori C code by Christian Borgelt. 
+
+== THE ALGORITHM:
+
+This document is not an introduction to the Apriori algorithm. To find out more about Apriori see:
+
+* http://www.borgelt.net/papers/cstat_02.pdf
+* http://www.borgelt.net/papers/fimi_03.pdf
+* http://www.borgelt.net/apriori.html
+* http://en.wikipedia.org/wiki/Apriori_algorithm
+
+== FEATURES:
+
+* Supports easy use from Ruby data types
+* Supports large data files
+
+== EXAMPLE USAGE:
+
+  require 'apriori'
+
+  transactions = [  %w{beer doritos},
+                    %w{apple cheese}, 
+                    %w{beer doritos}, 
+                    %w{apple cheese}, 
+                    %w{apple cheese}, 
+                    %w{apple doritos} ]
+
+  rules = Apriori.find_association_rules(transactions,
+                            :min_items => 2,
+                            :max_items => 5,
+                            :min_support => 1, 
+                            :max_support => 100, 
+                            :min_confidence => 20)
+
+  puts rules.join("\n")
+
+  # Results: 
+  # doritos <- beer (33.3/2, 100.0)
+  # beer <- doritos (50.0/3, 66.7)
+  # apple <- doritos (50.0/3, 33.3)
+  # doritos <- apple (66.7/4, 25.0)
+  # apple <- cheese (50.0/3, 100.0)
+  # cheese <- apple (66.7/4, 75.0)
+
+  # NOTE:
+  # doritos <- beer (33.3/2, 100.0)
+  # means: 
+  # * beer appears in 33.3% (2 total) of the transactions (the support)
+  # * beer implies doritos 100% of the time (the confidence)
+
+See the +examples+ directory for more examples of usage.
+
+== EXAMPLE DATA:
+
+Example data can be found at:
+
+http://fimi.cs.helsinki.fi/data/
+
+== REQUIREMENTS:
+
+This library is compiled using a slightly modified version of Christian
+Borgelt's original C implementation of Apriori. The original code can be found
+at: http://www.borgelt.net/apriori.html
+
+* +gcc+ or similar compiler
+* <tt>ruby.h</tt>
+
+== INSTALL:
+
+* sudo gem install apriori
+
+== LICENSE:
+
+=== Apriori C code
+
+Copyright (c) Christian Borgelt
+
+Modified and under the LGPL license. 
+See ext/apriori/doc/copying for details.
+
+=== Ruby Apriori Extension
+
+(The MIT License)
+
+Copyright (c) 2008 Nate Murray
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+=========================================================================

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,60 @@
+== 0.1.0 2008-09-04
+* make a ruby gem
+* deal with association rules that only have 1 item
+
+* newgem thoughts:
+  * Ability for README.txt and website to be the same thing
+  * syntax highlighting on website
+
+== 0.0.1 2008-09-02
+
++ Clean up documentation
+  * website
+  + README.txt
+  + get documentation to build
+  + create example files
+  + apriori.rb
+
++ Clean up licensing everywhere
++ get the typical install to work
++ clean up the rakefile
++ refactor find_itemsets to be find_association_rules
+
+= What options to support later:
+
+-t#      target type (default: association rules)
+         (s: item sets, c: closed item sets, m: maximal item sets,
+          r: association rules, h: association hyperedges)
+-k#      item separator for output (default: " ")
+-p#      output format for support/confidence (default: "%.1f")
+-y       print lift value (confidence divided by prior)
+-g       write output in scanable form (quote certain characters)
+
+-q#      sort items w.r.t. their frequency (default: 2)
+         (1: ascending, -1: descending, 0: do not sort,
+          2: ascending, -2: descending w.r.t. transaction size sum)
+-b/f/r#  blank characters, field and record separators
+         (default: " \t\r", " \t", "\n")
+appfile  file stating item appearances (optional)
+
+
+= What options to support even later:
+-e#      additional evaluation measure (default: none)
+-!       print a list of additional evaluation measures
+-d#      minimal value of additional evaluation measure (default: 10%)
+-v       print value of additional rule evaluation measure
+-l       do not load transactions into memory (work on input file)
+-u#      filter unused items from transactions (default: 0.1)
+         (0: do not filter items w.r.t. usage in sets,
+         <0: fraction of removed items for filtering,
+         >0: take execution times ratio into account)
+-h       do not organize transactions as a prefix tree
+-j       use quicksort to sort the transactions (default: heapsort)
+-z       minimize memory usage (default: maximize speed)
+-C#      comment characters (default: "#")
+
+
+Don't even know what they do: 
+-o       use original definition of the support of a rule (body & head)
+-x       extended support output (print both rule support types)
+

data/attic/c_ext_test1/MyTest/MyTest.c

@@ -0,0 +1,23 @@
+// Include the Ruby headers and goodies
+#include "ruby.h"
+
+// Defining a space for information and references about the module to be stored internally
+VALUE MyTest = Qnil;
+
+// Prototype for the initialization method - Ruby calls this, not you
+void Init_mytest();
+
+// Prototype for our method 'test1' - methods are prefixed by 'method_' here
+VALUE method_test1(VALUE self);
+
+// The initialization method for this module
+void Init_mytest() {
+	MyTest = rb_define_module("MyTest");
+	rb_define_method(MyTest, "test1", method_test1, 0);	
+}
+
+// Our 'test1' method.. it simply returns a value of '10' for now.
+VALUE method_test1(VALUE self) {
+	int x = 10;
+	return INT2NUM(x);
+}

data/attic/c_ext_test1/MyTest/extconf.rb

@@ -0,0 +1,11 @@
+# Loads mkmf which is used to make makefiles for Ruby extensions
+require 'mkmf'
+
+# Give it a name
+extension_name = 'mytest'
+
+# The destination
+dir_config(extension_name)
+
+# Do the work
+create_makefile(extension_name)

data/attic/c_ext_test1/mytest.rb

@@ -0,0 +1,10 @@
+# Load in the extension (on OS X this loads ./MyTest/mytest.bundle - unsure about Linux, possibly mytest.so)
+require 'MyTest/mytest'
+
+# MyTest is now a module, so we need to include it
+include MyTest
+
+# Call and print the result from the test1 method
+puts test1
+
+# => 10

data/attic/test.c

@@ -0,0 +1,12 @@
+#include "apriori_wrapper.h"
+
+/*
+#include "scan.h"
+#include "tract.h"
+#include "istree.h"
+*/
+
+int main (int argc, char *argv[])
+{
+  return 0;
+}

data/config/hoe.rb

@@ -0,0 +1,77 @@
+require 'apriori/version'
+
+AUTHOR = 'Nate Murray'  # can also be an array of Authors
+EMAIL = "nate@natemurray.com"
+DESCRIPTION = "Ruby Apriori is a library to efficiently find item association rules within large sets of transactions."
+GEM_NAME = 'apriori' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'apriori' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Apriori::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'apriori documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    # "--exclude=ext",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  p.rdoc_pattern = /^(lib|bin)|txt$/
+
+  # p.spec_extras = {:extensions, FileList["ext/**/extconf.rb"].to_a} # A hash of extra values to set in the gemspec.
+  p.spec_extras = {:extensions, 'rakefile'} # A hash of extra values to set in the gemspec.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/examples/01_simple_example.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+require 'apriori'
+
+transactions = [  %w{beer doritos},
+                  %w{apple cheese}, 
+                  %w{beer doritos}, 
+                  %w{apple cheese}, 
+                  %w{apple cheese}, 
+                  %w{apple doritos} ]
+
+rules = Apriori.find_association_rules(transactions,
+                          :min_items => 2,
+                          :max_items => 5,
+                          :min_support => 1, 
+                          :max_support => 100, 
+                          :min_confidence => 20)
+
+puts rules.join("\n")
+
+# doritos <- beer (33.3/2, 100.0)
+# means: 
+# * beer appears in 33.3% (2 total) of the transactions (the support)
+# * beer implies doritos 100% of the time (the confidence)

data/examples/02_small_file_example.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+require 'apriori'
+require 'benchmark'
+
+rules = nil
+results = Benchmark.measure {
+rules = Apriori.find_association_rules(File.dirname(__FILE__) + "/test_data/market_basket_basic_test.dat",
+                           :min_items => 2,
+                           :max_items => 3,
+                           :min_support => 0.01, 
+                           :min_confidence => 30)
+}
+
+puts rules.join("\n")
+puts "#{rules.size} rules generated"
+puts "Benchmarks:"
+puts results

data/examples/03_large_file_example.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+require 'apriori'
+require 'benchmark'
+
+# NOTE: the 'accidents.dat' file is not supplied with this gem. To download it, 
+# run: rake apriori:get_example_data 
+# or see http://fimi.cs.helsinki.fi/data/
+
+puts "This will take a little while. Hold tight..."
+
+rules = nil
+results = Benchmark.measure {
+rules = Apriori.find_association_rules(File.dirname(__FILE__) + "/test_data/accidents.dat",
+                           :min_items => 2,
+                           :max_items => 10,
+                           :min_support => 50, 
+                           :min_confidence => 80)
+}
+
+puts "#{rules.size} rules generated"
+puts "Benchmarks:"
+puts results

data/examples/test_data/market_basket_basic_test.dat

@@ -0,0 +1,9 @@
+apple 
+beer doritos
+eggs cheese
+apple cheese
+beer doritos
+apple cheese
+eggs cheese apple
+apple cheese
+apple doritos