jashmenn-apriori 0.2.1 → 0.2.2

data/History.txt

@@ -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 
 

data/README.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)

data/examples/01_simple_example.rb

@@ -1,6 +1,13 @@
 $:.unshift(File.dirname(__FILE__) + "/../lib")
 require 'apriori'
 
+# or alternatively: 
+# transactions = [  %w{apple cheese}, 
+#                   %w{beer doritos}, 
+#                   %w{beer doritos eggs}, 
+#                   %w{beer doritos}, 
+#                   %w{apple cheese} ]
+
 transactions = [  %w{beer doritos},
                   %w{apple cheese}, 
                   %w{beer doritos}, 
@@ -17,16 +24,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)

data/lib/apriori/association_rule.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(" "), 

data/lib/apriori/version.rb

@@ -2,7 +2,7 @@ module Apriori
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>apriori</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/apriori"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/apriori" class="numbers">0.1.1</a>
+      <a href="http://rubyforge.org/projects/apriori" class="numbers">0.2.2</a>
       <img src="images/2118201782_4e87521dc9_m.jpg" />
     </div>
     <h1>&#x2192; &#8216;find item associations&#8217;</h1>
@@ -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>
@@ -129,15 +129,15 @@ Borgelt&#8217;s C implementation of this algorithm.</p>
   <span class="ident">puts</span> <span class="ident">rules</span><span class="punct">.</span><span class="ident">join</span><span class="punct">(&quot;</span><span class="string"><span class="escape">\n</span></span><span class="punct">&quot;)</span>
 
   <span class="comment"># Results: </span>
-  <span class="comment"># doritos &lt;- beer (33.3/2, 100.0)</span>
-  <span class="comment"># beer &lt;- doritos (50.0/3, 66.7)</span>
-  <span class="comment"># apple &lt;- doritos (50.0/3, 33.3)</span>
-  <span class="comment"># doritos &lt;- apple (66.7/4, 25.0)</span>
-  <span class="comment"># apple &lt;- cheese (50.0/3, 100.0)</span>
-  <span class="comment"># cheese &lt;- apple (66.7/4, 75.0)</span>
+  <span class="comment"># beer -&gt; doritos (33.3/2, 100.0)</span>
+  <span class="comment"># doritos -&gt; beer (50.0/3, 66.7)</span>
+  <span class="comment"># doritos -&gt; apple (50.0/3, 33.3)</span>
+  <span class="comment"># apple -&gt; doritos (66.7/4, 25.0)</span>
+  <span class="comment"># cheese -&gt; apple (50.0/3, 100.0)</span>
+  <span class="comment"># apple -&gt; cheese (66.7/4, 75.0)</span>
 
   <span class="comment"># NOTE:</span>
-  <span class="comment"># doritos &lt;- beer (33.3/2, 100.0)</span>
+  <span class="comment"># beer -&gt; doritos (33.3/2, 100.0)</span>
   <span class="comment"># means: </span>
   <span class="comment"># * beer appears in 33.3% (2 total) of the transactions (the support)</span>
   <span class="comment"># * beer implies doritos 100% of the time (the confidence)</span>
@@ -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,6 +176,21 @@ Borgelt&#8217;s C implementation of this algorithm.</p>
 rake test
 rake install_gem</pre>
 
+	<h3><tt>add_development_dependency</tt> error</h3>
+
+
+	<p>If you get the error:</p>
+
+
+	<pre><code>undefined method `add_development_dependency' for #<Gem::Specification:0x2aabcba63ed8></code></pre>
+
+
+	<p>This is because hoe 1.7.0 requires rubygems 1.2.0. To upgrade, simply do the following:</p>
+
+
+	<pre><code>gem update --system</code></pre>
+
+
 	<h2>License</h2>
 
 
@@ -222,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>, 4th 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>

data/website/index.txt

@@ -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:
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jashmenn-apriori
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Nate Murray
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-17 00:00:00 -07:00
+date: 2008-09-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency