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 b7b7fbd Update.
b7b7fbd is described below
commit b7b7fbdb2ab8162e6ad5cc5d481ebaf778e81e7f
Author: Aaron Radzinski <[email protected]>
AuthorDate: Sun Jan 31 19:46:18 2021 -0800
Update.
---
cheat-sheet.html | 16 +++++++++++++---
feed.xml | 2 +-
relnotes/release-notes-0.7.0.html | 2 +-
server-and-probe.html | 4 ++--
tools/test_framework.html | 6 +++---
5 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/cheat-sheet.html b/cheat-sheet.html
index 26bd6d5..7426dd5 100644
--- a/cheat-sheet.html
+++ b/cheat-sheet.html
@@ -15,11 +15,11 @@
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 [...]
$ unzip -q
apache-nlpcraft-incubating-0.7.4.zip
$ cd apache-nlpcraft-incubating-0.7.4
$ mvn clean package -DskipTests
- </pre><p> Built JARs and Javadoc will be
located in <code>target</code> sub-folder.</p></div><div class="tab-pane fade
show" id="nav-install-bin" role="tabpanel"><p></p><p> <a
href="/download.html#zip">Download</a> latest (<code><b>0.7.4</b></code>)
binary release.</p><pre class="brush: bash">
+ </pre><p> Built JARs and Javadoc will be
located in <code>target</code> sub-folder.</p></div><div class="tab-pane fade
show" id="nav-install-bin" role="tabpanel"><p></p><p> <a
href="/download.html#src">Download</a> latest binary release
(<code>apache-nlpcraft-incubating-bin-<b>0.7.4</b>.zip</code>). Once
downloaded:</p><pre class="brush: bash">
$ unzip -q
apache-nlpcraft-incubating-bin-0.7.4.zip
</pre></div><div class="tab-pane fade show"
id="nav-install-github" role="tabpanel"><pre class="brush: bash">
$ git clone
https://github.com/apache/incubator-nlpcraft.git
@@ -39,8 +39,10 @@
</pre><p> <b>NOTE:</b> to get <a
href="/tools/script.html">NLPCraft CLI script</a> you still need to download <a
href="/download.html#zip">binary</a> ZIP or <a
href="/download.html#build">build</a> from <a
href="/download.html#src">source</a>.</p></div><div class="tab-pane fade"
id="nav-install-sbt" role="tabpanel"><pre class="brush: scala">
libraryDependencies +=
"org.apache.nlpcraft" % "nlpcraft" % "0.7.4"
</pre><p> <b>NOTE:</b> to get <a
href="/tools/script.html">NLPCraft CLI script</a> you still need to download <a
href="/download.html#zip">binary</a> ZIP or <a
href="/download.html#build">build</a> from <a
href="/download.html#src">source</a>.</p></div></div></div></div></div><div
class="card"><div class="card-header" id="q2"><h2 class="mb-0"> <button
class="btn btn-link btn-block text-left" type="button" data-toggle="collapse"
data-target="#cheat2"> Start [...]
+ $ bin/nlpcraft.sh help -c=start-server # Get
help.
$ bin/nlpcraft.sh start-server # Start server.
</pre><p> Stop the server:</p><pre class="brush:
bash">
+ $ bin/nlpcraft.sh help -c=stop-server # Get
help.
$ bin/nlpcraft.sh stop-server # Stop server.
$ bin/nlpcraft.sh stop # Stop both server and
probe.
</pre></div><div class="tab-pane fade show"
id="nav-srv-class" role="tabpanel"><p></p><p> If using executable JAR:</p><pre
class="brush: bash">
@@ -50,32 +52,40 @@
</pre><p> <b>NOTES:</b></p><ul><li> Make sure to
provide correct path to
<code>apache-nlpcraft-incubating-<b>0.7.4</b>-all-deps.jar</code> file.<li>
Class <code>org.apache.nlpcraft.NCStart</code> is a common entry point for all
NLPCraft runtime components.<li> Class <code>org.apache.nlpcraft.NCStart</code>
should be used to star REST server from IDE.</ul><p> Parameters:</p><dl><dt>
<code>-server</code><dd> <em>Mandatory</em> parameter to indicate that you are
[...]
$ docker run -m 8G -p 8081:8081 -p 8201:8201
-p 8202:8202 nlpcraftserver/server:0.7.4
</pre></div></div></div></div></div><div
class="card"><div class="card-header" id="q3"><h2 class="mb-0"> <button
class="btn btn-link btn-block text-left" type="button" data-toggle="collapse"
data-target="#cheat3"> Start <span class="amp">&</span> Stop REST Probe
</button></h2></div><div id="cheat3" class="collapse"
data-parent="#cheats"><div class="card-body"><nav><div class="nav nav-tabs"
role="tablist"> <a class="nav-item nav-link active" data-toggle="ta [...]
+ $ bin/nlpcraft.sh help -c=start-probe #
Get help.
$ bin/nlpcraft.sh start-probe # Start
probe with default config.
$ bin/nlpcraft.sh start-probe
--cfg=~/myapp/nlpcraft.conf --mdls=my.package.Model --cp=~/myapp/target/classes
--jmvOpts="-ea -Xms2048m" --timeoutMins=5
</pre><p> Stop the probe:</p><pre
class="brush: bash">
+ $ bin/nlpcraft.sh help -c=stop-probe # Get
help.
$ bin/nlpcraft.sh stop-probe # Stop probe.
$ bin/nlpcraft.sh stop # Stop server and
probe.
</pre></div><div class="tab-pane fade show"
id="nav-probe-class" role="tabpanel"><p></p><p> If using executable
JAR:</p><pre class="brush: bash">
$ java -jar
apache-nlpcraft-incubating-0.7.4-all-deps.jar -probe
</pre><p> If specifying additional classpath
components and need <code>-cp</code> parameter:</p><pre class="brush: bash">
java -cp
apache-nlpcraft-incubating-0.7.4-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config=/my/project/probe.conf
- </pre><p> <b>NOTES:</b></p><ul><li>
<code>/my/project</code> directory contains user-defined model
implementation<li> Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>0.7.4</b>-all-deps.jar</code> file.<li>
Class <code>org.apache.nlpcraft.NCStart</code> is a common entry point for all
NLPCraft runtime components.<li> Class <code>org.apache.nlpcraft.NCStart</code>
should be used to star data probe from IDE.</ul><p> Parameters:</p><dl [...]
+ </pre><p> <b>NOTES:</b></p><ul><li>
<code>/my/project</code> directory contains user-defined model
implementation<li> Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>0.7.4</b>-all-deps.jar</code> file.<li>
Class <code>org.apache.nlpcraft.NCStart</code> is a common entry point for all
NLPCraft runtime components.<li> Class <code>org.apache.nlpcraft.NCStart</code>
should be used to star data probe from IDE.</ul><p> Parameters:</p><dl [...]
+ $ bin/nlpcraft.sh help -c=test-model # Get
help.
$ bin/nlpcraft.sh test-model # All default
parameters.
$ bin/nlpcraft.sh test-model
--mdls=my.package.Model --cp=~/myapp/target/classes --jmvOpts="-ea -Xms2048m"
</pre></div><div class="tab-pane fade show"
id="nav-class" role="tabpanel"><pre class="brush: bash">
java -cp
apache-nlpcraft-incubating-0.7.4-all-deps.jar
-DNLPCRAFT_TEST_MODELS=my.package.Model
org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
</pre><p> <b>NOTES:</b></p><ul><li> Make sure
to add necessary classpath components.<li> <code>NLPCRAFT_TEST_MODELS</code>
system property that should contain comma separate list of the data model
classes to test.<li> You can also use
<code>org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator</code>
class directly to call it programmatically from the code or from
IDE.</ul></div></div></div></div></div><div class="card"><div
class="card-header" id= [...]
+ $ bin/nlpcraft.sh help -c=gen-project #
Get help.
$ bin/nlpcraft.sh gen-project -n=MyProject
-l=scala -b=sbt # Scala/SBT project stub.
$ bin/nlpcraft.sh gen-project -n=MyProject
-l=kotlin -p=com.mycompany.nlp -o # Kotlin/Maven project stub.
</pre></div></div></div></div></div><div
class="card"><div class="card-header" id="q6"><h2 class="mb-0"> <button
class="btn btn-link btn-block text-left" type="button" data-toggle="collapse"
data-target="#cheat6"> New Model Stub </button></h2></div><div id="cheat6"
class="collapse" data-parent="#cheats"><div class="card-body"><nav><div
class="nav nav-tabs" role="tablist"> <a class="nav-item nav-link active"
data-toggle="tab" href="#nav-mdl-script" role="ta [...]
+ $ bin/nlpcraft.sh help -c=gen-model # Get
help.
$ bin/nlpcraft.sh gen-model
--filePath=~/myapp/myModel.json --mdlId=my.model.id # JSON model stub.
$ bin/nlpcraft.sh gen-model
-f=c:/tmp/myModel.yaml -m=my.model.id -o # YAML model stub.
</pre></div></div></div></div></div><div
class="card"><div class="card-header" id="q7"><h2 class="mb-0"> <button
class="btn btn-link btn-block text-left" type="button" data-toggle="collapse"
data-target="#cheat7"> Testing With REST </button></h2></div><div id="cheat7"
class="collapse" data-parent="#cheats"><div class="card-body"><nav><div
class="nav nav-tabs" role="tablist"> <a class="nav-item nav-link active"
data-toggle="tab" href="#nav-rest-script" role [...]
+ $ bin/nlpcraft.sh help -c=ask # Get help.
$ bin/nlpcraft.sh ask --txt="User request"
--mdlId=my.model.id # REST 'ask/sync' call.
</pre><p> Using <code>call</code> command (for
REPL mode):</p><pre class="brush: bash">
+ $ bin/nlpcraft.sh help -c=call # Get help.
$ bin/nlpcraft.sh call -p=signin
[email protected] --passwd=admin
$ bin/nlpcraft.sh call --path=ask/sync
--acsTok=qwerty123456 --txt="User request" --mdlId=my.model.id
--data='{"data1": true, "data2": 123, "data3": "some text"}' --enableLog=false
</pre><p> Using <code>rest</code> command (for
command line mode):</p><pre class="brush: bash">
+ $ bin/nlpcraft.sh help -c=rest # Get help.
$ bin/nlpcraft.sh rest -p=signin
-j='{"email": "[email protected]", "passwd": "admin"}' # Linux/Unix/MacOS REST
call.
$ bin/nlpcraft.cmd rest --path=signin
--json='{\"email\": \"[email protected]\", \"passwd\": \"admin\"}' # Window REST
call.
</pre></div></div></div></div></div></div><div
class="bq success"><p> <b>NOTES:</b></p><ul><li> <a
href="/tools/script.html">NLPCraft CLI</a> is available as
<code>nlpcraft.sh</code> for <i class="fab fa-fw fa-linux"></i> and
<code>nlpcraft.cmd</code> for <i class="fab fa-fw fa-windows"></i>.<li> Run
<code class="script">bin/nlpcraft.sh help --cmd=xxx</code> to get a full help
on <code>xxx</code> command.</ul></div></section></div><div class="col-md-2
thir [...]
diff --git a/feed.xml b/feed.xml
index 4c45889..9930e1a 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>2021-01-31T00:04:23-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>2021-01-31T19:39:20-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/relnotes/release-notes-0.7.0.html
b/relnotes/release-notes-0.7.0.html
index 423f357..6e7f312 100644
--- a/relnotes/release-notes-0.7.0.html
+++ b/relnotes/release-notes-0.7.0.html
@@ -15,4 +15,4 @@
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 [...]
diff --git a/server-and-probe.html b/server-and-probe.html
index 5f3c6fd..5404bc4 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -73,7 +73,7 @@ nlpcraft {
}
}
}
- </pre><p> You can override these properties with the following
environment variables:</p><p>
<code>CONFIG_FORCE_<b>nlpcraft_server_rest_host</b>=1.2.3.4</code><br>
<code>CONFIG_FORCE_<b>nlpcraft_server_lifecycle</b>="org.nlp.Lifecycle1,
org.nlp.Lifecycle1"</code><br>
<code>CONFIG_FORCE_<b>nlpcraft_probe_models</b>="com.nlp.MyModel,
com.nlp.AnotherModel"</code></p><div class="bq info"> <b>Examples</b><p> Note
that all examples that come with NLPCraft have instructions that use env [...]
+ </pre><p> You can override these properties with the following
environment variables:</p><p>
<code>CONFIG_FORCE_<b>nlpcraft_server_rest_host</b>=1.2.3.4</code><br>
<code>CONFIG_FORCE_<b>nlpcraft_server_lifecycle</b>="org.nlp.Lifecycle1,
org.nlp.Lifecycle1"</code><br>
<code>CONFIG_FORCE_<b>nlpcraft_probe_models</b>="com.nlp.MyModel,
com.nlp.AnotherModel"</code></p><div class="bq info"> <b>Examples</b><p> Note
that all examples that come with NLPCraft have instructions that use env [...]
<plugin>
<groupId>com.bazaarvoice.maven.plugins</groupId>
<artifactId>process-exec-maven-plugin</artifactId>
@@ -122,4 +122,4 @@ nlpcraft {
</execution>
</executions>
</plugin>
- </pre><p> <b>NOTES</b>:</p><ul><li> On line 14 we specify the URL
endpoint to check whether or not our server is online. We use
<code>/health</code> localhost REST call for that.<li> On line 16 we redirect
the output from server to a dedicated file to <b>avoid interleaving</b> log
from server and log from data probe in the same console (where we are running
the Maven build from). Such interleaving will make the combined log unreadable
and can cause output problem for the console [...]
+ </pre><p> <b>NOTES</b>:</p><ul><li> On line 14 we specify the URL
endpoint to check whether or not our server is online. We use
<code>/health</code> localhost REST call for that.<li> On line 16 we redirect
the output from server to a dedicated file to <b>avoid interleaving</b> log
from server and log from data probe in the same console (where we are running
the Maven build from). Such interleaving will make the combined log unreadable
and can cause output problem for the console [...]
diff --git a/tools/test_framework.html b/tools/test_framework.html
index 6eaa813..72033b4 100644
--- a/tools/test_framework.html
+++ b/tools/test_framework.html
@@ -15,7 +15,7 @@
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 [...]
public class AlarmTest {
private NCTestClient cli;
@@ -44,7 +44,7 @@ public class AlarmTest {
assertTrue(cli.ask("Set my alarm for 30s").isOk());
}
}
- </pre><p> <b>NOTES:</b></p><ul><li> Before each unit test execution on
line 8 we create new instance of <code>NCTestClient</code> using client builder
with default configuration. On line 10 we open test client connection for model
with ID <code>nlpcraft.alarm.ex</code>.<li> After each test execution we close
test client connection on line 16.<li> On lines 24-26 we submit ("ask") test
sentences to our model and check for succesfull processing.</ul><div class="bq
info"><p> <b>Embed [...]
+ </pre><p> <b>NOTES:</b></p><ul><li> Before each unit test execution on
line 8 we create new instance of <code>NCTestClient</code> using client builder
with default configuration. On line 10 we open test client connection for model
with ID <code>nlpcraft.alarm.ex</code>.<li> After each test execution we close
test client connection on line 16.<li> On lines 24-26 we submit ("ask") test
sentences to our model and check for succesfull processing.</ul><div class="bq
info"><p> <b>Embed [...]
public class AlarmModel extends NCModelFileAdapter {
@NCIntentRef("alarm")
@NCIntentSample({
@@ -59,7 +59,7 @@ public class AlarmModel extends NCModelFileAdapter {
// ...
}
}
- </pre><p> Auto mode validator takes one or more model IDs (or class
names) and performs validation. Validation consists of starting an <a
href="/tools/embedded_probe.html">embedded probe</a> with a given model,
scanning for <code>@NCIntentSample</code> annotations and their corresponding
callback methods, submitting each sample input sentences from
<code>@NCIntentSample</code> annotation and checking that resulting intent
matches the intent the sample was attached to.</p><h3 clas [...]
+ </pre><p> Auto model validator takes one or more model IDs (or class
names) and performs validation. Validation consists of starting an <a
href="/tools/embedded_probe.html">embedded probe</a> with a given model,
scanning for <a target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotations and their corresponding callback methods, submitting each sample
input sentences from <a target="javadoc" href="/apis/latest/org/apache/nlpcr
[...]
$ bin/nlpcraft.sh test-model
</pre><p> <b>NOTES:</b></p><ul><li> <a
href="/tools/script.html">NLPCraft CLI</a> is available as
<code>nlpcraft.sh</code> for <i class="fab fa-fw fa-linux"></i> and
<code>nlpcraft.cmd</code> for <i class="fab fa-fw fa-windows"></i>.<li> Run
<code class="script">bin/nlpcraft.sh help --cmd=test-model</code> to get a full
help on this command.</ul></div><div class="tab-pane fade show" id="nav-class"
role="tabpanel"><pre class="brush: bash">
java -cp apache-nlpcraft-incubating-0.7.4-all-deps.jar
-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel
org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
