This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-41
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-41 by this push:
new b401869 WIP.
b401869 is described below
commit b401869aaeb11ee07c06a6b271d966b225b69dc5
Author: Aaron Radzinski <[email protected]>
AuthorDate: Fri Aug 28 10:16:21 2020 -0700
WIP.
---
nlpcraft/src/main/python/ctxword/README.md | 11 +++++------
nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md | 2 +-
nlpcraft/src/main/resources/nlpcraft.conf | 2 +-
3 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/nlpcraft/src/main/python/ctxword/README.md
b/nlpcraft/src/main/python/ctxword/README.md
index b49f318..cd9fcf1 100644
--- a/nlpcraft/src/main/python/ctxword/README.md
+++ b/nlpcraft/src/main/python/ctxword/README.md
@@ -30,13 +30,12 @@ models and Facebook's [FastText](https://fasttext.cc/)
library.
### Dependencies
To install necessary dependency:
- * **Linux/MacOS**: run `bin/install_dependencies.sh` script.
+ * **Linux/MacOS**: run `src/main/python/ctxword/bin/install_dependencies.sh`
script.
* **Windows**: read `WINDOWS_SETUP.md` file for manual installation.
### Start REST Server
-To start REST server:
- * **Linux/MacOS**: run `bin/start_server.sh` script.
- * **Windows**: run `bin\start_server.cmd` script.
+To start 'ctxword' module REST server:
+ * Run `src/main/python/ctxword/bin/start_server.{sh|cmd}` script.
NOTE: on the 1st start the server will try to load compressed BERT model which
is not yet available. It will
then download this library and compress it which will take a several minutes
and may require 10 GB+ of
@@ -76,8 +75,8 @@ Here's the sample request and response JSON objects:
* Response JSON:
- `[["word1", "word2", "word3"]]`
-### `bin/suggest.{sh|cmd}`
-You can use Curl-based `bin/suggest.{sh|cmd}` scripts for the suggestion
processing of single sentences from the command line.
+### `suggest.{sh|cmd}`
+You can use Curl-based `src/main/python/ctxword/bin/suggest.{sh|cmd}` scripts
for the suggestion processing of single sentences from the command line.
Following call returns list of contextual suggestions for the 5th word
(counting from zero) in the given sentence:
```
diff --git a/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
b/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
index b5fe102..e5b2985 100644
--- a/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
+++ b/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
@@ -24,7 +24,7 @@
[](https://gitter.im/apache-nlpcraft/community)
### Windows Setup
-To set up `ctxword` module under Windows, you would need to repeat steps from
`bin/install_dependencies.sh` script:
+To set up `ctxword` module under Windows, you would need to repeat steps from
`src/main/python/ctxword/bin/install_dependencies.sh` script:
1. Before starting, make sure you have the following installed:
- `python3`
- `pip3` (included with the latest versions of python3)
diff --git a/nlpcraft/src/main/resources/nlpcraft.conf
b/nlpcraft/src/main/resources/nlpcraft.conf
index 1e6b938..ec96b76 100644
--- a/nlpcraft/src/main/resources/nlpcraft.conf
+++ b/nlpcraft/src/main/resources/nlpcraft.conf
@@ -205,7 +205,7 @@ nlpcraft {
# If Spacy is enabled as a token provider (value 'spacy') - defines
Spacy proxy URL.
# spacy.proxy.url=http://localhost:5002
- # If ContextWord enricher is enabled as a token provider - defines
ctxword-server URL.
+ # 'ctxword' module configuration.
ctxword {
url="http://localhost:5000";
