opener-ner-base 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1588124c7668723220e5ed08bd40fb51e6277a1
-  data.tar.gz: cecd424beb6731ac335ca61022730cb414f859d1
+  metadata.gz: a9c3cbf54f8eb38a77510e677e030d0b0aa0ea10
+  data.tar.gz: cd75f167bc72ec29f432191579c5fc149346946e
 SHA512:
-  metadata.gz: 322927109650e537a4c6b7cee2346393f149ad206b066038362bbc0b2e16249b8c762fcd7fa1675b96ccbc61fa0c6d9cfabe2f59ad83b06bca83f895664bbe76
-  data.tar.gz: 12385007e9301e2fbd4c7a4362e8ae6918a33f4b27858c17d8c5cb5e8ffa6e74cec6d9a68e8292f85e05b394339ab4d85ffa873a10dab0cdb47f53488e9e0aec
+  metadata.gz: e8760fedd8f3bb7daf95f9597f984fdc4f38b29bf38271b6206dcfae17f360d18e77fff9f483fa34c3b8d517b8b5ebb6e6eed42af7f46f6d8735a0a38ffad2b9
+  data.tar.gz: 6c912e843758644975ffe9f793efc084ebf1d73401edfaf3b575dc0d5f9d487360e1f6777ddfe0556ab7ba8f3f002318bccf8de7bff6848a78005ece20938bea

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 OpeNER Project Consortium
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/{ner-de → ner-base}

@@ -2,7 +2,7 @@
 
 require_relative '../lib/opener/ners/base'
 
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'de')
+kernel = Opener::Ners::Base.new
 input  = STDIN.tty? ? nil : STDIN.read
 
 puts kernel.run(input)

data/lib/opener/ners/base.rb

@@ -1,11 +1,8 @@
 require 'open3'
-require 'java'
 require 'stringio'
+require 'nokogiri'
 
-require File.expand_path("../../../../core/target/ehu-nerc-1.0.jar", __FILE__)
-
-import 'ixa.kaflib.KAFDocument'
-import 'java.io.InputStreamReader'
+require File.expand_path("../../../../core/target/ixa-pipe-nerc-1.1.0.jar", __FILE__)
 
 require_relative 'base/version'
 
@@ -14,23 +11,64 @@ module Opener
     ##
     # Base NER class that supports various languages such as Dutch and English.
     #
-    # @!attribute [r] args
-    #  @return [Array]
     # @!attribute [r] options
     #  @return [Hash]
     #
+    # @!attribute [r] features
+    #  @return [String]
+    #
+    # @!attribute [r] beamsize
+    #  @return [Fixnum]
+    #
+    # @!attribute [r] dictionaries
+    #  @return [String]
+    #
+    # @!attribute [r] dictionaries_path
+    #  @return [String]
+    #
+    # @!attribute [r] lexer
+    #  @return [Fixnum]
+    #
+    # @!attribute [r] model
+    #  @return [String]
+    #
+    # @!attribute [r] enable_time
+    #  @return [TrueClass|FalseClass]
+    #
     class Base
-      attr_reader :args, :options
+      attr_reader :features, :beamsize, :dictionaries, :dictionaries_path,
+        :lexer, :model, :enable_time
 
       ##
       # @param [Hash] options
       #
-      # @option options [Array] :args The commandline arguments to pass to the
-      #  underlying Java code.
+      # @option options [String] :features The NERC feature to use, defaults to
+      #  "baseline".
+      #
+      # @option options [Fixnum] :beamsize The beam size for decoding, defaults
+      #  to 3.
+      #
+      # @option options [String] :dictionaries The dictionary to use, if any.
+      #
+      # @option options [String] :dictionaries_path The path to the
+      #  dictionaries.
+      #
+      # @option options [Fixnum] :lexer The lexer rules to use for NERC
+      #  tagging.
+      #
+      # @option options [String] :model The model to use for NERC annotation.
+      #
+      # @option options [TrueClass|FalseClass] :enable_time Whether or not to
+      #  enable dynamic timestamps (enabled by default).
       #
       def initialize(options = {})
-        @args    = options.delete(:args) || []
-        @options = options
+        @dictionaries      = options[:dictionaries]
+        @dictionaries_path = options[:dictionaries_path]
+        @features          = options.fetch(:features, 'baseline')
+        @beamsize          = options.fetch(:beamsize, 3)
+        @lexer             = options[:lexer]
+        @model             = options.fetch(:model, 'default')
+        @enable_time       = options.fetch(:enable_time, true)
       end
 
       ##
