[ 
https://issues.apache.org/jira/browse/OPENNLP-1665?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17906160#comment-17906160
 ] 

ASF GitHub Bot commented on OPENNLP-1665:
-----------------------------------------

rzo1 commented on code in PR #197:
URL: https://github.com/apache/opennlp-sandbox/pull/197#discussion_r1887360083


##########
opennlp-grpc/README.md:
##########
@@ -0,0 +1,96 @@
+# OpenNLP gRPC - Proof of Concept
+
+This project demonstrates a proof of concept for creating a backend powered by 
Apache OpenNLP using gRPC. It comprises
+three main modules:
+
+- **opennlp-grpc-api**
+- **opennlp-grpc-service**
+- **examples**
+
+## Modules Overview
+
+1. **opennlp-grpc-api**:
+    - Contains the gRPC schema for OpenNLP services.
+    - Includes generated Java stubs.
+    - Provides a README with instructions on generating code stubs for various 
languages and auto-generated
+      documentation.
+
+2. **opennlp-grpc-service**:
+    - Features a server implementation.
+    - Offers an initial service implementation for POS tagging.
+
+3. **examples**:
+    - Provides a sample implementation for interacting with the OpenNLP server 
backend via gRPC in Python.
+
+## Getting Started
+
+Follow these steps to set up and run the OpenNLP gRPC proof of concept project:
+
+### Prerequisites
+Before you begin, ensure you have the following installed on your system:
+
+- Java Development Kit (JDK) 17 or later
+- Apache Maven (for building Java components)
+- Docker for running the gRPC tools if modifications to the .proto files are 
needed
+
+You can build the project by running
+
+```
+mvn clean install
+```
+
+### Running the gRPC Backend
+
+Start the Server: Use the following command to run the server with default 
settings:
+
+```bash
+java -jar target/opennlp-grpc-server-2.5.2-SNAPSHOT.jar
+```
+
+Configure Server Options: 
+
+The server supports several command-line options for customization:
+
+```bash
+-p or --port: Port on which the server will listen (default: 7071).
+-h or --hostname: Hostname to report (default: localhost).

Review Comment:
   Actually, this isn't used (and is a leftover). Will drop.





> 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)

Reply via email to