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 a517195 WIP on readme.md
a517195 is described below
commit a517195484a35f38117daadecabbae45357a49e9
Author: Aaron Radzinski <[email protected]>
AuthorDate: Wed Aug 19 19:18:46 2020 -0700
WIP on readme.md
---
.../org/apache/nlpcraft/examples/alarm/README.md | 4 ++--
.../org/apache/nlpcraft/examples/echo/README.md | 15 ++++++++-------
.../apache/nlpcraft/examples/helloworld/README.md | 20 +++++++++++---------
.../apache/nlpcraft/examples/lightswitch/README.md | 16 ++++++++--------
.../org/apache/nlpcraft/examples/phone/README.md | 20 +++++++++++---------
.../scala/org/apache/nlpcraft/examples/sql/README.md | 10 ++++++----
.../org/apache/nlpcraft/examples/time/README.md | 14 ++++++++------
.../org/apache/nlpcraft/examples/weather/README.md | 16 +++++++++-------
8 files changed, 63 insertions(+), 52 deletions(-)
diff --git
a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
index 33afcf6..232e977 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
@@ -15,7 +15,7 @@
limitations under the License.
-->
-<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px">
+<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px" alt="">
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
@@ -63,6 +63,6 @@ For any questions, feedback or suggestions:
### Copyright
Copyright (C) 2020 Apache Software Foundation
-<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px">
+<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px"
alt="">
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 dc49a01..6170884 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
@@ -33,20 +33,22 @@ 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 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
+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.0=org.apache.nlpcraft.examples.echo.EchoModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.echo.EchoModel`
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
@@ -54,8 +56,7 @@ See [Getting
Started](https://nlpcraft.apache.org/getting-started.html) guide fo
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
- * Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html) * Download &
Maven/Grape/Gradle/SBT [instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
* Access [GitHub](https://github.com/apache/incubator-nlpcraft) mirror
repository.
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 858af54..9d280b1 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
@@ -15,7 +15,7 @@
limitations under the License.
-->
-<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px">
+<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px" alt="">
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
@@ -28,28 +28,30 @@ 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 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
+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.0=org.apache.nlpcraft.examples.helloworld.HelloWorldModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.helloworld.HelloWorldModel`
-
+
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
@@ -59,6 +61,6 @@ For any questions, feedback or suggestions:
### Copyright
Copyright (C) 2020 Apache Software Foundation
-<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px">
+<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px"
alt="">
diff --git
a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/lightswitch/README.md
b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/lightswitch/README.md
index 1b890ef..402d8d7 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/lightswitch/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/lightswitch/README.md
@@ -30,30 +30,30 @@ You can easily modify intent callbacks to perform the
actual light switching usi
controllers.
### Running
-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
+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.lightswitch.LightSwitchModel`
+
+If not using built-in test framework (i.e. not using embedded probe) you need
to start data probe manually:
* Run data 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.0=org.apache.nlpcraft.examples.lightswitch.LightSwitchModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.lightswitch.LightSwitchModel`
-### Blog
-Read the [blog
post](https://nlpcraft.apache.org/blogs/lightswitch_with_natural_language_interface.html)
explaining this example in greater details.
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
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 9746e27..cc6c948 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
@@ -15,7 +15,7 @@
limitations under the License.
-->
-<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px">
+<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif";
height="80px" alt="">
<br>
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
@@ -29,8 +29,8 @@ It doesn't actually do a phone dialing, but it recognizes the
recipient and retu
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 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
+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`
@@ -39,23 +39,25 @@ embedded probe and starts it automatically:
* `CONFIG_FORCE_nlpcraft_server_tokenProviders.0=nlpcraft`
* `CONFIG_FORCE_nlpcraft_server_tokenProviders.1=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.0=org.apache.nlpcraft.examples.phone.PhoneModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.phone.PhoneModel`
### 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/intergrations.html)
section on how to configure 3rd party token providers.
+See also [Integrations](https://nlpcraft.apache.org/integrations.html) section
on how to configure 3rd party token providers.
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
@@ -65,6 +67,6 @@ For any questions, feedback or suggestions:
### Copyright
Copyright (C) 2020 Apache Software Foundation
-<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px">
+<img src="https://www.apache.org/img/ASF20thAnniversary.jpg"; height="64px"
alt="">
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 1458dfa..1a821bf 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
@@ -33,11 +33,15 @@ This example can be run the same way as other examples with
one exception - it n
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
+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`
@@ -46,8 +50,6 @@ embedded probe and starts it automatically:
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`
- * Test using built-in test framework:
- * **JUnit class:** `org.apache.nlpcraft.examples.sql.NCSqlExampleTest`
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
@@ -55,7 +57,7 @@ See [Getting
Started](https://nlpcraft.apache.org/getting-started.html) guide fo
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
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 2d8e9b7..9bbec40 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
@@ -28,20 +28,22 @@ This example data model answers the questions about current
time, either local t
It provides YAML response with time and timezone information and uses YAML
model definition.
### Running
-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
+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.0=org.apache.nlpcraft.examples.time.TimeModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.time.TimeModel`
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
@@ -49,7 +51,7 @@ See [Getting
Started](https://nlpcraft.apache.org/getting-started.html) guide fo
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
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 a237782..cf36ee7 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
@@ -29,28 +29,30 @@ intent matching logic. It uses https://www.apixu.com REST
service for the actual
weather information.
### Running
-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
+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.0=org.apache.nlpcraft.examples.weather.WeatherModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.weather.WeatherModel`
-
+
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
![https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif"](https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif"){kind=link}
![https://www.apache.org/img/ASF20thAnniversary.jpg"](https://www.apache.org/img/ASF20thAnniversary.jpg"){kind=link}