@@ -41,24 +79,50 @@ module Opener
       # @return [Array]
       #
       def run(input)
-        input     = StringIO.new(input) unless input.kind_of?(IO)
-        annotator = Java::ehu.nerc.Annotate.new(language)
-        reader    = InputStreamReader.new(input.to_inputstream)
-        kaf       = KAFDocument.create_from_stream(reader)
+        lang = language_from_kaf(input)
+        kaf  = new_kaf_document(input)
+        args = [lang, model, features, beamsize]
 
-        kaf.add_linguistic_processor("entities","ehu-nerc-"+language,"now","1.0")
-        annotator.annotateNEsToKAF(kaf)
+        if use_dictionaries?
+          args += [dictionaries, dictionaries_path, lexer]
+        end
+
+        annotator = Java::es.ehu.si.ixa.pipe.nerc.Annotate.new(*args)
+
+        annotator.annotate_kaf(enable_time, kaf)
 
         return kaf.to_string
       end
 
       ##
-      # @return [String]
+      # @param [String] input The input KAF document as a string.
+      # @return [Java::ixa.kaflib.KAFDocument]
+      #
+      def new_kaf_document(input)
+        input_io = StringIO.new(input)
+        reader   = Java::java.io.InputStreamReader.new(input_io.to_inputstream)
+
+        return Java::ixa.kaflib.KAFDocument.create_from_stream(reader)
+      end
+
+      ##
+      # @return [TrueClass|FalseClass]
       #
-      def language
-        return options[:language]
+      def use_dictionaries?
+        return dictionaries || dictionaries_path || features == 'dict'
       end
 
+      ##
+      # Returns the language for the given KAF document.
+      #
+      # @param [String] input
+      # @return [String]
+      #
+      def language_from_kaf(input)
+        document = Nokogiri::XML(input)
+
+        return document.at('KAF').attr('xml:lang')
+      end
     end # Base
   end # Ners
 end # Opener

data/lib/opener/ners/base/version.rb

@@ -1,7 +1,7 @@
 module Opener
   module Ners
     class Base
-      VERSION = '2.0.1'
+      VERSION = '3.0.0'
     end # Base
   end # Ners
 end # Opener

data/opener-ner-base.gemspec

@@ -7,16 +7,20 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Base NER component for languages such as English.'
   gem.description   = gem.summary
   gem.homepage      = 'http://opener-project.github.com/'
+  gem.license       = 'Apache 2.0'
 
   gem.files = Dir.glob([
-    'core/target/ehu-nerc-*.jar',
+    'core/target/ixa-pipe-nerc-*.jar',
     'lib/**/*',
     '*.gemspec',
-    'README.md'
+    'README.md',
+    'LICENSE.txt'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
+  gem.add_dependency 'nokogiri'
+
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'cucumber'
   gem.add_development_dependency 'rake'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: opener-ner-base
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rspec
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,28 +83,20 @@ dependencies:
 description: Base NER component for languages such as English.
 email:
 executables:
-- ner-nl
-- ner-it
-- ner-es
-- ner-en
-- ner-de
-- ner-fr
+- ner-base
 extensions: []
 extra_rdoc_files: []
 files:
-- core/target/ehu-nerc-1.0.jar
+- core/target/ixa-pipe-nerc-1.1.0.jar
 - lib/opener/ners/base.rb
 - lib/opener/ners/base/version.rb
 - opener-ner-base.gemspec
 - README.md
-- bin/ner-nl
-- bin/ner-it
-- bin/ner-es
-- bin/ner-en
-- bin/ner-de
-- bin/ner-fr
+- LICENSE.txt
+- bin/ner-base
 homepage: http://opener-project.github.com/
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message:
 rdoc_options: []

data/bin/ner-en

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/opener/ners/base'
-
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'en')
-input  = STDIN.tty? ? nil : STDIN.read
-
-puts kernel.run(input)

data/bin/ner-es

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/opener/ners/base'
-
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'es')
-input  = STDIN.tty? ? nil : STDIN.read
-
-puts kernel.run(input)

data/bin/ner-fr

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/opener/ners/base'
-
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'fr')
-input  = STDIN.tty? ? nil : STDIN.read
-
-puts kernel.run1(input)

data/bin/ner-it

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/opener/ners/base'
-
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'it')
-input  = STDIN.tty? ? nil : STDIN.read
-
-puts kernel.run(input)

data/bin/ner-nl

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/opener/ners/base'
-
-kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'nl')
-input  = STDIN.tty? ? nil : STDIN.read
-
-puts kernel.run(input)