[
https://issues.apache.org/jira/browse/OPENNLP-1665?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17906043#comment-17906043
]
ASF GitHub Bot commented on OPENNLP-1665:
-----------------------------------------
atarora commented on code in PR #197:
URL: https://github.com/apache/opennlp-sandbox/pull/197#discussion_r1886823882
##########
opennlp-grpc/opennlp-grpc-api/README.md:
##########
@@ -0,0 +1,53 @@
+# Apache OpenNLP gRPC API
+
+This module contains the [gRPC](https://grpc.io) schema used in Apache OpenNLP
to provide a service side gRPC backend.
+
+An automatically generated overview of the endpoints and messages can be found
[here](opennlp)
+
+# Main concepts
+
+The endpoints and messages described by the API are meant to be a minimum.
+It does not support every feature of Apache OpenNLP at the moment, but is open
for enhancement or further improvement.
+
+# Maven dependencies
+
+The Java code generated from the schema is available as a Maven dependency.
+
+```
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.opennlp</groupId>
+ <artifactId>opennlp-grpc-api</artifactId>
+ <version>VERSION</version>
+ </dependency>
+ </dependencies>
+```
+
+# Code generation
+
+The Java code can be (re)generated as follows;
[docker-protoc](https://github.com/namely/docker-protoc) is used to
+generate the code for Java:
+
+```powershell
+docker run -v ${PWD}:/defs namely/protoc-all -f opennlp.proto -l java -o
src/main/java
+```
+
+Since the Java code is provided here and the corresponding JARs will be
available from Maven, regenerating from the
Review Comment:
```suggestion
Since the Java code is provided here and the corresponding JARs will be
available from Maven, regenerating from the schema is not necessary.
```
> gRPC Backend for Multi-Language Support
> ---------------------------------------
>
> Key: OPENNLP-1665
> URL: https://issues.apache.org/jira/browse/OPENNLP-1665
> Project: OpenNLP
> Issue Type: New Feature
> Reporter: Richard Zowalla
> Assignee: Richard Zowalla
> Priority: Major
>
> Taken from the slack discussion. Goal is to broaden the application of
> OpenNLP and usage in different programming language.
> To do so, we can build a component based on gRPC as a module into opennlp
> itself and implement the server side component for the most common tasks (can
> be a growing thing, if community is going to like it) in Java using
> [gRPC|https://grpc.io/] - with the gRPC spec for OpenNLP in place, we can
> simply generate appropriate clients for every supported language (Python, Go,
> etc.) - that would make it easier to maintain since we can just tell the
> people how to generate the client based on the gRPC spec.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
