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/07/10 00:28:57 UTC
[incubator-nlpcraft-website] branch master updated: WIP on
NLPCRAFT-352 + misc.
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 08c65b4 WIP on NLPCRAFT-352 + misc.
08c65b4 is described below
commit 08c65b41cd5eb7cea26d4bb64d3e07a9aee2b012
Author: Aaron Radzinzski <ar...@datalingvo.com>
AuthorDate: Fri Jul 9 17:28:44 2021 -0700
WIP on NLPCRAFT-352 + misc.
---
cheat-sheet.html | 4 +++-
examples/alarm_clock.html | 4 ++++
examples/light_switch.html | 4 ++++
examples/sql_model.html | 4 ++++
examples/weather_bot.html | 4 ++++
getting-started.html | 5 +++--
server-and-probe.html | 3 ++-
tools/script.html | 11 +++++++++--
8 files changed, 33 insertions(+), 6 deletions(-)
diff --git a/cheat-sheet.html b/cheat-sheet.html
index 3399ca5..bc7fe44 100644
--- a/cheat-sheet.html
+++ b/cheat-sheet.html
@@ -256,8 +256,9 @@ id: cheat_sheet
</p>
<pre class="brush: bash">
$ bin/nlpcraft.sh help -c=start-probe # Get help.
- $ bin/nlpcraft.sh start-probe --cp=~/myapp/target/classes # Start probe with given model(s).
+ $ bin/nlpcraft.sh start-probe --cp=~/myapp/target/classes # Start probe with default configuration.
$ bin/nlpcraft.sh start-probe --cp=~/myapp/target/classes --cfg=~/myapp/nlpcraft.conf --mdls=my.package.Model --jmvOpts="-ea -Xms2048m" --timeoutMins=5
+ > restart-probe # Restart the probe with the last set of parameters in REPL mode.
</pre>
<p>
Stop the probe:
@@ -357,6 +358,7 @@ id: cheat_sheet
$ bin/nlpcraft.sh help -c=test-model # Get help.
$ bin/nlpcraft.sh test-model --cp=~/myapp/target/classes # Test all models in specified classpath.
$ bin/nlpcraft.sh test-model --cp=~/myapp/target/classes --mdls=my.package.Model --jmvOpts="-ea -Xms2048m"
+ > retest-model # Rerun the last model test in REPL mode.
</pre>
</div>
<div class="tab-pane fade show" id="nav-class" role="tabpanel">
diff --git a/examples/alarm_clock.html b/examples/alarm_clock.html
index 7ff3b86..46adcc6 100644
--- a/examples/alarm_clock.html
+++ b/examples/alarm_clock.html
@@ -348,6 +348,10 @@ public class AlarmClock extends NCModelFileAdapter {
Run <code class="script">bin/nlpcraft.sh help --cmd=test-model</code> to get a full help on this command.
</li>
<li>
+ Note that you can use <code>retest-model</code> command in REPL mode to re-run the last model test
+ avoiding the retyping of all required parameters.
+ </li>
+ <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>.
diff --git a/examples/light_switch.html b/examples/light_switch.html
index 0b6043d..d52b48b 100644
--- a/examples/light_switch.html
+++ b/examples/light_switch.html
@@ -310,6 +310,10 @@ class LightSwitch extends NCModelFileAdapter("light_switch.yaml") {
Run <code class="script">bin/nlpcraft.sh help --cmd=test-model</code> to get a full help on this command.
</li>
<li>
+ Note that you can use <code>retest-model</code> command in REPL mode to re-run the last model test
+ avoiding the retyping of all required parameters.
+ </li>
+ <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>.
diff --git a/examples/sql_model.html b/examples/sql_model.html
index 7f0b8d9..e2dbb61 100644
--- a/examples/sql_model.html
+++ b/examples/sql_model.html
@@ -236,6 +236,10 @@ fa_icon: fa-cube
Run <code class="script">bin/nlpcraft.sh help --cmd=test-model</code> to get a full help on this command.
</li>
<li>
+ Note that you can use <code>retest-model</code> command in REPL mode to re-run the last model test
+ avoiding the retyping of all required parameters.
+ </li>
+ <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>.
diff --git a/examples/weather_bot.html b/examples/weather_bot.html
index 748b94b..244bf41 100644
--- a/examples/weather_bot.html
+++ b/examples/weather_bot.html
@@ -465,6 +465,10 @@ public class Weather extends NCModelFileAdapter {
Run <code class="script">bin/nlpcraft.sh help --cmd=test-model</code> to get a full help on this command.
</li>
<li>
+ Note that you can use <code>retest-model</code> command in REPL mode to re-run the last model test
+ avoiding the retyping of all required parameters.
+ </li>
+ <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>.
diff --git a/getting-started.html b/getting-started.html
index abb563b..c4c6d8c 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -66,7 +66,7 @@ id: getting_started
</p>
<pre class="brush: bash">
$ bin/nlpcraft.sh start-server
- $ bin/nlpcraft.sh start-probe --cp=./build/nlpcraft-examples/weather/nlpcraft-example-weather-{{site.latest_version}}.jar
+ $ bin/nlpcraft.sh start-probe --cp=./build/nlpcraft-examples/weather/nlpcraft-example-weather-{{site.latest_version}}.jar --mdls=org.apache.nlpcraft.examples.weather.NCWeatherModel
</pre>
<p>
At this point data probe and the REST server are started and connected.
@@ -94,7 +94,8 @@ id: getting_started
while in REPL mode whenever required.
</li>
<li>
- Use <span class="keyboard">Tab</span> key anytime for command auto-suggestion and auto-completion.
+ Use <span class="keyboard">Tab</span> key anytime for auto-completion for commands, parameters,
+ file systems paths, and model class names.
Use <span class="keyboard">↑</span> and <span class="keyboard">↓</span> keys to scroll
through command history.
</li>
diff --git a/server-and-probe.html b/server-and-probe.html
index f650a96..525b2ab 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -256,8 +256,9 @@ id: server_and_probe
<div class="tab-content">
<div class="tab-pane fade show active" id="nav-probe-script" role="tabpanel">
<pre class="brush: bash">
- $ bin/nlpcraft.sh start-probe --cp=/path/to/model/classes
+ $ bin/nlpcraft.sh start-probe --cp=/path/to/model/classes # Use default configuration.
$ bin/nlpcraft.sh start-probe --cp=/path/to/model/classes --mdls=com.package.MyModel
+ > restart-probe # Restart the probe with the last set of parameters in REPL mode.
</pre>
<p>
<b>NOTES:</b>
diff --git a/tools/script.html b/tools/script.html
index 3e8636e..8d65fe6 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -109,11 +109,11 @@ id: script
<img style="max-width: 914px !important;" class="img-fluid" alt="" src="/images/cli7.png">
</p>
<p>
- Use <span class="keyboard">Tab</span> key anytime for command auto-suggestion and auto-completion.<br/>
+ Use <span class="keyboard">Tab</span> key anytime for auto-completion for commands, parameters, file system paths, and model class names.
Use <span class="keyboard">↑</span> and <span class="keyboard">↓</span> keys to scroll through command history.
</p>
<p>
- To exit <code>bin/nlpcraft.{sh|cmd}</code> script in REPL mode type <code>quit</code>.
+ To exit <code>bin/nlpcraft.{sh|cmd}</code> script in REPL mode use <code>quit</code> command.
</p>
</section>
<section id="os_commands">
@@ -165,6 +165,13 @@ id: script
<code>test-model</code> command runs auto-validator for your model automatically starting and stopping an
embedded data probe. Alternatively, <code>start-probe</code> and <code>ask</code> commands allow to manually
start the local data probe and issue REST requests.
+ <ul>
+ <li>
+ Note that you can use <code>retest-model</code> and <code>restart-probe</code> commands in REPL mode
+ to rerun the latest model test or restart the probe with the last set of parameters accordingly avoiding
+ the retyping of all required parameters.
+ </li>
+ </ul>
</li>
<li>
Repeat steps 3 and 4 as you develop, test and debug your models and applications.