opener-ner 2.0.0 → 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +125 -13
- data/bin/ner-server +4 -6
- data/lib/opener/ner/version.rb +1 -1
- data/opener-ner.gemspec +1 -0
- metadata +16 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 81a89a206b92a88556d978ef8ad37bb9b6ca03d3
|
4
|
+
data.tar.gz: 801709895c96d74cd75b6f34bcf2f08aa8e7654b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0475803001bf5e36ebb77c2b567d2d11245b098406b8226b5d38a52452266d88cad0f9fa9566f30394428768b0061c0951002b6ea4cab99a9836012b7bc0aa0d
|
7
|
+
data.tar.gz: 38ee582fb0d5ab10c9256a6d4d5ea093da4fb5a749e037fffb0d0804ed545ab4eae317706d43b9ca76c11e9b2f3297eee5109197a8cf816bcc772b4d515a2f4c
|
data/README.md
CHANGED
@@ -4,26 +4,138 @@ This repository contains the source code for the primary NER component of the
|
|
4
4
|
OpeNER project. This component provides a CLI interface for the various kernels
|
5
5
|
as well as providing a Sinatra based web service.
|
6
6
|
|
7
|
-
|
7
|
+
### Confused by some terminology?
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
This software is part of a larger collection of natural language processing
|
10
|
+
tools known as "the OpeNER project". You can find more information about the
|
11
|
+
project at (the OpeNER portal)[http://opener-project.github.io]. There you can
|
12
|
+
also find references to terms like KAF (an XML standard to represent linguistic
|
13
|
+
annotations in texts), component, cores, scenario's and pipelines.
|
11
14
|
|
12
|
-
|
15
|
+
Quick Use Example
|
16
|
+
-----------------
|
13
17
|
|
14
|
-
|
18
|
+
Installing the ner can be done by executing:
|
15
19
|
|
16
20
|
gem install opener-ner
|
17
21
|
|
22
|
+
Please bare in mind that all components in OpeNER take KAF as an input and
|
23
|
+
output KAF by default.
|
18
24
|
|
19
|
-
|
25
|
+
### Command line interface
|
20
26
|
|
21
|
-
|
22
|
-
|
23
|
-
:branch => 'master'
|
27
|
+
You should now be able to call the NER as a regular shell
|
28
|
+
command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
|
24
29
|
|
25
|
-
|
30
|
+
This aplication reads a text from standard input in order to identify the language.
|
31
|
+
|
32
|
+
cat some_kind_of_kaf_file.kaf | ner
|
33
|
+
|
34
|
+
|
35
|
+
This will output a kaf file containing the named entities. An excerpt can be
|
36
|
+
seen here
|
37
|
+
|
38
|
+
```
|
39
|
+
<entity eid="e3" type="organization">
|
40
|
+
<references>
|
41
|
+
<!--North Yorkshire Police-->
|
42
|
+
<span>
|
43
|
+
<target id="t17" />
|
44
|
+
<target id="t18" />
|
45
|
+
<target id="t19" />
|
46
|
+
</span>
|
47
|
+
</references>
|
48
|
+
</entity>
|
49
|
+
```
|
50
|
+
|
51
|
+
### Webservices
|
52
|
+
|
53
|
+
You can launch a language identification webservice by executing:
|
54
|
+
|
55
|
+
ner-server
|
56
|
+
|
57
|
+
This will launch a mini webserver with the webservice. It defaults to port 9292,
|
58
|
+
so you can access it at <http://localhost:9292>.
|
59
|
+
|
60
|
+
To launch it on a different port provide the `-p [port-number]` option like
|
61
|
+
this:
|
62
|
+
|
63
|
+
ner-server -p 1234
|
64
|
+
|
65
|
+
It then launches at <http://localhost:1234>
|
66
|
+
|
67
|
+
Documentation on the Webservice is provided by surfing to the urls provided
|
68
|
+
above. For more information on how to launch a webservice run the command with
|
69
|
+
the ```-h``` option.
|
70
|
+
|
71
|
+
|
72
|
+
### Daemon
|
73
|
+
|
74
|
+
Last but not least the NER comes shipped with a daemon that
|
75
|
+
can read jobs (and write) jobs to and from Amazon SQS queues. For more
|
76
|
+
information type:
|
77
|
+
|
78
|
+
ner-daemon -h
|
79
|
+
|
80
|
+
|
81
|
+
Description of dependencies
|
82
|
+
---------------------------
|
83
|
+
|
84
|
+
This component runs best if you run it in an environment suited for OpeNER
|
85
|
+
components. You can find an installation guide and helper tools in the (OpeNER
|
86
|
+
installer)[https://github.com/opener-project/opener-installer] and (an
|
87
|
+
installation guide on the Opener
|
88
|
+
Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
|
89
|
+
|
90
|
+
At least you need the following system setup:
|
91
|
+
|
92
|
+
### Depenencies for normal use:
|
93
|
+
|
94
|
+
* MRI 1.9.3 / Jruby
|
95
|
+
* Java 1.7 or newer (There are problems with encoding in older versions).
|
96
|
+
|
97
|
+
### Dependencies if you want to modify the component:
|
98
|
+
|
99
|
+
* Maven (for building the Gem)
|
100
|
+
|
101
|
+
Domain Adaption
|
102
|
+
---------------
|
103
|
+
|
104
|
+
TODO
|
105
|
+
|
106
|
+
Language Extension
|
107
|
+
------------------
|
108
|
+
|
109
|
+
TODO
|
110
|
+
|
111
|
+
The Core
|
112
|
+
--------
|
113
|
+
|
114
|
+
The component is a fat wrapper around the actual language technology core. You
|
115
|
+
can find the core technolies in the following repositories:
|
116
|
+
|
117
|
+
* (ner-base)[https://github.com/opener-project/ner-base]
|
118
|
+
|
119
|
+
|
120
|
+
Where to go from here
|
121
|
+
---------------------
|
122
|
+
|
123
|
+
* Check (the project websitere)[http://opener-project.github.io]
|
124
|
+
* (Checkout the webservice)[http://opener.olery.com/ner]
|
125
|
+
|
126
|
+
Report problem/Get help
|
127
|
+
-----------------------
|
128
|
+
|
129
|
+
If you encounter problems, please email support@opener-project.eu or leave an
|
130
|
+
issue in the (issue tracker)[https://github.com/opener-project/ner/issues].
|
131
|
+
|
132
|
+
|
133
|
+
Contributing
|
134
|
+
------------
|
135
|
+
|
136
|
+
1. Fork it ( http://github.com/opener-project/ner/fork )
|
137
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
138
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
139
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
140
|
+
5. Create new Pull Request
|
26
141
|
|
27
|
-
gem install specific_install
|
28
|
-
gem specific_install opener-ner \
|
29
|
-
-l https://github.com/opener-project/ner.git
|
data/bin/ner-server
CHANGED
@@ -1,10 +1,8 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
|
3
|
-
require '
|
3
|
+
require 'puma/cli'
|
4
4
|
|
5
|
-
|
6
|
-
# be passed, thus the application can't be specified as a constructor argument.
|
7
|
-
server = Rack::Server.new
|
8
|
-
server.options[:config] = File.expand_path('../../config.ru', __FILE__)
|
5
|
+
rack_config = File.expand_path('../../config.ru', __FILE__)
|
9
6
|
|
10
|
-
|
7
|
+
cli = Puma::CLI.new([rack_config] + ARGV)
|
8
|
+
cli.run
|
data/lib/opener/ner/version.rb
CHANGED
data/opener-ner.gemspec
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: opener-ner
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- development@olery.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-05-
|
11
|
+
date: 2014-05-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: sinatra
|
@@ -52,6 +52,20 @@ dependencies:
|
|
52
52
|
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: puma
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
55
69
|
- !ruby/object:Gem::Dependency
|
56
70
|
name: opener-ner-base
|
57
71
|
requirement: !ruby/object:Gem::Requirement
|