mitier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2068109131d7766f5798f6a8e8f50998aa5e712
+  data.tar.gz: 72459c0c285b85588347c8eb37c7f22d7e280810
+SHA512:
+  metadata.gz: a71ede38f13145faef3e84615a08059b01e328464a071ce450e3308170873ef0c016fe2d7e77a526fe3ff2f050c5bd9854ee45f0b4254630835ca3da7a493ec1
+  data.tar.gz: 0cfb3453e973f5f6f3dad77de1068992dcc771d03a89607d57442ed7a4f180bd58b0b5c17f4a1442e9bd3c9ca558e8660787c025ad03ea4f3570438b513a62eb

data/.env.example

@@ -0,0 +1 @@
+TEST_MODEL_PATH=./MITIE-models/english/ner_model.dat

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marko Satek
+
+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,60 @@
+# Mitier
+
+Simple FFI wrapper for MIT's MITIE library. Currently only wraps named entity
+extraction part.
+
+For details on what MITIE is and does visit [it's GitHub page](https://github.com/mit-nlp/MITIE).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mitier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mitier
+
+## Usage
+
+To use the gem make sure you have MITIE compiled and libmitie shared library placed where it can be found by the system.
+Also, you are going to need trained models. Download links can be found on [MITIE GitHub page](https://github.com/mit-nlp/MITIE)
+
+To run named entity recognition:
+
+```ruby
+extractor = Mitier::Extractor.new(TRAINED_MODEL_PATH).load
+extractor.process_ner SOME_TEXT
+```
+
+If you only want to run text tokenizer:
+
+```ruby
+tokenizer = Mitier::Tokenizer.new SOME_TEXT
+tokenizer.process
+```
+
+## Development
+
+To run the specs environment variable `TEST_MODEL_PATH` needs to be set and then run `bundle exec rspec`. Environment variables are loaded with Dotvim so you need to have `.env` file with that variable present. There is `.env.example` in the repo.
+
+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`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/satek/mitier.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mitier'
+require 'dotenv'
+require 'pry'
+
+Dotenv.load
+Pry.start

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/lib/mitier.rb

@@ -0,0 +1,9 @@
+require 'mitier/version'
+require 'ffi'
+require 'mitier/wrapper'
+require 'mitier/extractor'
+require 'mitier/tokenizer'
+require 'mitier/ner'
+
+module Mitier
+end

data/lib/mitier/extractor.rb

@@ -0,0 +1,21 @@
+module Mitier
+  class Extractor
+    attr_accessor :path
+
+    class ModelNotLoaded < Exception; end
+
+    def initialize(path)
+      @path = path
+    end
+
+    def load
+      @extractor = Mitier::Wrapper.mitie_load_named_entity_extractor @path
+      self
+    end
+
+    def process_ner(text)
+      raise ModelNotLoaded unless @extractor
+      Ner.new(@extractor, text).process
+    end
+  end
+end

data/lib/mitier/ner.rb

@@ -0,0 +1,51 @@
+module Mitier
+  class Ner < Tokenizer
+    attr_accessor :detections
+
+    def initialize(extractor, text)
+      super text
+      @extractor = extractor
+    end
+
+    def process
+      check_text { return self }
+      tokens_ptr = tokenize
+      detections_ptr = detect tokens_ptr
+      process_token_elements tokens_ptr
+      process_detections detections_ptr
+      self
+    end
+
+    private
+
+    attr_accessor :extractor
+
+    def detect(tokens_ptr)
+      Wrapper.mitie_extract_entities extractor, tokens_ptr
+    end
+
+    def process_detections(ptr)
+      num = Wrapper.mitie_ner_get_num_detections ptr
+      @detections = (0...num).map { |elem| detection_attrs(ptr, elem) }
+    end
+
+    def detection_attrs(ptr, nr)
+      { tokens: detection_tokens(ptr, nr),
+        tagstr: Wrapper.mitie_ner_get_detection_tagstr(ptr, nr),
+        tag: Wrapper.mitie_ner_get_detection_tag(ptr, nr),
+        score: Wrapper.mitie_ner_get_detection_score(ptr, nr) }
+    end
+
+    def detection_tokens(ptr, nr)
+      pos = Wrapper.mitie_ner_get_detection_position ptr, nr
+      len = Wrapper.mitie_ner_get_detection_length ptr, nr
+      (pos...(pos + len)).map { |elem| tokens[elem] }
+    end
+
+    def check_text
+      return unless text.empty?
+      @tokens = @detections = []
+      yield
+    end
+  end
+end

data/lib/mitier/tokenizer.rb

@@ -0,0 +1,30 @@
+module Mitier
+  class Tokenizer
+    attr_accessor :tokens, :text
+
+    def initialize(text)
+      @text = text.to_s.strip
+    end
+
+    def process
+      return [] if text.empty?
+      tokens_ptr = tokenize
+      process_token_elements tokens_ptr
+    end
+
+    private
+
+    def tokenize
+      Wrapper.mitie_tokenize text
+    end
+
+    def process_token_elements(ptr)
+      @tokens = [].tap do |elements|
+        until (element = ptr.read_pointer).null?
+          elements << element.read_string
+          ptr += FFI::Type::POINTER.size
+        end
+      end
+    end
+  end
+end

data/lib/mitier/version.rb

@@ -0,0 +1,3 @@
+module Mitier
+  VERSION = '0.1.0'.freeze
+end

data/lib/mitier/wrapper.rb

@@ -0,0 +1,17 @@
+module Mitier
+  module Wrapper
+    extend FFI::Library
+    ffi_lib 'mitie'
+    attach_function :mitie_tokenize_file, [:string], :pointer
+    attach_function :mitie_tokenize, [:string], :pointer
+    attach_function :mitie_load_named_entity_extractor, [:string], :pointer
+    attach_function :mitie_extract_entities, [:pointer, :pointer], :pointer
+    attach_function :mitie_ner_get_num_detections, [:pointer], :ulong
+    attach_function :mitie_ner_get_detection_tagstr, [:pointer, :ulong], :string
+    attach_function :mitie_ner_get_detection_tag, [:pointer, :ulong], :ulong
+    attach_function :mitie_ner_get_detection_score, [:pointer, :ulong], :float
+    attach_function :mitie_ner_get_detection_length, [:pointer, :ulong], :ulong
+    attach_function :mitie_ner_get_detection_position,
+                    [:pointer, :ulong], :ulong
+  end
+end

data/mitier.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mitier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mitier'
+  spec.version       = Mitier::VERSION
+  spec.authors       = ['Marko Satek']
+  spec.email         = ['satekm@gmail.com']
+
+  spec.summary       = 'MITIE library wrapped in Ruby with FFI. See https://github.com/mit-nlp/MITIE'
+  spec.homepage      = 'http://github.com/satek/mitier'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ffi', '~> 1.9.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.3'
+  spec.add_development_dependency 'dotenv', '~> 2.1.1'
+  spec.add_development_dependency 'rubocop', '~> 0.39.0'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: mitier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marko Satek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: 
+email:
+- satekm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mitier.rb
+- lib/mitier/extractor.rb
+- lib/mitier/ner.rb
+- lib/mitier/tokenizer.rb
+- lib/mitier/version.rb
+- lib/mitier/wrapper.rb
+- mitier.gemspec
+homepage: http://github.com/satek/mitier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: MITIE library wrapped in Ruby with FFI. See https://github.com/mit-nlp/MITIE
+test_files: []