commit 83a1620a9873697998d9dc8aba5969f15ab0ddcd parent ac0b8a110bebb10a6afe34c5b94e41b243994ff4 Author: Stefan Koch <programming@stefan-koch.name> Date: Sat, 5 Aug 2023 14:19:20 +0200 add a README Diffstat:
| A | README.md | | | 27 | +++++++++++++++++++++++++++ |
1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,27 @@ +NLParrot +======== + +NLParrot is a natural language processing server. It can be used in combination +with other programs that cannot or do not want to load huge ML libraries into +their memory. + +## Run with virtualenv + +```bash +python -m venv venv +source venv/bin/activate +pip install -r requirements.txt +NLPARROT_SOCKET_PATH=/run/nlparrot/nlparrot.sock python src/nlparrot/server.py +``` + +## Run with docker + +You can build a docker image and run NLParrot with docker: + +```bash +docker build -t nlparrot . +docker run --rm --name nlparrot \ + --env NLPARROT_LISTEN_HOST=0.0.0.0 \ + --env NLPARROT_LISTEN_PORT=12345 \ + nlparrot +```