svmlightcli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47812adeae8ac5a264485ac0c22d08925697641d
+  data.tar.gz: c1a90ced6c01a0516063697ecceb80a4e996f9dc
+SHA512:
+  metadata.gz: d544caeb924c3d364a12ca86ae5f51e73dd1877014f30bc4254692ef550cdb8afee8ab17ec05cbaf24def082ed41bd252d6a9a1133e3af43481ef45b33d380b8
+  data.tar.gz: 559b30f61f2ab3dfd8988ed5ab7ba86b58436b4b65d6174966f516307a2e7b16a5cd4bf74ca5859b643eb65811f01b689d4360afe99783fc7f20a73abafbc979

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in svmlightcli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    svmlightcli (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  rake (~> 10.0)
+  rake-compiler
+  svmlightcli!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,85 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 QCRI - Hossam Hammady
+
+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.
+
+---
+
+Original SVM-Light license:
+
+SVM-Light
+---------
+
+Available at http://svmlight.joachims.org/
+
+Author: Thorsten Joachims
+    thorsten@joachims.org
+
+    Cornell University
+    Department of Computer Science
+    4153 Upson Hall
+    Ithaca, NY 14853
+    USA
+
+LICENSING TERMS 
+
+This program is granted free of charge for research and education
+purposes. However you must obtain a license from the author to use it
+for commercial purposes.
+
+Scientific results produced using the software provided shall
+acknowledge the use of SVM-Light. Please cite as  
+
+       T. Joachims, Making large-Scale SVM Learning
+       Practical. Advances in Kernel Methods - Support Vector
+       Learning, B. Schölkopf and C. Burges and A. Smola (ed.),
+       MIT-Press, 1999. 
+       http://www-ai.cs.uni-dortmund.de/DOKUMENTE/joachims_99a.pdf
+
+Moreover shall the author of SVM-Light be informed about the
+publication.
+
+The software must not be modified and distributed without prior
+permission of the author.
+
+By using SVM-Light you agree to the licensing terms.
+
+
+NO WARRANTY 
+
+BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
+WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
+PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
+EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+PROGRAM IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF
+THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
+LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
+OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGES.

data/README.md

@@ -0,0 +1,49 @@
+# svmlightcli
+
+This is a convenience gem wrapper for the [svm_light](http://svmlight.joachims.org/)
+command line binaries. No Ruby interfaces.
+After installation, it offers 2 binaries in the path: `svm_learn` and `svm_classify`.
+In other words, it is something like:
+`brew install svm_light` or `apt-get install svm_light`
+(which do not exist), but using the RubyGems way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'svmlightcli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install svmlightcli
+
+## Usage
+
+Use the binaries the same exact way you use them when compiling from source:
+
+    $ svm_learn ...
+
+    $ svm_classify ...
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hammady/svmlightcli.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The original license of the svm_light author is also maintained in [LICENSE.txt](https://github.com/hammady/svmlightcli/blob/master/LICENSE.txt).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("svmlightcli") do |ext|
+  ext.lib_dir = "lib/svmlightcli"
+end
+
+task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "svmlightcli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/svm_classify

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# This is copied from the generated RubyGems bin stub
+# It basically runs a specified version of the gem if given
+
+version = ">= 0.a"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'svmlightcli', version
+
+# Now we don't want to just load the ruby bin file, we want to execute it
+# The reason is that it may not be necessarily a ruby file, could be native
+system(Gem.bin_path('svmlightcli', 'svm_classify_native', version))
+# Capture the exit status of the binary and exit with the same
+exit($?.exitstatus)

data/bin/svm_learn

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# This is copied from the generated RubyGems bin stub
+# It basically runs a specified version of the gem if given
+
+version = ">= 0.a"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'svmlightcli', version
+
+# Now we don't want to just load the ruby bin file, we want to execute it
+# The reason is that it may not be necessarily a ruby file, could be native
+system(Gem.bin_path('svmlightcli', 'svm_learn_native', version))
+# Capture the exit status of the binary and exit with the same
+exit($?.exitstatus)

data/ext/svmlightcli/Makefile

@@ -0,0 +1,95 @@
+#
+# makefile for svm_light 
+#
+# Thorsten Joachims, 2002
+#
+
+#Use the following to compile under unix or cygwin
+CC = gcc
+LD = gcc
+
+#Uncomment the following line to make CYGWIN produce stand-alone Windows executables
+#SFLAGS= -mno-cygwin
+
+#CFLAGS=  $(SFLAGS) -ggdb3 -O0 -pg -Wall -pedantic                     # release C-Compiler flags
+CFLAGS=  $(SFLAGS) -O3                     # release C-Compiler flags
+#LFLAGS=  $(SFLAGS) -O0 -pg                     # release linker flags
+LFLAGS=  $(SFLAGS) -O3                     # release linker flags
+#CFLAGS= $(SFLAGS) -pg -Wall -pedantic      # debugging C-Compiler flags
+#LFLAGS= $(SFLAGS) -pg                      # debugging linker flags
+LIBS=-L. -lm #-lsvmlight                               # used libraries
+SRC_DIR=.
+BIN_DIR=../../bin
+
+all: svm_learn_hideo svm_classify
+
+tidy: 
+	rm -f ./*.o
+
+clean:	tidy
+	rm -f ./svm_learn
+	rm -f ./svm_classify
+	rm -f ./libsvmlight.so
+
+help:   info
+
+info:
+	@echo
+	@echo "make for SVM-light               Thorsten Joachims, 1998"
+	@echo
+	@echo "Thanks to Ralf Herbrich for the initial version."
+	@echo 
+	@echo "USAGE: make [svm_learn | svm_learn_loqo | svm_learn_hideo | "
+	@echo "             libsvmlight_hideo | libsvmlight_loqo | "
+	@echo "             svm_classify | all | clean | tidy]"
+	@echo 
+	@echo "    svm_learn           builds the learning module (prefers HIDEO)"
+	@echo "    svm_learn_hideo     builds the learning module using HIDEO optimizer"
+	@echo "    svm_classify        builds the classfication module"
+	@echo "    libsvmlight_hideo   builds shared object library that can be linked into"
+	@echo "                        other code using HIDEO"
+	@echo "    all (default)       builds svm_learn + svm_classify"
+	@echo "    clean               removes .o and target files"
+	@echo "    tidy                removes .o files"
+	@echo
+
+# Create executables svm_learn and svm_classify
+
+svm_learn_hideo: svm_learn_main.o svm_learn.o svm_common.o svm_hideo.o 
+	$(LD) $(LFLAGS) svm_learn_main.o svm_learn.o svm_common.o svm_hideo.o -o svm_learn $(LIBS)
+
+svm_classify: svm_classify.o svm_common.o 
+	$(LD) $(LFLAGS) svm_classify.o svm_common.o -o svm_classify $(LIBS)
+
+
+# Create library libsvmlight.so, so that external code can get access to the
+# learning and classification functions of svm-light by linking this library.
+
+svm_learn_hideo_noexe: svm_learn_main.o svm_learn.o svm_common.o svm_hideo.o 
+
+libsvmlight_hideo: svm_learn_main.o svm_learn.o svm_common.o svm_hideo.o 
+	$(LD) -shared svm_learn.o svm_common.o svm_hideo.o -o libsvmlight.so
+
+#svm_learn_loqo_noexe: svm_learn_main.o svm_learn.o svm_common.o svm_loqo.o loqo
+
+# Compile components
+
+svm_hideo.o: $(SRC_DIR)/svm_hideo.c
+	$(CC) -c $(CFLAGS) $(SRC_DIR)/svm_hideo.c -o svm_hideo.o 
+
+svm_common.o: $(SRC_DIR)/svm_common.c $(SRC_DIR)/svm_common.h $(SRC_DIR)/kernel.h
+	$(CC) -c $(CFLAGS) $(SRC_DIR)/svm_common.c -o svm_common.o 
+
+svm_learn.o: $(SRC_DIR)/svm_learn.c $(SRC_DIR)/svm_common.h
+	$(CC) -c $(CFLAGS) $(SRC_DIR)/svm_learn.c -o svm_learn.o 
+
+svm_learn_main.o: $(SRC_DIR)/svm_learn_main.c $(SRC_DIR)/svm_learn.h $(SRC_DIR)/svm_common.h
+	$(CC) -c $(CFLAGS) $(SRC_DIR)/svm_learn_main.c -o svm_learn_main.o 
+
+svm_classify.o: $(SRC_DIR)/svm_classify.c $(SRC_DIR)/svm_common.h $(SRC_DIR)/kernel.h
+	$(CC) -c $(CFLAGS) $(SRC_DIR)/svm_classify.c -o svm_classify.o
+
+install: svm_learn_hideo svm_classify
+	cp svm_learn $(BIN_DIR)/svm_learn_native
+	cp svm_classify $(BIN_DIR)/svm_classify_native
+		

data/ext/svmlightcli/extconf.rb

@@ -0,0 +1,33 @@
+require "mkmf"
+
+# The $makefile_created and fake library are taken from:
+# https://yorickpeterse.com/articles/hacking-extconf-rb/
+
+# copy Makefile which is beside this file to current working directory
+# this is only needed in the Makefile preparation phase
+# later on, when installing the gem using gem or bundle
+# Makefile is used from the ext/svmlightcli directory
+begin
+  makefile = File.expand_path('../Makefile', __FILE__)
+  FileUtils.cp(makefile, '.')
+  # replace SRC_DIR in the copied Makefile with the correct path
+  src_dir = File.dirname __FILE__
+  new_contents = File.read('Makefile').sub("SRC_DIR=.", "SRC_DIR=#{src_dir}")
+  File.write('Makefile', new_contents)
+rescue Exception => e
+  # in the installation phase, cp will complain from copying to same dir
+end
+
+# This is normally set by calling create_makefile() but we don't need that
+# method since we'll provide a dummy Makefile. Without setting this value
+# RubyGems will abort the installation.
+$makefile_created = true
+
+# Create a dummy extension file. Without this RubyGems would abort the
+# installation process. On Linux this would result in the file "svmlightcli.so"
+# being created in the current working directory.
+#
+# Normally the generated Makefile would take care of this but since we
+# don't generate one we'll have to do this manually.
+#
+File.write("svmlightcli.#{RbConfig::CONFIG['DLEXT']}", '')

data/ext/svmlightcli/kernel.h

@@ -0,0 +1,40 @@
+/************************************************************************/
+/*                                                                      */
+/*   kernel.h                                                           */
+/*                                                                      */
+/*   User defined kernel function. Feel free to plug in your own.       */
+/*                                                                      */
+/*   Copyright: Thorsten Joachims                                       */
+/*   Date: 16.12.97                                                     */
+/*                                                                      */
+/************************************************************************/
+
+/* KERNEL_PARM is defined in svm_common.h The field 'custom' is reserved for */
+/* parameters of the user defined kernel. You can also access and use */
+/* the parameters of the other kernels. Just replace the line 
+             return((double)(1.0)); 
+   with your own kernel. */
+
+  /* Example: The following computes the polynomial kernel. sprod_ss
+              computes the inner product between two sparse vectors. 
+
+      return((CFLOAT)pow(kernel_parm->coef_lin*sprod_ss(a->words,b->words)
+             +kernel_parm->coef_const,(double)kernel_parm->poly_degree)); 
+  */
+
+/* If you are implementing a kernel that is not based on a
+   feature/value representation, you might want to make use of the
+   field "userdefined" in SVECTOR. By default, this field will contain
+   whatever string you put behind a # sign in the example file. So, if
+   a line in your training file looks like
+
+   -1 1:3 5:6 #abcdefg
+
+   then the SVECTOR field "words" will contain the vector 1:3 5:6, and
+   "userdefined" will contain the string "abcdefg". */
+
+double custom_kernel(KERNEL_PARM *kernel_parm, SVECTOR *a, SVECTOR *b) 
+     /* plug in you favorite kernel */                          
+{
+  return((double)(1.0)); 
+}