ffi-fasttext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c217429c82622b92680b63e21f0c86f42cb920a5
+  data.tar.gz: 6918bc5355f181f3755b0932696b4fd2e73949e4
+SHA512:
+  metadata.gz: 110c9c5767272ffaf845c8798e093f3d9e7693373aca44dfae50e9f8c4cca7a1537f50274ca4b869034f6b549c1d5abf12354e261141ade94b9a1d67b88c70b7
+  data.tar.gz: 4e06ffaa51d37cab3f6b99381c5413d4f4876c04b45130bdada8bb08bd665064a28dac0b1ccdd6e48ffa953a203585822ecdc723f925b5c9b247a5a9fc9347f7

data/.gitignore

@@ -0,0 +1,44 @@
+.ruby-*
+*.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/fasttext/fasttext
+
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ffi-fasttext.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brandon Dewitt
+
+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.

data/README.md

@@ -0,0 +1,59 @@
+# FFI::Fasttext
+
+FFI bindings for [Fasttext](https://fasttext.cc/)
+
+If you aren't sure what Fasttext is then read the information provided at the site above or the facebook github profile for the source of the fasttext C++ code [Github:Fasttext](https://github.com/facebookresearch/fastText/)
+
+The FFI bindings are only for using Fasttext predictions in a ruby process after a model has been trained in the console. The model.bin/model.vec files are required to use the prediction probabilities through the `#predict` method of a `::FFI::Fasttext::Predictor` object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ffi-fasttext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffi-fasttext
+
+## Usage
+
+Requires `g++` to be installed as it uses the C++ compiler to build the shared object that FFI uses and the executable unless other configuration options for access to the shared object are provided.
+
+The Fasttext C++ model loading code will error out (and cause a hard `exit`) if the wrong model file is used or the model file is not at the specified filename. (so make sure you use the \*.bin file in the initialization)
+
+There is a test training set and model in the spec directory, which should not be relied on for any predictability as it is abbreviated and all trained on "derp" derivations.
+
+```ruby
+require "ffi/fasttext"
+
+ft = ::FFI::Fasttext::Predictor.new("spec/model.bin")
+
+ft.predict("derp") # => [["__label__3", 0.4375]] // will output the highest probability label and the associated probability in an array
+ft.predict("derp", 3) # => [["__label__3", 0.4375], ["__label__1", 0.396484], ["__label__2", 0.164063]] // will output the top 3 probabilities in an array of arrays
+ft.predict("derp", 10) # => [["__label__3", 0.4375], ["__label__1", 0.396484], ["__label__2", 0.164063]] // output the same as above as there are only 3 categories or if probability < 0
+
+ft.destroy! # The prediction model is dynamically allocated in C code and must be released
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/abrandoned/ffi-fasttext
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/abrandoned/ffi-fasttext/blob/master/LICENSE.txt)
+The original source is licensed per Facebook under the terms of the [BSD License](https://github.com/abrandoned/ffi-fasttext/blob/master/vendor/fasttext/LICENSE)
+Along with a Patent License from Facebook [Patents](https://github.com/abrandoned/ffi-fasttext/blob/master/vendor/fasttext/PATENTS)

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+import "ext/ffi/fasttext/Rakefile"
+
+namespace :fasttext do
+  desc "build fasttext"
+  task :compile do
+    ::Rake::Task[:compile_fasttext].invoke
+  end
+end
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+Rake::Task[:spec].prerequisites << "fasttext:compile"
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffi/fasttext"
+
+# 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/ext/ffi/fasttext/Rakefile

@@ -0,0 +1,71 @@
+require "rubygems"
+require "fileutils"
+require "ffi"
+
+# Copied fom mkmf
+def find_executable(bin, path = nil)
+  executable_file = proc do |name|
+    begin
+      stat = File.stat(name)
+    rescue SystemCallError
+    else
+      next name if stat.file? and stat.executable?
+    end
+  end
+
+  if File.expand_path(bin) == bin
+    return bin if executable_file.call(bin)
+    return nil
+  end
+  path = %w[/usr/local/bin /usr/ucb /usr/bin /bin]
+  if additional_path ||= ENV['PATH']
+    path += additional_path.split(File::PATH_SEPARATOR)
+  end
+  file = nil
+  path.each do |dir|
+    return file if executable_file.call(file = File.join(dir, bin))
+  end
+  nil
+end
+
+def sys(cmd)
+  puts " -- #{cmd}"
+  unless ret = system(cmd)
+    raise "ERROR: '#{cmd}' failed"
+  end
+  ret
+end
+
+desc "Build the fasttext shared lib"
+task :compile_fasttext do
+  # Do not attempt to install if we want to use the system fasttext lib
+  next if ENV.key?("FASTTEXT_USE_SYSTEM_LIB") || ENV.key?("SKIP_FASTTEXT_COMPILE")
+
+  if !find_executable("g++")
+    abort "ERROR: g++ is required to build ffi-fasttext"
+  end
+
+  CWD = ::File.expand_path(::File.dirname(__FILE__))
+  FASTTEXT_DIR = ::File.join(CWD, "..", "..", "..", "vendor", "fasttext")
+
+  ::Dir.chdir(FASTTEXT_DIR) do
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c args.cc") unless ::File.exist?("args.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c dictionary.cc") unless ::File.exist?("dictionary.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c productquantizer.cc") unless ::File.exist?("productquantizer.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c matrix.cc") unless ::File.exist?("matrix.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c qmatrix.cc") unless ::File.exist?("qmatrix.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c vector.cc") unless ::File.exist?("vector.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c model.cc") unless ::File.exist?("model.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c utils.cc") unless ::File.exist?("utils.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c fasttext.cc") unless ::File.exist?("fasttext.o")
+    sys("g++ -c -O3 -fPIC -pthread -std=c++0x -c ffi_fasttext.cc")
+    sys("g++ -fPIC -pthread -std=c++0x args.o dictionary.o productquantizer.o matrix.o qmatrix.o vector.o model.o utils.o fasttext.o main.cc -o fasttext") unless ::File.exist?("fasttext")
+    sys("g++ -fPIC -pthread -std=c++0x args.o dictionary.o productquantizer.o matrix.o qmatrix.o vector.o model.o utils.o fasttext.o ffi_fasttext.o -shared -o libfasttext.#{::FFI::Platform::LIBSUFFIX}")
+  end
+
+  unless ::File.exist?(::File.join(FASTTEXT_DIR, "libfasttext.#{::FFI::Platform::LIBSUFFIX}"))
+    abort "ERROR: Failed to build fasttext"
+  end
+end
+
+task :default => :compile_fasttext

data/ffi-fasttext.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ffi/fasttext/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffi-fasttext"
+  spec.version       = ::FFI::Fasttext::VERSION
+  spec.authors       = ["Brandon Dewitt"]
+  spec.email         = ["brandonsdewitt+rubygems@gmail.com"]
+
+  spec.summary       = %q{ FFI bindings for Facebook's FastText text classification library }
+  spec.description   = %q{ FFI bindings for Facebook's FastText text classification library }
+  spec.homepage      = "https://www.github.com/abrandoned/ffi-fastext"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.extensions    = "ext/ffi/fasttext/Rakefile"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/ffi/fasttext.rb

@@ -0,0 +1,108 @@
+require "ffi"
+require "ffi/fasttext/version"
+
+module FFI
+  module Fasttext
+    extend FFI::Library
+    ffi_lib_flags :now, :global
+
+    ##
+    # ffi-rzmq-core for reference
+    #
+    # https://github.com/chuckremes/ffi-rzmq-core/blob/master/lib/ffi-rzmq-core/libzmq.rb
+    #
+    begin
+      # bias the library discovery to a path inside the gem first, then
+      # to the usual system paths
+      gem_base = ::File.join(::File.dirname(__FILE__), '..', '..')
+      inside_gem = ::File.join(gem_base, 'ext')
+      local_path = ::FFI::Platform::IS_WINDOWS ? ENV['PATH'].split(';') : ENV['PATH'].split(':')
+      env_path = [ ENV['FASTTEXT_LIB_PATH'] ].compact
+      rbconfig_path = ::RbConfig::CONFIG["libdir"]
+      homebrew_path = nil
+
+      # RUBYOPT set by RVM breaks 'brew' so we need to unset it.
+      rubyopt = ENV.delete('RUBYOPT')
+
+      begin
+        stdout, stderr, status = ::Open3.capture3("brew", "--prefix")
+        homebrew_path  = if status.success?
+                           "#{stdout.chomp}/lib"
+                         else
+                           '/usr/local/homebrew/lib'
+                         end
+      rescue
+        # Homebrew doesn't exist
+      end
+
+      # Restore RUBYOPT after executing 'brew' above.
+      ENV['RUBYOPT'] = rubyopt
+
+      # Search for libfasttext in the following order...
+      fasttext_lib_paths =
+        if ENV.key?("FASTTEXT_USE_SYSTEM_LIB")
+          [inside_gem] + env_path + local_path + [rbconfig_path] + [
+           '/usr/local/lib', '/opt/local/lib', homebrew_path, '/usr/lib64'
+          ]
+        else
+          [::File.join(gem_base, "vendor/fasttext")]
+        end
+
+      FASTTEXT_LIB_PATHS = fasttext_lib_paths.
+        compact.map{|path| "#{path}/libfasttext.#{::FFI::Platform::LIBSUFFIX}"}
+
+      ffi_lib(FASTTEXT_LIB_PATHS + %w{libfasttext})
+    rescue LoadError => error
+      if FASTTEXT_LIB_PATHS.any? {|path| ::File.file?(::File.join(path)) }
+        warn "Unable to load this gem. The libfasttext library exists, but cannot be loaded."
+        warn "Set FASTTEXT_LIB_PATH if custom load path is desired"
+        warn "If this is Windows:"
+        warn "-  Check that you have MSVC runtime installed or statically linked"
+        warn "-  Check that your DLL is compiled for #{FFI::Platform::ADDRESS_SIZE} bit"
+      else
+        warn "Unable to load this gem. The libfasttext library (or DLL) could not be found."
+        warn "Set FASTTEXT_LIB_PATH if custom load path is desired"
+        warn "If this is a Windows platform, make sure libfasttext.dll is on the PATH."
+        warn "If the DLL was built with mingw, make sure the other two dependent DLLs,"
+        warn "libgcc_s_sjlj-1.dll and libstdc++6.dll, are also on the PATH."
+        warn "For non-Windows platforms, make sure libfasttext is located in this search path:"
+        warn FASTTEXT_LIB_PATHS.inspect
+      end
+      raise error
+    end
+
+    attach_function :create, [:string], :pointer
+    attach_function :destroy, [:pointer], :void
+    attach_function :predict_string_free, [:pointer], :void
+    attach_function :predict, [:pointer, :string, :int32_t], :strptr
+
+    class Predictor
+      def initialize(model_filename)
+        raise "File does not exist" unless ::File.exist?(model_filename)
+        @ptr = ::FFI::Fasttext.create(model_filename)
+      end
+
+      def destroy!
+        ::FFI::Fasttext.destroy(@ptr) unless @ptr.nil?
+        @ptr = nil
+      end
+
+      def predict(string, number_of_predictions = 1)
+        response_string, pointer = ::FFI::Fasttext.predict(@ptr, string, number_of_predictions)
+        return [] unless response_string.size > 0
+
+        response_array = []
+        split_responses = response_string.split(" ")
+        split_responses.each_slice(2) do |pair|
+          next unless pair.first && pair.last
+
+          response_array << [pair.first, pair.last.to_f]
+        end
+
+        response_array
+      ensure
+        ::FFI::Fasttext.predict_string_free(pointer) unless pointer.nil?
+      end
+    end
+  end
+end

data/lib/ffi/fasttext/version.rb

@@ -0,0 +1,5 @@
+module FFI
+  module Fasttext
+    VERSION = "0.1.0"
+  end
+end

data/vendor/fasttext/LICENSE

@@ -0,0 +1,30 @@
+BSD License
+
+For fastText software
+
+Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.