@@ -11,3 +11,4 @@ examples/test_data/accidents.dat examples/test_data/chess.dat examples/test_data/kosarak.dat examples/test_data/retail.dat +ext/apriori/src/apriori .gitignore @@ -29,7 +29,7 @@ From Christian Borgelt's Apriori:http://www.borgelt.net/apriori.html documentati 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. +This Ruby library provides a convenient way to use this algorithm from Ruby. Original Apriori C code by Christian Borgelt. @@ -67,6 +67,15 @@ This document is not an introduction to the Apriori algorithm. To find out more 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) README.txt @@ -2,6 +2,10 @@ * 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 TODO.txt @@ -1,7 +1,8 @@ namespace :apriori do desc "Download the example data" task :get_example_data do - puts <<-EOF "Sorry! This isn't implemented in a portable way just yet. + puts <<-EOF +Sorry! This isn't implemented in a portable way just yet. If you're on a *nix system try: curl -0 http://fimi.cs.helsinki.fi/data/kosarak.dat > examples/test_data/kosarak.dat @@ -9,9 +10,11 @@ curl -0 http://fimi.cs.helsinki.fi/data/retail.dat > examples/test_data/retail.d Patches welcome! (http://github.com/jashmenn/apriori/tree/master) EOF + # open("http://www.ruby-lang.org/") {|f| # f.each_line {|line| p line} # } # } + end end tasks/apriori.rake @@ -33,81 +33,137 @@ <h1>apriori</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/apriori"; return false'> Get Version - <a href="http://rubyforge.org/projects/apriori" class="numbers">0.0.1</a> + <a href="http://rubyforge.org/projects/apriori" class="numbers">0.1.0</a> </div> - <h1>→ ‘apriori’</h1> + <h1>→ ‘find item associations’</h1> <h2>What</h2> - <h2>Installing</h2> - - - <pre class='syntax'>sudo gem install apriori</pre> + 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. - <h2>The basics</h2> + From Christian Borgelt’s Apriori:http://www.borgelt.net/apriori.html documentation: - <h2>Demonstration of usage</h2> + <blockquote> + Association rule induction is a powerful method for so-called market basket + analysis, which aims at finding regularities in the shopping behavior of + customers. + </blockquote> - <h2>Forum</h2> + <blockquote> + 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. + </blockquote> - <a href="http://groups.google.com/group/apriori">http://groups.google.com/group/apriori</a> + <blockquote> + An association rule is a rule like “If a customer buys wine and bread, he often + buys cheese, too.” + </blockquote> - TODO – create Google Group – apriori + <blockquote> + 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.). + </blockquote> - <h2>How to submit patches</h2> + This Ruby library provides a convenient way to use this algorithm from Ruby. - Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above. + Original Apriori C code by Christian Borgelt. - TODO – pick SVN or Git instructions + <h2>Installing</h2> - The trunk repository is <code>svn://rubyforge.org/var/svn/apriori/trunk</code> for anonymous access. + <pre class='syntax'>sudo gem install apriori</pre> - OOOORRRR + <h2>The Algorithm:</h2> - You can fetch the source from either: + This document is not an introduction to the Apriori algorithm. To find out more about Apriori see: <ul> - <li>rubyforge: MISSING IN ACTION</li> + <li>http://www.borgelt.net/papers/cstat_02.pdf</li> + <li>http://www.borgelt.net/papers/fimi_03.pdf</li> + <li>http://www.borgelt.net/apriori.html</li> + <li>http://en.wikipedia.org/wiki/Apriori_algorithm</li> </ul> - TODO – You can not created a RubyForge project, OR have not run <code>rubyforge config</code> -yet to refresh your local rubyforge data with this projects’ id information. + <h2>Demonstration of usage</h2> + + <pre class='syntax'> + require 'apriori' - When you do this, this message will magically disappear! + 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) - Or you can hack website/index.txt and make it all go away!! + 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) - <ul> - <li>github: <a href="http://github.com/jashmenn/apriori/tree/master">http://github.com/jashmenn/apriori/tree/master</a></li> - </ul> + # 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) +</pre> -<pre>git clone git://github.com/jashmenn/apriori.git</pre> + See the <ins>examples</ins> directory for more examples of usage. + + + <h2>Forum</h2> + + + <a href="http://groups.google.com/group/apriori">http://groups.google.com/group/apriori</a> + + + TODO – create Google Group – apriori + + + <h2>How to submit patches</h2> + <ul> - <li>gitorious: <a href="git://gitorious.org/apriori/mainline.git">git://gitorious.org/apriori/mainline.git</a></li> + <li>github: <a href="http://github.com/jashmenn/apriori/tree/master">http://github.com/jashmenn/apriori/tree/master</a></li> </ul> -<pre>git clone git://gitorious.org/apriori/mainline.git</pre> +<pre>git clone git://github.com/jashmenn/apriori.git</pre> <h3>Build and test instructions</h3> @@ -119,7 +175,45 @@ rake install_gem</pre> <h2>License</h2> - This code is free to use under the terms of the MIT license. + <h3>Apriori C code</h3> + + + Copyright© Christian Borgelt + + + Modified and under the LGPL license. +See <pre>ext/apriori/doc/copying</pre> for details. + + + <h3>Ruby Apriori Extension</h3> + + + (The MIT License) + + + Copyright© 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. <h2>Contact</h2> @@ -127,7 +221,7 @@ rake install_gem</pre> Comments are welcome. Send an email to <a href="mailto:nate@natemurray.com">Nate Murray</a> via the <a href="http://groups.google.com/group/apriori">forum</a> - <a href="nate@natemurray.com">Nate Murray</a>, 30th August 2008 + <a href="nate@natemurray.com">Nate Murray</a>, 4th September 2008 Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </div> website/index.html @@ -1,79 +1,140 @@ h1. apriori -h1. → 'apriori' +h1. → 'find item associations' h2. What +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. -h2. Installing - -<pre syntax="ruby">sudo gem install apriori</pre> - -h2. The basics +From Christian Borgelt's Apriori:http://www.borgelt.net/apriori.html documentation: +bq. Association rule induction is a powerful method for so-called market basket + analysis, which aims at finding regularities in the shopping behavior of + customers. -h2. Demonstration of usage - +bq. 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. +bq. An association rule is a rule like "If a customer buys wine and bread, he often + buys cheese, too." -h2. Forum - -"http://groups.google.com/group/apriori":http://groups.google.com/group/apriori +bq. 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.). -TODO - create Google Group - apriori +This Ruby library provides a convenient way to use this algorithm from Ruby. -h2. How to submit patches +Original Apriori C code by Christian Borgelt. -Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. +h2. Installing -TODO - pick SVN or Git instructions +<pre syntax="ruby">sudo gem install apriori</pre> -The trunk repository is <code>svn://rubyforge.org/var/svn/apriori/trunk</code> for anonymous access. +h2. The Algorithm: -OOOORRRR +This document is not an introduction to the Apriori algorithm. To find out more about Apriori see: -You can fetch the source from either: +* 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 -<% if rubyforge_project_id %> +h2. Demonstration of usage -* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> +<pre syntax="ruby"> + 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) +</pre> + +See the +examples+ directory for more examples of usage. -<pre>git clone git://rubyforge.org/apriori.git</pre> +h2. Forum -<% else %> +"http://groups.google.com/group/apriori":http://groups.google.com/group/apriori -* rubyforge: MISSING IN ACTION +TODO - create Google Group - apriori -TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code> -yet to refresh your local rubyforge data with this projects' id information. +h2. How to submit patches -When you do this, this message will magically disappear! +* github: "http://github.com/jashmenn/apriori/tree/master":http://github.com/jashmenn/apriori/tree/master -Or you can hack website/index.txt and make it all go away!! +<pre>git clone git://github.com/jashmenn/apriori.git</pre> -<% end %> +h3. Build and test instructions -* github: "http://github.com/jashmenn/apriori/tree/master":http://github.com/jashmenn/apriori/tree/master +<pre>cd apriori +rake test +rake install_gem</pre> -<pre>git clone git://github.com/jashmenn/apriori.git</pre> +h2. License +h3. Apriori C code +Copyright (c) Christian Borgelt -* gitorious: "git://gitorious.org/apriori/mainline.git":git://gitorious.org/apriori/mainline.git +Modified and under the LGPL license. +See <pre>ext/apriori/doc/copying</pre> for details. -<pre>git clone git://gitorious.org/apriori/mainline.git</pre> +h3. Ruby Apriori Extension -h3. Build and test instructions +(The MIT License) -<pre>cd apriori -rake test -rake install_gem</pre> +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: -h2. License +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. -This code is free to use under the terms of the MIT license. +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. h2. Contact website/index.txt 12ee61262885a7d9db2d8951e647e95a38e0a7de Nate Murray nate@natemurray.com http://github.com/jashmenn/apriori/commit/9cd905d0513fb9fabccac8f3573004b19b0efa3c 9cd905d0513fb9fabccac8f3573004b19b0efa3c

2008-09-04T08:43:33-07:00

working on website 1247a7ba0f242361138a2a24df0e63a24a715519 Nate Murray nate@natemurray.com