This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch web-site
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/web-site by this push:
new 82f2453 WIP.
82f2453 is described below
commit 82f24533b69c77e29348978ac01db1cd0457f74f
Author: Aaron Radzinski <[email protected]>
AuthorDate: Wed Dec 2 20:25:38 2020 -0800
WIP.
---
feed.xml | 2 +-
getting-started.html | 8 ++++----
server-and-probe.html | 38 ++++++++++++++++++++------------------
tools/sql_model_gen.html | 2 +-
tools/test_framework.html | 2 +-
5 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/feed.xml b/feed.xml
index ad96d32..218de89 100644
--- a/feed.xml
+++ b/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed
xmlns="http://www.w3.org/2005/Atom"; ><generator uri="https://jekyllrb.com/";
version="4.1.1">Jekyll</generator><link href="http://localhost:4000/feed.xml";
rel="self" type="application/atom+xml" /><link href="http://localhost:4000/";
rel="alternate" type="text/html"
/><updated>2020-12-01T13:14:10-08:00</updated><id>http://localhost:4000/feed.xml</id><title
type="html">Apache NLPCraft</title></feed>
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8"?><feed
xmlns="http://www.w3.org/2005/Atom"; ><generator uri="https://jekyllrb.com/";
version="4.1.1">Jekyll</generator><link href="http://localhost:4000/feed.xml";
rel="self" type="application/atom+xml" /><link href="http://localhost:4000/";
rel="alternate" type="text/html"
/><updated>2020-12-02T20:20:48-08:00</updated><id>http://localhost:4000/feed.xml</id><title
type="html">Apache NLPCraft</title></feed>
\ No newline at end of file
diff --git a/getting-started.html b/getting-started.html
index adefeae..0e4a36a 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -17,8 +17,8 @@
<!doctype html><html lang="en"> <script async
src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1";></script>
<script> window.dataLayer = window.dataLayer || []; function
gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config',
'UA-180663034-1'); </script><meta charset="utf-8"><meta
http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta
name="description" content="An open sourc [...]
$ cd build
- $ java -jar apache-nlpcraft-0.7.2-all-deps.jar -server
- </pre><p> REST server starts with default configuration
(<code>nlpcraft.conf</code> and <code>ignite.xml</code> files located in the
same folder as <code>apache-nlpcraft-0.7.2-all-deps.jar</code> file). You
should see the output similar to this:</p><pre class="brush: plain">
+ $ java -jar apache-nlpcraft-incubating-0.7.2-all-deps.jar
-server
+ </pre><p> REST server starts with default configuration
(<code>nlpcraft.conf</code> and <code>ignite.xml</code> files located in the
same folder as <code>apache-nlpcraft-incubating-0.7.2-all-deps.jar</code>
file). You should see the output similar to this:</p><pre class="brush: plain">
_ ____ ______ ______
/ | / / /___ / ____/________ _/ __/ /_
/ |/ / / __ \/ / / ___/ __ `/ /_/ __/
@@ -40,8 +40,8 @@
Mar-11 23:21:04 [INFO ] REST server is listening on
'localhost:8081'.
</pre></div><div class="tab-pane fade show"
id="nav-probe-start" role="tabpanel"><pre class="brush: plain">
$ cd build
- $ java -jar apache-nlpcraft-0.7.2-all-deps.jar -probe
- </pre><p> Data probe starts with default configuration (file
<code>nlpcraft.conf</code> located in the same folder as
<code>apache-nlpcraft-0.7.2-all-deps.jar</code> file) that deploys all example
models shipped with NLPCraft. You should see the output similar to
this:</p><pre class="brush: plain">
+ $ java -jar apache-nlpcraft-incubating-0.7.2-all-deps.jar
-probe
+ </pre><p> Data probe starts with default configuration (file
<code>nlpcraft.conf</code> located in the same folder as
<code>apache-nlpcraft-incubating-0.7.2-all-deps.jar</code> file) that deploys
all example models shipped with NLPCraft. You should see the output similar to
this:</p><pre class="brush: plain">
_ ____ ______ ______
/ | / / /___ / ____/________ _/ __/ /_
/ |/ / / __ \/ / / ___/ __ `/ /_/ __/
diff --git a/server-and-probe.html b/server-and-probe.html
index d2c5794..776fae7 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -15,28 +15,30 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async
src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1";></script>
<script> window.dataLayer = window.dataLayer || []; function
gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config',
'UA-180663034-1'); </script><meta charset="utf-8"><meta
http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta
name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async
src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1";></script>
<script> window.dataLayer = window.dataLayer || []; function
gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config',
'UA-180663034-1'); </script><meta charset="utf-8"><meta
http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta
name="description" content="An open sourc [...]
├── LICENSE
+├── NOTICE
+├── DISCLAIMER
├── bin
├── sql
+├── nlpcraft
+├── nlpcraft-stanford
├── build
-│ └── apache-nlpcraft-0.7.2
-│ ├── <b>nlpcraft.conf</b>
-│ ├── ignite.xml
-│ ├── log4j2.xml
-│ └── <b>apache-nlpcraft-0.7.2-all-deps.jar</b>
+│ ├── <b>nlpcraft.conf</b>
+│ ├── ignite.xml
+│ ├── log4j2.xml
+│ └── <b>apache-nlpcraft-incubating-0.7.2-all-deps.jar</b>
├── javadoc
-├── openapi
-└── src
- </pre><p> Regardless of how NLPCraft was installed it comes with a
single executable JAR file that includes all necessary dependencies:
<code>build/apache-nlpcraft-0.7.2/<b>apache-nlpcraft-0.7.2-all-deps.jar</b></code>.
This JAR file includes binaries for data probe, data model APIs and the REST
server.</p></section><section id="server"><h2 class="section-title">REST
Server</h2><p> As mentioned above REST server (or a cluster of servers) is used
to accept client REST calls and ro [...]
+└── openapi
+ </pre><p> NLPCraft comes with a single executable JAR file that
includes all necessary dependencies:
<code>build/<b>apache-nlpcraft-incubating-0.7.2-all-deps.jar</b></code>. This
JAR file includes binaries for data probe, data model APIs and the REST
server.</p><div class="bq info"> <b>Run <code>'mvn clean package'</code> For
Source ZIP</b><p> If you downloaded the source ZIP you need to run <code>mvn
clean package</code> to get the <code>apache-nlpcraft-incubating-0.7.2-all-deps
[...]
$ cd build
- $ java -Xms1024m -jar apache-nlpcraft-0.7.2-all-deps.jar
-server
+ $ java -Xms1024m -jar
apache-nlpcraft-incubating-0.7.2-all-deps.jar -server
</pre></div><div class="tab-pane fade show" id="nav-srv-cmd"
role="tabpanel"><pre class="brush: plain">
$ cd build
- $ java -Xms1024m -cp apache-nlpcraft-0.7.2-all-deps.jar
org.apache.nlpcraft.NCStart -server
- </pre></div><div class="tab-pane fade show" id="nav-srv-ide"
role="tabpanel"><p style="padding-top: 10px"> Configure run configuration with
the main class <code>org.apache.nlpcraft.NCStart</code>. Note that
<code>org.apache.nlpcraft.NCStart</code> class starts both the REST server and
the data probe and is the class that is configured as <code>Main-Class</code>
in <code>apache-nlpcraft-0.7.2-all-deps.jar</code> JAR file
manifest.</p></div><div class="tab-pane fade show" i [...]
+ $ java -Xms1024m -cp
apache-nlpcraft-incubating-0.7.2-all-deps.jar org.apache.nlpcraft.NCStart
-server
+ </pre></div><div class="tab-pane fade show" id="nav-srv-ide"
role="tabpanel"><p style="padding-top: 10px"> Configure run configuration with
the main class <code>org.apache.nlpcraft.NCStart</code>. Note that
<code>org.apache.nlpcraft.NCStart</code> class starts both the REST server and
the data probe and is the class that is configured as <code>Main-Class</code>
in <code>apache-nlpcraft-incubating-0.7.2-all-deps.jar</code> JAR file
manifest.</p></div><div class="tab-pane f [...]
$ docker run -m 8G -p 8081:8081 -p 8201:8201 -p 8202:8202
nlpcraftserver/server:0.7.2
- </pre><p> By default, the Docker image runs with a default
configuration. See <a href="#config">configuration</a> section on how to
provide custom configuration via environment variables for the REST server
running inside of Docker container.</p></div></div>Parameters:<dl><dt>
<code>-server</code><dd> <em>Mandatory</em> parameter to indicate that you are
starting the REST server.<dt><code>-config=path</code><dd> <em>Optional</em>
parameter to provide configuration file pa [...]
+ </pre><p> By default, the Docker image runs with a default
configuration. See <a href="#config">configuration</a> section on how to
provide custom configuration via environment variables for the REST server
running inside of Docker container.</p></div></div>Parameters:<dl><dt>
<code>-server</code><dd> <em>Mandatory</em> parameter to indicate that you are
starting the REST server.<dt><code>-config=path</code><dd> <em>Optional</em>
parameter to provide configuration file pa [...]
Jul-22 13:27:56 [INFO ] ...
Jul-22 13:28:08 [WARN ] Possible too long JVM pause: 11364
milliseconds.
Jul-22 13:28:11 [INFO ] ...
@@ -62,13 +64,13 @@
Mar-11 23:21:04 [INFO ] REST server is listening on
'localhost:8081'.
</pre></section><section id="probe"><h2 class="section-title">Data
Probe</h2><p> Just like the REST server the data probe can be started in a
<em>standard way</em> from either the command line or IDE such as Eclipse or
IntelliJ IDEA:</p><nav><div class="nav nav-tabs" role="tablist"> <a
class="nav-item nav-link active" data-toggle="tab" href="#nav-probe-cmd"
role="tab" aria-controls="nav-home" aria-selected="true">Command Line</a> <a
class="nav-item nav-link" data-toggle="tab" hre [...]
$ cd build
- $ java -Xms1024m -jar apache-nlpcraft-0.7.2-all-deps.jar
-probe
+ $ java -Xms1024m -jar
apache-nlpcraft-incubating-0.7.2-all-deps.jar -probe
</pre><div class="bq warn"><p> <b>NOTE:</b> when using
executable JAR to start the data probe you cannot add your own model classes to
the classpath. You should either package your classes into JAR file and
configure probe accordingly - or use <code>-cp</code> option in command
line.</p></div></div><div class="tab-pane fade show active" id="nav-probe-cmd"
role="tabpanel"><pre class="brush: plain">
$ cd build
- $ java -Xms1024m -cp
apache-nlpcraft-0.7.2-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config=/my/project/probe.conf
- </pre><p> Directory <code>/my/project/classes</code> should
contain all compiled classes for your models. Make sure to replace
<code>/my/project/classes</code> and <code>/my/project/probe.conf</code> with
the actual paths.</p></div><div class="tab-pane fade show" id="nav-probe-ide"
role="tabpanel"><p style="padding-top: 10px"> Configure run configuration with
the main class <code>org.apache.nlpcraft.NCStart</code>.</p><div class="bq
info"> <b>Class <code>org.apache.nlpcra [...]
+ $ java -Xms1024m -cp
apache-nlpcraft-incubating-0.7.2-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config=/my/project/probe.conf
+ </pre><p> Directory <code>/my/project/classes</code> should
contain all compiled classes for your models. Make sure to replace
<code>/my/project/classes</code> and <code>/my/project/probe.conf</code> with
the actual paths.</p></div><div class="tab-pane fade show" id="nav-probe-ide"
role="tabpanel"><p style="padding-top: 10px"> Configure run configuration with
the main class <code>org.apache.nlpcraft.NCStart</code>.</p><div class="bq
info"> <b>Class <code>org.apache.nlpcra [...]
$ cd build
- $ java -cp
apache-nlpcraft-0.7.2-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config /my/project/probe.conf
+ $ java -cp
apache-nlpcraft-incubating-0.7.2-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config /my/project/probe.conf
</pre>Make sure to replace <code>/my/project/classes</code> with
your own directory where your compiled model classes are located. Note that you
need to specify class <code>org.apache.nlpcraft.NCStart</code> explicitly in
this case.</div><p> When the data probe started you should see the log output
similar to this:</p><pre class="brush: plain">
_ ____ ______ ______
/ | / / /___ / ____/________ _/ __/ /_
@@ -120,7 +122,7 @@
...
Mar-11 23:25:58 [INFO ] Server connection established.
- </pre></section><section id="config"><h2
class="section-title">Configuration</h2><p> Both REST server and the data probe
use <a target=_ href="https://github.com/lightbend/config/";>Typesafe Config</a>
for their configuration:</p><ul><li>Both the server and the data probe come
with default configuration available in <code>build/<b>nlpcraft.conf</b></code>
file.<li>Custom configuration or default overrides can be placed into a file or
provided via environment variables.<li>Configur [...]
+ </pre></section><section id="config"><h2
class="section-title">Configuration</h2><p> Both REST server and the data probe
use <a target=_ href="https://github.com/lightbend/config/";>Typesafe Config</a>
for their configuration:</p><ul><li>Both the server and the data probe come
with default configuration available in <code>build/<b>nlpcraft.conf</b></code>
file.<li>Custom configuration or default overrides can be placed into a file or
provided via environment variables.<li>Configur [...]
nlpcraft {
server {
...
diff --git a/tools/sql_model_gen.html b/tools/sql_model_gen.html
index cfea844..69146a1 100644
--- a/tools/sql_model_gen.html
+++ b/tools/sql_model_gen.html
@@ -123,7 +123,7 @@ DETAILS:
do not start with '_'.
EXAMPLES:
- java -cp apache-nlpcraft-0.5.0-all-deps.jar
org.apache.nlpcraft.model.tools.sqlgen.NCSqlModelGenerator
+ java -cp apache-nlpcraft-incubating-0.5.0-all-deps.jar
org.apache.nlpcraft.model.tools.sqlgen.NCSqlModelGenerator
-r jdbc:postgresql://localhost:5432/mydb
-d org.postgresql.Driver
-f "tbl_, col_"
diff --git a/tools/test_framework.html b/tools/test_framework.html
index bf0277c..8422555 100644
--- a/tools/test_framework.html
+++ b/tools/test_framework.html
@@ -61,4 +61,4 @@ public class AlarmModel extends NCModelFileAdapter {
}
</pre><p> Auto model validator will scan the model for its callback
methods, collect all samples from <code>@NCIntentSample</code> annotations, and
will submit each sample and check that correct intent is selected as the
winning match. Notice that this auto validation does not require any additional
code to be written - the tool gathers all required information from the model
itself.</p><p> Add necessary classpath to and run:</p><pre class="brush: plain">
java -ea -DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel
org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
- </pre><p> Notes:</p><ul><li> When running auto validator from command
line you set models to test via <code>NLPCRAFT_TEST_MODELS</code> system
property that should contain comma separate list of the data model
classes.</ul><p> In the log output you should see the following validation
results:</p><figure> <img class="img-fluid-no-border"
src="/images/auto_validation.png" alt=""><figcaption><b>Fig 1.</b> Model
Auto-Validation Result.</figcaption></figure><p> See <a target="javadoc" [...]
+ </pre><p> Notes:</p><ul><li> When running auto validator from command
line you set models to test via <code>NLPFaFCRAFT_TEST_MODELS</code> system
property that should contain comma separate list of the data model
classes.</ul><p> In the log output you should see the following validation
results:</p><figure> <img class="img-fluid-no-border"
src="/images/auto_validation.png" alt=""><figcaption><b>Fig 1.</b> Model
Auto-Validation Result.</figcaption></figure><p> See <a target="javad [...]
