opener-coreference 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee05da1ff5a222b40be551446c926533db97d26e
-  data.tar.gz: 527b3e3e9e00e4fc6b3e25ab4730dfe6e1a350fc
+  metadata.gz: d8914b858b1e940818f49580d9549a56d2fb5038
+  data.tar.gz: 591861395373ccd5c8c89fe60987f1e39e590d37
 SHA512:
-  metadata.gz: 6e81370c6d5fce240446d7850cadba70263d9bda5a6b5d37082ad48fd35a194563ba35c66f6423a02475f9086f365ae4ec6ac707df37422979a30922b58eef45
-  data.tar.gz: 13a70c127790d1b267e234e0df65772086b6d931852f764f05169454462efe6f44d7367ebae4327833d69fde50b84193f69533fbdd3f82a6ee8e5c03dfe5dfb3
+  metadata.gz: 057324123c05acbae7df72fccf790b89d9ca771ac5a777b1903434d8228fab7ac25f1d6bdb40b1b5e82d6745040d669154be89e330ee23b1425fd47343e07f22
+  data.tar.gz: f2d93404190aa2ab147025610bc5c964212f9090887f586498a8776d09880340b01d5828fc8be3b288732bc946b71277519bda514be736d56d2e542afe595244

data/README.md

@@ -1,28 +1,166 @@
-# Opener::Coreference
+Coreference
+-----------
 
-TODO: Write a gem description
+This Gem provides coreference resolution for various languages (en, es, it, nl, de, fr).
 
-## Installation
+The CorefGraph-en module provides an implementation of the Multi-Sieve Pass system for for Coreference Resolution system originally proposed by the Stanford NLP Group (Raghunathan et al., 2010; Lee et al., 2011) and (Lee et al., 2013). This system proposes a number of deterministic passes, ranging from high precision to higher recall, each dealing with a different manner in which coreference manifests itself in running text.
 
-Add this line to your application's Gemfile:
+Although more sieves are available, in order to facilitate the integration of the coreference system for the 6 languages of OpeNER we have included here 4 sieves: Exact String Matching, Precise Constructs, Strict Head Match and Pronoun Match (the sieve nomenclature follows Lee et al (2013)). Furthermore, as it has been reported, this sieves are responsible for most of the performance in the Stanford system.
 
-    gem 'opener-coreference'
+The implementation is a result of a collaboration between the IXA NLP (http://ixa.si.ehu.es) and LinguaMedia Groups (http://linguamedia.deusto.es).
 
-And then execute:
+### Confused by some terminology?
 
-    $ bundle
+This software is part of a larger collection of natural language processing
+tools known as "the OpeNER project". You can find more information about the
+project at (the OpeNER portal)[http://opener-project.github.io]. There you can
+also find references to terms like KAF (an XML standard to represent linguistic
+annotations in texts), component, cores, scenario's and pipelines.
 
-Or install it yourself as:
+Quick Use Example
+-----------------
 
-    $ gem install opener-coreference
+Installing the coreference can be done by executing:
 
-## Usage
+    gem install opener-coreference
 
-TODO: Write usage instructions here
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
-## Contributing
+### Command line interface
 
-1. Fork it
+You should now be able to call the coreference as a regular shell
+command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
+
+This aplication reads a text from standard input in order to identify the language.
+
+    cat some_kind_of_kaf_file.kaf | coreference
+
+This will output:
+
+```xml
+<coref coid="co5">
+  <!--Her father-->
+  <span>
+    <target id="t45"/>
+    <target id="t46"/>
+  </span>
+  <!--him-->
+  <span>
+    <target id="t58"/>
+  </span>
+  <!--his-->
+  <span>
+    <target id="t54"/>
+  </span>
+</coref>
+```
+
+### Webservices
+
+You can launch a language identification webservice by executing:
+
+    coreference-server
+
+This will launch a mini webserver with the webservice. It defaults to port 9292,
+so you can access it at <http://localhost:9292>.
+
+To launch it on a different port provide the `-p [port-number]` option like
+this:
+
+    coreference-server -p 1234
+
+It then launches at <http://localhost:1234>
+
+Documentation on the Webservice is provided by surfing to the urls provided
+above. For more information on how to launch a webservice run the command with
+the ```-h``` option.
+
+
+### Daemon
+
+Last but not least the coreference comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
+
+    coreference-daemon -h
+
+
+Description of dependencies
+---------------------------
+
+This component runs best if you run it in an environment suited for OpeNER
+components. You can find an installation guide and helper tools in the (OpeNER
+installer)[https://github.com/opener-project/opener-installer] and (an
+installation guide on the Opener
+Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
+
+At least you need the following system setup:
+
+### Depenencies for normal use:
+
+* Ruby (MRI) 1.9.3 or newer
+* Python 2.6
+
+Adapting CorefGraph-en to your language
+---------------------------------------
+
+There are a number of changes needed to be made to make CorefGraph works for
+other languages. Although we have try to keep the language dependent features
+to a minimum, you will still need to create some dictionaries for your own
+language and make some very minor changes in the code. Here is the list of very
+file in the Corefgraph module that needs to be changed.  Every change except
+one (see below) to be done in the **$project/core/corefgraph/resources** directory:
+
+* dictionaries/$lang\_determiners.py
+* dictionaries/$lang\_pronouns.py
+* dictionaries/$lang\_verbs.py
+* dictionaries/$lang\_stopwords.py
+* dictionaries/$lang\_temporals.py
+
+* tagset/$TAGSETNAME\_pos.py
+* tagset/$TAGSETNAME\_constituent.py
+
+* files/animate/$lang.animate.txt
+* files/animate/$lang.inanimate.txt
+
+* files/demonym/$lang.txt
+
+* files/gender/$lang.male.unigrams.txt
+* files/gender/$lang.female.unigrams.txt
+* files/gender/$lang.neutral.unigrams.txt
+* files/gender/$lang.namegender.combine.txt
+* files/gender/$lang.gender.data
+
+* files/number/$lang.plural.unigrams.txt
+* files/number/$lang.singular.unigrams.txt
+
+
+The Core
+--------
+
+The component is a fat wrapper around the actual language technology core. You
+can find the core technolies in the following repositories:
+
+* (Coreference-base)[https://github.com/opener-project/coreference-base]
+
+Where to go from here
+---------------------
+
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/coreference]
+
+Report problem/Get help
+-----------------------
+
+If you encounter problems, please email support@opener-project.eu or leave an
+issue in the (issue tracker)[https://github.com/opener-project/coreference/issues].
+
+
+Contributing
+------------
+
+1. Fork it ( http://github.com/opener-project/coreference/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/opener/coreference/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Coreference
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/opener-coreference.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'sinatra', '~> 1.4'
   gem.add_dependency 'httpclient'
+  gem.add_dependency 'nokogiri'
   gem.add_dependency 'opener-coreference-base'
   gem.add_dependency 'opener-webservice'
 

metadata

@@ -1,87 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: opener-coreference
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: httpclient
+  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'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-coreference-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-coreference-base
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-webservice
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rake
   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: :development
 description: Gem that wraps the coreference code
-email: 
+email:
 executables:
 - coreference
 - coreference-server
@@ -99,27 +113,27 @@ files:
 - lib/opener/coreference/version.rb
 - lib/opener/coreference/views/index.erb
 - opener-coreference.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.2.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem that wraps the coreference code
 test_files: []