@@ -1,3 +1,6 @@ +== 0.2.2 2008-09-13 +* updated all the docs for the association rules. preped the first gem + == 0.2.1 2008-09-12 * updated requirements to check for the proper rubygems version History.txt @@ -68,15 +68,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) + # beer -> doritos (33.3/2, 100.0) + # doritos -> beer (50.0/3, 66.7) + # doritos -> apple (50.0/3, 33.3) + # apple -> doritos (66.7/4, 25.0) + # cheese -> apple (50.0/3, 100.0) + # apple -> cheese (66.7/4, 75.0) # NOTE: - # doritos <- beer (33.3/2, 100.0) + # beer -> doritos (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) README.txt @@ -17,16 +17,16 @@ rules = Apriori.find_association_rules(transactions, puts rules.join("\n") -# RETURNS: -# 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) +# Results: +# beer -> doritos (33.3/2, 100.0) +# doritos -> beer (50.0/3, 66.7) +# doritos -> apple (50.0/3, 33.3) +# apple -> doritos (66.7/4, 25.0) +# cheese -> apple (50.0/3, 100.0) +# apple -> cheese (66.7/4, 75.0) # NOTE: -# doritos <- beer (33.3/2, 100.0) +# beer -> doritos (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) examples/01_simple_example.rb @@ -41,6 +41,10 @@ module Apriori # Given +line+ returns an Itemset # Example of a line: # foo <- bar baz bangle (66.7/4, 75.0) + # + # Note that this is the opposite order of how apriori.rb returns the + # AssociationRule#to_s. (apriori.rb returns the antecedent on the left + # and consequent on the right) def parse_line(line) is = new line =~ /(.+)\s+<-\s+(.+?)\s+\((\d+\.\d)(?:\/(\d+))?,\s+(\d+\.\d)\)/ @@ -56,6 +60,10 @@ module Apriori # Returns the standard form of this rule as a string. For instance: # bar baz bangle -> foo (66.7/4, 75.0) + # # (antecedent) (consequent) + # + # Note that this order is the opposite order of the association rules returned by apriori.c + # I believe this format reads more naturally. def to_s # "%s <- %s (%0.01f%s, %0.01f)" % [ consequent, # antecedent.join(" "), lib/apriori/association_rule.rb @@ -2,7 +2,7 @@ module Apriori module VERSION #:nodoc: MAJOR = 0 MINOR = 2 - TINY = 1 + TINY = 2 STRING = [MAJOR, MINOR, TINY].join('.') end lib/apriori/version.rb @@ -47,7 +47,7 @@ large sets of transactions. This library provides a Ruby interface to Christian Borgelt&#8217;s C implementation of this algorithm.</p> - <p>From Christian Borgelt&#8217;s Apriori:http://www.borgelt.net/apriori.html documentation:</p> + <p>From <a href="http://www.borgelt.net/apriori.html">Christian Borgelt&#8217;s Apriori</a> documentation:</p> <blockquote> @@ -147,13 +147,16 @@ Borgelt&#8217;s C implementation of this algorithm.</p> <p>See the <ins>examples</ins> directory for more examples of usage.</p> - <h2>Forum</h2> + <h2>Rdoc</h2> - <p><a href="http://groups.google.com/group/apriori">http://groups.google.com/group/apriori</a></p> + <p><a href="http://apriori.rubyforge.org/rdoc/">View the rdoc here</a></p> - <p><span class="caps">TODO</span> &#8211; create Google Group &#8211; apriori</p> + <h2>Mailing List</h2> + + + <p><a href="http://rubyforge.org/mail/?group_id=6948">Rubyforge Mailing List</a></p> <h2>How to submit patches</h2> @@ -173,7 +176,7 @@ Borgelt&#8217;s C implementation of this algorithm.</p> rake test rake install_gem</pre> - <p>h3.</p> + <h3><tt>add_development_dependency</tt> error</h3> <p>If you get the error:</p> @@ -237,7 +240,7 @@ included in all copies or substantial portions of the Software.</p> <p>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></p> <p class="coda"> - <a href="nate@natemurray.com">Nate Murray</a>, 8th September 2008<br> + <a href="nate@natemurray.com">Nate Murray</a>, 18th September 2008<br> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </p> </div> website/index.html @@ -9,7 +9,7 @@ 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: +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 @@ -68,15 +68,15 @@ h2. Demonstration of usage 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) + # beer -> doritos (33.3/2, 100.0) + # doritos -> beer (50.0/3, 66.7) + # doritos -> apple (50.0/3, 33.3) + # apple -> doritos (66.7/4, 25.0) + # cheese -> apple (50.0/3, 100.0) + # apple -> cheese (66.7/4, 75.0) # NOTE: - # doritos <- beer (33.3/2, 100.0) + # beer -> doritos (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) @@ -84,11 +84,13 @@ h2. Demonstration of usage See the +examples+ directory for more examples of usage. -h2. Forum +h2. Rdoc -"http://groups.google.com/group/apriori":http://groups.google.com/group/apriori +"View the rdoc here":http://apriori.rubyforge.org/rdoc/ -TODO - create Google Group - apriori +h2. Mailing List + +"Rubyforge Mailing List":http://rubyforge.org/mail/?group_id=6948 h2. How to submit patches @@ -102,7 +104,7 @@ h3. Build and test instructions rake test rake install_gem</pre> -h3. +h3. <tt>add_development_dependency</tt> error If you get the error: website/index.txt 48f18f6aab3c61a67752d656887c16ad51b032cc Nate Murray nate@natemurray.com http://github.com/jashmenn/apriori/commit/c911a32b750648b275ae137a83118b9d2ac98d76 c911a32b750648b275ae137a83118b9d2ac98d76 2008-09-18T09:15:53-07:00 2008-09-18T09:15:53-07:00 v0.2.2 - updated docs, cleaning rough edges for gem 1d138145bc73d33500aa563b60d6ad121357ea2b Nate Murray nate@natemurray.com