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-website.git
The following commit(s) were added to refs/heads/master by this push:
new 3d3f702 WIP.
3d3f702 is described below
commit 3d3f70240f890f671564b1c1cd7ba30a2f0e395f
Author: Aaron Radzinzski <[email protected]>
AuthorDate: Sun Jan 31 10:32:12 2021 -0800
WIP.
---
cheat-sheet.html | 26 +++++++++++++++++++++++---
relnotes/release-notes-0.7.0.html | 2 +-
tools/test_framework.html | 10 +++++-----
3 files changed, 29 insertions(+), 9 deletions(-)
diff --git a/cheat-sheet.html b/cheat-sheet.html
index 7862d38..ca51274 100644
--- a/cheat-sheet.html
+++ b/cheat-sheet.html
@@ -32,7 +32,7 @@ id: cheat_sheet
</button>
</h2>
</div>
- <div id="cheat1" class="collapse" data-parent="#cheats">
+ <div id="cheat1" class="show" data-parent="#cheats">
<div class="card-body">
<nav>
<div class="nav nav-tabs" role="tablist">
@@ -49,7 +49,8 @@ id: cheat_sheet
<div class="tab-pane fade show active"
id="nav-install-src" role="tabpanel">
<p></p>
<p>
- <a href="/download.html#src">Download</a>
latest (<code><b>{{site.latest_version}}</b></code>) source release.
+ <a href="/download.html#src">Download</a>
latest source
+ release
(<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>.zip</code>).
Once downloaded:
</p>
<pre class="brush: bash">
$ unzip -q
apache-nlpcraft-incubating-{{site.latest_version}}.zip
@@ -63,7 +64,8 @@ id: cheat_sheet
<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>{{site.latest_version}}</b></code>) binary release.
+ <a href="/download.html#src">Download</a>
latest binary
+ release
(<code>apache-nlpcraft-incubating-bin-<b>{{site.latest_version}}</b>.zip</code>).
Once downloaded:
</p>
<pre class="brush: bash">
$ unzip -q
apache-nlpcraft-incubating-bin-{{site.latest_version}}.zip
@@ -145,12 +147,14 @@ id: cheat_sheet
Start the server:
</p>
<pre class="brush: bash">
+ $ 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>
@@ -250,6 +254,7 @@ id: cheat_sheet
Start the probe:
</p>
<pre class="brush: bash">
+ $ 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>
@@ -257,6 +262,7 @@ id: cheat_sheet
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>
@@ -330,6 +336,14 @@ id: cheat_sheet
</div>
<div id="cheat4" class="collapse" data-parent="#cheats">
<div class="card-body">
+ <p></p>
+ <p>
+ Auto model validation consists
+ of starting an <a
href="/tools/embedded_probe.html">embedded probe</a>, 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/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotation and checking that resulting
+ intent matches the intent the sample was attached
to.
+ </p>
<nav>
<div class="nav nav-tabs" role="tablist">
<a class="nav-item nav-link active"
data-toggle="tab" href="#nav-script" role="tab">NLPCraft CLI</a>
@@ -339,6 +353,7 @@ id: cheat_sheet
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-script" role="tabpanel">
<pre class="brush: bash">
+ $ 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>
@@ -385,6 +400,7 @@ id: cheat_sheet
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-prj-script" role="tabpanel">
<pre class="brush: bash">
+ $ 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>
@@ -411,6 +427,7 @@ id: cheat_sheet
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-mdl-script" role="tabpanel">
<pre class="brush: bash">
+ $ 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>
@@ -441,12 +458,14 @@ id: cheat_sheet
Using <code>ask</code> command:
</p>
<pre class="brush: bash">
+ $ 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>
@@ -454,6 +473,7 @@ id: cheat_sheet
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>
diff --git a/relnotes/release-notes-0.7.0.html
b/relnotes/release-notes-0.7.0.html
index 0cb1c33..105b596 100644
--- a/relnotes/release-notes-0.7.0.html
+++ b/relnotes/release-notes-0.7.0.html
@@ -71,7 +71,7 @@ layout: release-notes
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-68'>NLPCRAFT-68</a> - Add
more examples to all example models.</li>
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-73'>NLPCRAFT-73</a> - Add
new maven profile for GridGain Control Center Agent.</li>
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-79'>NLPCRAFT-79</a> - Fix
docs/website links due to new sub-module structure of the project.</li>
- <li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-80'>NLPCRAFT-80</a> - Add
<code>@NCIntentSample</code> annotation + support in test framework and static
synonym tool.</li>
+ <li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-80'>NLPCRAFT-80</a> - Add
<a target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotation + support in test framework and static synonym tool.</li>
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-81'>NLPCRAFT-81</a> -
Resolve licensing issues for the release.</li>
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-94'>NLPCRAFT-94</a> -
Remove global model examples.</li>
<li><a target="jira"
href='https://issues.apache.org/jira/browse/NLPCRAFT-97'>NLPCRAFT-97</a> - Add
MIT to LICENSE file.</li>
diff --git a/tools/test_framework.html b/tools/test_framework.html
index 5387dca..82de36d 100644
--- a/tools/test_framework.html
+++ b/tools/test_framework.html
@@ -42,7 +42,7 @@ id: test_framework
target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/tools/test/NCTestAutoModelValidator.html">
NCTestAutoModelValidator
- </a> - auto-runner for model tests based on
<code>@NCIntentSample</code> annotation.
+ </a> - auto-runner for model tests based on <a
target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotation.
</li>
</ul>
</li>
@@ -153,7 +153,7 @@ public class AlarmTest {
<p>
The same model from <a href="/examples/alarm_clock.html">Alarm
Clock</a> example can be auto validated using
<a target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/tools/test/NCTestAutoModelValidator.html">NCTestAutoModelValidator</a>
- class and the <code>@NCIntentSample</code> annotation from the
model's callback method:
+ class and the <a target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotation from the model's callback method:
</p>
<pre class="brush: java, highlight: [4, 5, 6]">
public class AlarmModel extends NCModelFileAdapter {
@@ -172,10 +172,10 @@ public class AlarmModel extends NCModelFileAdapter {
}
</pre>
<p>
- Auto mode validator takes one or more model IDs (or class names)
and performs validation. Validation consists
+ 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
- <code>@NCIntentSample</code> annotations and their corresponding
callback methods, submitting each
- sample input sentences from <code>@NCIntentSample</code>
annotation and checking that resulting
+ <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/nlpcraft/model/NCIntentSample.html">@NCIntentSample</a>
annotation and checking that resulting
intent matches the intent the sample was attached to.
</p>
<h3 class="section-sub-title">Running</h3>
