You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2021/01/12 21:59:29 UTC
[incubator-nlpcraft] branch master updated: Fixes for readme files.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/master by this push:
new 8beb699 Fixes for readme files.
8beb699 is described below
commit 8beb6996bdd597fa8c3846d02761fb992afea7e6
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Tue Jan 12 13:59:18 2021 -0800
Fixes for readme files.
---
README.md | 2 +-
nlpcraft/src/main/python/ctxword/README.md | 2 +-
nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md | 2 +-
nlpcraft/src/main/python/ctxword/jupyter/README.md | 2 +-
.../scala/org/apache/nlpcraft/examples/README.md | 2 +-
.../org/apache/nlpcraft/examples/echo/README.md | 24 ++-----------------
.../apache/nlpcraft/examples/helloworld/README.md | 22 ++----------------
.../org/apache/nlpcraft/examples/phone/README.md | 23 +-----------------
.../org/apache/nlpcraft/examples/sql/README.md | 27 ++--------------------
.../org/apache/nlpcraft/examples/time/README.md | 20 +---------------
.../org/apache/nlpcraft/examples/weather/README.md | 24 +++----------------
11 files changed, 16 insertions(+), 134 deletions(-)
diff --git a/README.md b/README.md
index 0027200..18756c8 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
diff --git a/nlpcraft/src/main/python/ctxword/README.md b/nlpcraft/src/main/python/ctxword/README.md
index eb65781..ce83716 100644
--- a/nlpcraft/src/main/python/ctxword/README.md
+++ b/nlpcraft/src/main/python/ctxword/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
diff --git a/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md b/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
index 5ee86bc..8eea91b 100644
--- a/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
+++ b/nlpcraft/src/main/python/ctxword/WINDOWS_SETUP.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
diff --git a/nlpcraft/src/main/python/ctxword/jupyter/README.md b/nlpcraft/src/main/python/ctxword/jupyter/README.md
index c511b0b..d6bb471 100644
--- a/nlpcraft/src/main/python/ctxword/jupyter/README.md
+++ b/nlpcraft/src/main/python/ctxword/jupyter/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/README.md
index edf6f64..cc03d61 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/echo/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/echo/README.md
index 82ca670..a707ae5 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/echo/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/echo/README.md
@@ -19,36 +19,16 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
### Echo Example
-This is a Scala example.
-
-For any user input this example model returns JSON representation of the query
+For any user input this Scala-based example model returns JSON representation of the query
context corresponding to that input. This is a simple demonstration of the
JSON output and of most of the NLPCraft-provided data that a user defined model
can operate on. This example can be useful during the development to see what
object properties are available.
-
-### Running
-You can run necessary JVMs for this example the same way from either the command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **Program arguments:** `-server`
- * Test using built-in model auto-validator:
- * **Main class:** `org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:** `-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.echo.EchoModel`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * Run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.echo.EchoModel"`
- * **Program arguments:** `-probe`
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/helloworld/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/helloworld/README.md
index 8f998cf..ad9b94d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/helloworld/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/helloworld/README.md
@@ -19,31 +19,13 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
### HelloWorld Example
This trivial example simply responds with 'Hello World!' on any user input.
-This is the simplest and shortest user model that can be defined.
-
-### Running
-You can run necessary JVMs for this example the same way from either the command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **Program arguments:** `-server`
- * Test using built-in model auto-validator:
- * **Main class:** `org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:** `-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.helloworld.HelloWorldModel`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * Run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.helloworld.HelloWorldModel"`
- * **Program arguments:** `-probe`
+This is the simplest user model that can be defined.
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/phone/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/phone/README.md
index 4058d45..f36394f 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/phone/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/phone/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
@@ -28,27 +28,6 @@ This example simulates voice phone dialing a-la Siri or Google Assistant.
It doesn't actually do a phone dialing, but it recognizes the recipient and returns it back. You
can easily add access to the contact database and issue the call via many existing REST services.
-### Running
-You can run necessary JVMs for this example the same way from either the command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:**
- * `CONFIG_FORCE_nlpcraft_server_tokenProviders="nlpcraft, google"`
- * **Program arguments:** `-server`
- * Test using built-in model auto-validator:
- * **Main class:** `org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:** `-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.phone.PhoneModel`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * Run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.phone.PhoneModel"`
- * **Program arguments:** `-probe`
-
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
See also [Integrations](https://nlpcraft.apache.org/integrations.html) section on how to configure 3rd party token providers.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/sql/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/sql/README.md
index 5caaa79..3be2d31 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/sql/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/sql/README.md
@@ -19,7 +19,7 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
@@ -27,32 +27,9 @@
This example demonstrates the relatively complex case of taking an existing SQL schema and developing
a natural language interface to it. Although it does not support many standard SQL capabilities (to limit the size of the
example itself) - it is designed in a such a way that it can be easily extended and developed further.
-
-### Running
-This example can be run the same way as other examples with one exception - it needs to run H2 database server.
-The unit test for this example runs H2 database server automatically (which can be run manually, if necessary).
-You need to start H2 database server standalone when you are using `NCSqlModelGenerator` model generation utility.
-You can run necessary JVMs for this example similarly from command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **Program arguments:** `-server`
- * Test using built-in test framework:
- * **JUnit class:** `org.apache.nlpcraft.examples.sql.NCSqlExampleTest`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * To run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.sql.SqlModel"`
- * **Program arguments:** `-probe`
-
- When running data probe standalone you need run H2 database sever manually (from command line or IDE):
- * **Main class:** `org.apache.nlpcraft.examples.sql.db.SqlServerRunner`
### Documentation
-See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
+See [SQL Model](http://nlpcraft.apache.org/examples/sql_model.html) guide for more instructions on how to run this example.
For any questions, feedback or suggestions:
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/time/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/time/README.md
index 451e87b..501ca68 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/time/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/time/README.md
@@ -19,31 +19,13 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
### Time Example
This example data model answers the questions about current time, either local to the caller or at some city.
It provides YAML response with time and timezone information and uses YAML model definition.
-
-### Running
-You can run necessary JVMs for this example the same way from either the command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **Program arguments:** `-server`
- * Test using built-in model auto-validator:
- * **Main class:** `org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:** `-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.time.TimeModel`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * Run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.time.TimeModel"`
- * **Program arguments:** `-probe`
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/weather/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/weather/README.md
index a8a0907..e3aec8c 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/weather/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/weather/README.md
@@ -19,35 +19,17 @@
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
-[](https://github.com/apache/incubator-nlpcraft/actions)
+[](https://github.com/apache/incubator-nlpcraft/actions)
[](https://nlpcraft.apache.org/docs.html)
[](https://gitter.im/apache-nlpcraft/community)
### Weather Service Example
This example demonstrates relatively complete NLI-based weather service with JSON output and a non-trivial
-intent matching logic. It uses https://www.apixu.com REST service for the actual
+intent matching logic. It uses Apple's [Dark Sky](https://darksky.net) API weather provider REST service for the actual
weather information.
-### Running
-You can run necessary JVMs for this example the same way from either the command line or IDE.
-Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the
-embedded probe and starts it automatically:
- * Run REST server:
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **Program arguments:** `-server`
- * Test using built-in model auto-validator:
- * **Main class:** `org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:** `-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.weather.WeatherModel`
-
-If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:
- * Run probe standalone and use your own [REST client](https://nlpcraft.apache.org/using-rest.html):
- * **Main class:** `org.apache.nlpcraft.NCStart`
- * **VM arguments:** `-Dconfig.override_with_env_vars=true`
- * **Environment variables:** `CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.weather.WeatherModel"`
- * **Program arguments:** `-probe`
-
### Documentation
-See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
+See [WeatherBot](https://nlpcraft.apache.org/examples/weather_bot.html) guide for more instructions on how to run this example.
For any questions, feedback or suggestions: