stanford-core-nlp 0.5.0 → 0.5.1

data/README.md

@@ -8,7 +8,7 @@ This gem is compatible with Ruby 1.9.2 and 1.9.3 as well as JRuby 1.7.1. It is t
 
 **Installing**
 
-First, install the gem: `gem install stanford-core-nlp`. Then, download the Stanford Core NLP JAR and model files. Three different packages are available:
+First, install the gem: `gem install stanford-core-nlp`. Then, download the Stanford Core NLP JAR and model files. Two packages are available:
 
 * A [minimal package](http://louismullie.com/treat/stanford-core-nlp-minimal.zip) with the default tagger and parser models for English, French and German.
 * A [full package](http://louismullie.com/treat/stanford-core-nlp-full.zip), with all of the tagger and parser models for English, French and German, as well as named entity and coreference resolution models for English.
@@ -17,7 +17,7 @@ Place the contents of the extracted archive inside the /bin/ folder of the stanf
 
 **Configuration**
 
-After installing and requiring the gem (`require 'stanford-core-nlp'`), you may want to set some optional configuration options. Here are some examples:
+You may want to set some optional configuration options. Here are some examples:
 
 ```ruby
 # Set an alternative path to look for the JAR files
@@ -36,9 +36,6 @@ StanfordCoreNLP.jvm_args = ['-option1', '-option2']
 # Redirect VM output to log.txt
 StanfordCoreNLP.log_file = 'log.txt'
 
-# Use the model files for a different language than English.
-StanfordCoreNLP.use(:french) # or :german
-
 # Change a specific model file.
 StanfordCoreNLP.set_model('pos.model', 'english-left3words-distsim.tagger')
 ```
@@ -46,6 +43,9 @@ StanfordCoreNLP.set_model('pos.model', 'english-left3words-distsim.tagger')
 **Using the gem**
 
 ```ruby
+# Use the model files for a different language than English.
+StanfordCoreNLP.use :french # or :german
+
 text = 'Angela Merkel met Nicolas Sarkozy on January 25th in ' +
    'Berlin to discuss a new austerity package. Sarkozy ' +
    'looked pleased, but Merkel was dismayed.'
@@ -71,18 +71,22 @@ text.get(:sentences).each do |sentence|
     puts token.get(:named_entity_tag).to_s
     # Coreference
     puts token.get(:coref_cluster_id).to_s
-    # Also of interest: coref, coref_chain, coref_cluster, coref_dest, coref_graph.
+    # Also of interest: coref, coref_chain, 
+    # coref_cluster, coref_dest, coref_graph.
   end
 end
 ```
 
 > Important: You need to load the StanfordCoreNLP pipeline before using the StanfordCoreNLP::Annotation class.
 
-A good reference for names of annotations are the Stanford Javadocs for [CoreAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/ling/CoreAnnotations.html), [CoreCorefAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/dcoref/CorefCoreAnnotations.html), and [TreeCoreAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/trees/TreeCoreAnnotations.html). For a full list of all possible annotations, see the 'config.rb' file inside the gem. The Ruby symbol (e.g. `:named_entity_tag`) corresponding to a Java annotation class follows the simple un-camel-casing convention, with 'Annotation' at the end removed. For example, the annotation `NamedEntityTagAnnotation` translates to `:named_entity_tag`, `PartOfSpeechAnnotation` to `:part_of_speech`, etc.
+The Ruby symbol (e.g. `:named_entity_tag`) corresponding to a Java annotation class is the `snake_case` of the class name, with 'Annotation' at the end removed. For example, `NamedEntityTagAnnotation` translates to `:named_entity_tag`, `PartOfSpeechAnnotation` to `:part_of_speech`, etc.
+
+A good reference for names of annotations are the Stanford Javadocs for [CoreAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/ling/CoreAnnotations.html), [CoreCorefAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/dcoref/CorefCoreAnnotations.html), and [TreeCoreAnnotations](http://nlp.stanford.edu/nlp/javadoc/javanlp/edu/stanford/nlp/trees/TreeCoreAnnotations.html). For a full list of all possible annotations, see the `config.rb` file inside the gem. 
+
 
 **Loading specific classes**
 
-You may also want to load your own classes from the Stanford NLP to do more specific tasks. The gem provides an API to do this:
+You may want to load additional Java classes (including any class from the Stanford NLP packages). The gem provides an API for this:
 
 ```ruby
 # Default base class is edu.stanford.nlp.pipeline.
@@ -120,9 +124,7 @@ Here is a full list of annotator classes provided by the Stanford Core NLP packa
 Here is a full list of the default models for the Stanford Core NLP pipeline. You can change these models individually using `StanfordCoreNLP.set_model` (see above).
 
 * 'pos.model' - 'english-left3words-distsim.tagger'
-* 'ner.model.3class' - 'all.3class.distsim.crf.ser.gz'
-* 'ner.model.7class' - 'muc.7class.distsim.crf.ser.gz'
-* 'ner.model.MISCclass' -- 'conll.4class.distsim.crf.ser.gz'
+* 'ner.model' - 'all.3class.distsim.crf.ser.gz'
 * 'parse.model' - 'englishPCFG.ser.gz'
 * 'dcoref.demonym' - 'demonyms.txt'
 * 'dcoref.animate' - 'animate.unigrams.txt'
@@ -137,4 +139,7 @@ Here is a full list of the default models for the Stanford Core NLP pipeline. Yo
 
 **Contributing**
 
-Feel free to fork the project and send me a pull request!
+Simple.
+
+1. Fork the project.
+2. Send me a pull request!

data/lib/stanford-core-nlp.rb

@@ -2,7 +2,7 @@ require 'stanford-core-nlp/config'
 
 module StanfordCoreNLP
 
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 
   require 'bind-it'
   extend BindIt::Binding
@@ -44,6 +44,8 @@ module StanfordCoreNLP
     ['CoreLabel', 'edu.stanford.nlp.ling'],
     ['MaxentTagger', 'edu.stanford.nlp.tagger.maxent'],
     ['CRFClassifier', 'edu.stanford.nlp.ie.crf'],
+    ['LexicalizedParser', 'edu.stanford.nlp.parser.lexparser'],
+    ['Options', 'edu.stanford.nlp.parser.lexparser'],
     ['Properties', 'java.util'],
     ['ArrayList', 'java.util'],
     ['AnnotationBridge', '']
@@ -111,11 +113,8 @@ module StanfordCoreNLP
   #    Public API methods       #
   # ########################### #
 
-  # Load a StanfordCoreNLP pipeline with the
-  # specified JVM flags and StanfordCoreNLP
-  # properties.
-  def self.load(*annotators)
-
+  def self.bind
+    
     # Take care of Windows users.
     if self.running_on_windows?
       self.jar_path.gsub!('/', '\\')
@@ -123,14 +122,23 @@ module StanfordCoreNLP
     end
 
     # Make the bindings.
-    self.bind
+    super
 
     # Bind annotation bridge.
     self.default_classes.each do |info|
       klass = const_get(info.first)
       self.inject_get_method(klass)
     end
-
+  
+  end
+  
+  # Load a StanfordCoreNLP pipeline with the
+  # specified JVM flags and StanfordCoreNLP
+  # properties.
+  def self.load(*annotators)
+    
+    self.bind unless self.bound
+    
     # Prepend the JAR path to the model files.
     properties = {}
     self.model_files.each do |k,v|

metadata

@@ -1,87 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: stanford-core-nlp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.5.1
+  prerelease:
 platform: ruby
 authors:
 - Louis Mullie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bind-it
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.5
+    none: false
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! " High-level Ruby bindings to the Stanford CoreNLP package, a set natural
-  language processing \ntools that provides tokenization, part-of-speech tagging and
-  parsing for several languages, as well as named entity \nrecognition and coreference
-  resolution for English. "
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: " High-level Ruby bindings to the Stanford CoreNLP package, a set natural\
+  \ language processing \ntools that provides tokenization, part-of-speech tagging\
+  \ and parsing for several languages, as well as named entity \nrecognition and coreference\
+  \ resolution for English. "
 email:
 - louis.mullie@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/stanford-core-nlp.rb
 - lib/stanford-core-nlp/bridge.rb
 - lib/stanford-core-nlp/config.rb
-- lib/stanford-core-nlp.rb
 - bin/AnnotationBridge.java
 - bin/bridge.jar
 - README.md
 - LICENSE
 homepage: https://github.com/louismullie/stanford-core-nlp
 licenses: []
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: !binary |-
+        MA==
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
 summary: Ruby bindings to the Stanford Core NLP tools.
 test_files: []