Skip to content

Commit 62efcc0

Browse files
committed
Updated the README file.
1 parent 9e93057 commit 62efcc0

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

README.md

+23-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Python JSON-NLP Module
22

3-
(C) 2019 by [Damir Cavar], [Oren Baldinger], [Maanvitha Gongalla], [Anurag Kumar], Murali Kammili
3+
(C) 2020 by [Semiring Inc.]
4+
5+
Contributions from [Damir Cavar], [Oren Baldinger], [Maanvitha Gongalla], [Anurag Kumar], Murali Kammili, and others during 2019.
6+
7+
Brought to you by the [NLP-Lab.org]. New Maintainer since 2020 is [Semiring Inc.].
8+
9+
This new version now is 0.6 and it is no longer compatible with version 0.2.33. If you use the old JSON-NLP standard in your code, make sure you require version 0.2.33 of *pyjsonnlp*. This new version is compatible with the newest version of [Go JSON-NLP].
410

5-
Brought to you by the [NLP-Lab.org]!
611

712

813
## Introduction
914

1015
There is a growing number of Natural Language Processing (NLP) tools, modules, pipelines. There does not seem to be any standard for the output format. Here we are focusing on a standard for the output format syntax. Some future version of [JSON-NLP] might address the output semantics as well.
1116

12-
[JSON-NLP] is a standard for the most important outputs NLP pipelines and components can generate. The relevant documentation can be found in the [JSON-NLP] GitHub repo and on its website at the [NLP-Lab].
13-
17+
[JSON-NLP] is a standard for the most important outputs NLP pipelines and components can generate. The relevant documentation can be found in the [JSON-NLP] GitHub repo and on its website at the [NLP-Lab] and [Semiring Inc.].
1418

1519
The Python [JSON-NLP] module contains general mapping functions for [JSON-NLP] to [CoNLL-U], a validator for the generated output, an NLP pipeline interface (for [Flair], [spaCy], [NLTK], [Polyglot], [Xrenner], etc.), and various utility functions.
1620

@@ -29,14 +33,17 @@ To install this package, run the following command:
2933

3034
You might have to use *pip3* on some systems.
3135

36+
3237
## Validation
3338

34-
[JSON-NLP] is based on a schema, built by [NLP-Lab.org], to comprehensively and concisely represent linguistic annotations.
39+
[JSON-NLP] is based on a schema, maintained by [NLP-Lab.org] and [Semiring Inc.], to comprehensively and concisely represent linguistic annotations.
40+
3541
We provide a validator to help ensure that generated JSON validates against the schema:
3642

3743
result = MyPipeline().proces(text="I am a sentence")
3844
assert pyjsonnlp.validation.is_valid(result)
3945

46+
4047
## Conversion
4148

4249
To enable interoperability with other annotation formats, we support conversions between them.
@@ -48,7 +55,8 @@ Currently we have a [CoNLL-U] to [JSON-NLP] converter, that covers most annotati
4855
To convert the other direction:
4956

5057
pyjsonnlp.conversion.to_conllu(jsonnlp)
51-
58+
59+
5260
## Pipeline
5361

5462
[JSON-NLP] provides a simple `Pipeline` interface that should be implemented for embedding into a microservice:
@@ -68,10 +76,11 @@ deployed `Pipeline` via the `RemotePipeline` class:
6876

6977
pipeline = pyjsonnlp.pipeline.RemotePipeline('localhost', port=9000)
7078
print(pipeline.process(text='I am a sentence', dependencies=True, something='else'), spacing=2)
71-
79+
80+
7281
## Microservice
7382

74-
The next step is the [JSON-NLP] a Microservice class, with a pre-built implementation of [Flask].
83+
The [JSON-NLP] as a Microservice class is only available in older versions of this module. Version 0.2.x is implemented as a Microsorvice with a pre-built implementation of [Flask].
7584

7685
from pyjsonnlp.microservices.flask_server import FlaskMicroservice
7786

@@ -108,17 +117,21 @@ Other parameters specific to your pipeline implementation can be passed as well:
108117

109118
http://localhost:5000?lang=en&constituents=0&text=I am a sentence.
110119

120+
The current version 0.6 or newer does not support the [Flask]-based RESTful Microservice infrastructure. It is a pure [JSON-NLP] data structure, processor and converter.
121+
111122

112123

113-
[Damir Cavar]: http://damir.cavar.me/ "Damir Cavar"
124+
[Damir Cavar]: https://www.linkedin.com/in/damircavar/ "Damir Cavar"
114125
[Oren Baldinger]: https://oren.baldinger.me/ "Oren Baldinger"
115126
[Anurag Kumar]: https://github.com/anuragkumar95/ "Anurag Kumar"
116127
[Maanvitha Gongalla]: https://maanvithag.github.io/MaanvithaGongalla/
117128
[NLP-Lab.org]: http://nlp-lab.org/ "NLP-Lab.org"
118-
[JSON-NLP]: https://github.com/dcavar/JSON-NLP "JSON-NLP"
129+
[JSON-NLP]: https://github.com/SemiringInc/JSON-NLP "JSON-NLP"
119130
[Flair]: https://github.com/zalandoresearch/flair "Flair"
120131
[spaCy]: https://spacy.io/ "spaCy"
121132
[NLTK]: http://nltk.org/ "Natural Language Processing Toolkit"
122133
[Polyglot]: https://github.com/aboSamoor/polyglot "Polyglot"
123134
[Xrenner]: https://github.com/amir-zeldes/xrenner "Xrenner"
124135
[CoNLL-U]: https://universaldependencies.org/format.html "CoNNL-U"
136+
[Semiring Inc.]: https://semiring.com/ "Semiring Inc."
137+
[Go JSON-NLP]: https://github.com/SemiringInc/GoJSONNLP "Go JSON-NLP"

pyjsonnlp/pipeline.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
(C) 2019 Damir Cavar, Oren Baldinger, Maanvitha Gongalla, Anurag Kumar, Murali Kammili
2+
(C) 2019-2020 Damir Cavar, Oren Baldinger, Maanvitha Gongalla, Anurag Kumar, Murali Kammili
33
44
Interface for the NLP pipelines.
55
Licensed under the Apache License 2.0, see the file LICENSE for more details.

0 commit comments

Comments
 (0)