putting things in order

Author: Camilo Lopez

README.rdoc

@@ -1,6 +1,8 @@
 = svmredlight
+ Very partial interface to SVM-light [http://svmlight.joachims.org/] it permits loading a
+ model (pre-created with svm_learn) from a file and using it for classification.
 
-Description goes here.
+ As of now it's know to work with SVM 6.02.
 
 == Contributing to svmredlight
 

ext/svmredlight.c

@@ -1,15 +1,12 @@
-/* Very partial interface to SVMLIGHT it permits loading
- * a model (pre-created with svm_learn) from a file and using
- * it from classification for examples see test.rb
+/* Very partial interface to SVMLIGHT it permits loading a model (pre-created with
+ * svm_learn) from a file and using it from classification for examples see test.rb
  */
-
 #include "ruby.h"
 #include "svm_light/svm_common.h"
 
-/* Helper function to determine if
- * a model uses linear kernel, this should
- * be a #define macro
- * */
+/* Helper function to determine if a model uses linear kernel, this could be a #define
+ * macro
+ */
 int 
 is_linear(MODEL *model){
   return model->kernel_parm.kernel_type == 0; 
@@ -33,12 +30,10 @@ doc_free(DOC *d){
     free_example(d, 1);
 }
 
-/* Read a svm_light model from a file generated
- * by svm_learn receives the filename as argument
- * make sure the file exists before calling this!
- * otherwise exit(1) might be called 
- *
- * */
+/* Read a svm_light model from a file generated by svm_learn receives the filename as
+ * argument do make sure the file exists before calling this!  otherwise exit(1) might be
+ * called and the ruby interpreter will die.
+ */
 static VALUE
 model_read_from_file(VALUE klass, VALUE filename){
   Check_Type(filename, T_STRING);
@@ -52,10 +47,7 @@ model_read_from_file(VALUE klass, VALUE filename){
   return Data_Wrap_Struct(klass, 0, model_free, m);
 }
 
-/*
- *  Classify, gets a example (instance of Document)
- *  and returns its classification
- */
+/*  Classify, gets a example (instance of Document) and returns its classification */
 static VALUE
 model_classify_example(VALUE self, VALUE example){
   DOC *ex;
@@ -67,7 +59,7 @@ model_classify_example(VALUE self, VALUE example){
 
 
   /* Apparently unnecessary code 
-   *
+   
   if(is_linear(m))
     result = classify_example_linear(m, ex);
   else
@@ -96,15 +88,10 @@ model_total_words(VALUE self){
   return INT2FIX(m->totwords);
 }
 
-//TODO Change the format for words ary from [weight, weight, weight, ]
-//to [[wnum, weight],  [wnum, weight] ... ]
 /*
  * Creates a DOC from an array of words it also takes an id
- * -1 is normally OK for that value when using in filtering
- *  also takes the C parameter for the SVM. I'm not sure if 
- *  it matters in filtering, I'm passing the real vale now
- *  just in case.
- *
+ * -1 is normally OK for that value when using in filtering it also takes the C (cost)
+ *  parameter for the SVM.
  */
 static VALUE
 doc_create(VALUE klass, VALUE id, VALUE cost, VALUE words_ary ){
@@ -148,4 +135,3 @@ Init_svmredlight(){
   rb_cDocument = rb_define_class_under(rb_mSvmLight, "Document", rb_cObject);
   rb_define_singleton_method(rb_cDocument, "create", doc_create, 3);
 }
-

svmredlight.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Camilo Lopez"]
   s.date = %q{2011-06-08}
-  s.description = %q{TODO: longer description of your gem}
+  s.description = %q{Ruby interface to SVMLight}
   s.email = %q{[email protected]}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [
@@ -27,14 +27,15 @@ Gem::Specification.new do |s|
     "ext/extconf.rb",
     "ext/svmredlight.c",
     "lib/svmredlight.rb",
+    "svmredlight.gemspec",
     "test/helper.rb",
     "test/test_svmredlight.rb"
   ]
   s.homepage = %q{http://github.com/camilo/svmredlight}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.5.0}
-  s.summary = %q{TODO: one-line summary of your gem}
+  s.summary = %q{Ruby interface to SVMLight}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

test/svm_light_test.rb

@@ -4,8 +4,9 @@
 include SVMLight
 
 class TestDocument < Test::Unit::TestCase
+
   def test_create
-    assert d = Document.create(0, 0.5, [1.0, 0, 0, 0, 0.5])
+    assert Document.create(0, 0.5, [1.0, 0, 0, 0, 0.5])
   end
 
   def test_create_with_no_array

test/test_document.rb

@@ -10,9 +10,10 @@ def test_read
 
   def test_classify
     m = Model.read_from_file('test/model')
-    assert m.classify( Document.create(-1, 0, [1.0, 0, 0, 0, 0.5 ])) 
-    assert m.classify( Document.create(-1, 0, [0, 0, 0, 0, 0.8, 0, 0 , 0 ])) 
-    assert m.classify( Document.create(-1, 0, [0, 0.5, 0, 0, 0, 0 , 0 ])) 
+    assert m.classify( Document.create(-1, 0, [1.0, 0, 0, 0, 0.5 ])).is_a?(Numeric)
+    assert m.classify( Document.create(-1, 0, [1.0, 0, 0, 0, 0.5 ])).is_a?(Numeric)
+    assert m.classify( Document.create(-1, 0, [0, 0, 0, 0, 0.8, 0, 0 , 0 ])).is_a?(Numeric) 
+    assert m.classify( Document.create(-1, 0, [0, 0.5, 0, 0, 0, 0 , 0 ])).is_a?(Numeric)
   end
 
   def test_new_is_private