Commits

dustin smith  committed b95e4ac

readme

  • Participants
  • Parent commits 65ca4bd

Comments (0)

Files changed (1)

 # Python interface to Stanford Core NLP tools
 
-This a Python wrapper for Stanford NLP group's Java-based [CoreNLP tools](http://nlp.stanford.edu/software/corenlp.shtml).  It can either be imported as a module or run as a server. Because it uses many large trained models (3GB Ram), this is probably best run as a server.
+This a Python wrapper for Stanford University's NLP group's Java-based [CoreNLP tools](http://nlp.stanford.edu/software/corenlp.shtml).  It can either be imported as a module or run as an JSON-RPC server. Because it uses many large trained models (requiring 3GB RAM and usually a few minutes loading time), most applications will probably want to run it as a server.
 
-This uses [SimpleJSONRPCServer](http://www.freenet.org.nz/dojo/pyjson/) and [python-progressbar](http://code.google.com/p/python-progressbar/)
+This uses [jsonrpc](http://www.simple-is-better.org/rpc/) and [python-progressbar](http://code.google.com/p/python-progressbar/)
+
+
+## Download and Usage 
+
+You should have [downloaded](http://nlp.stanford.edu/software/corenlp.shtml#Download) and unpacked the tgz file.  Then copy all of the python files from this repository into the `stanford-corenlp-2010-11-12` folder.
+
+Then, to launch a server:
+
+    python server.py
+
+Optionally, specify a host or port:
+
+    python server.py -H 0.0.0.0 -p 3456
+
+To run a public JSON-RPC server on port 3456.
+
+See `client.py` for example of how to connect with a client.
+
+## Questions 
+
+I have only tested this on **version 1.0.2** released 2010-11-12.
+
+If you think there may be a problem with this wrapper, first make sure can run the java program:
 
     java -cp stanford-corenlp-2010-11-12.jar:stanford-corenlp-models-2010-11-06.jar:xom-1.2.6.jar:xom.jar:jgraph.jar:jgrapht.jar -Xmx3g edu.stanford.nlp.pipeline.StanfordCoreNLP