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 b4f0d7a WIP.
b4f0d7a is described below
commit b4f0d7a5286c231ebedc9d80434f862657d38160
Author: Aaron Radzinzski <[email protected]>
AuthorDate: Wed Dec 2 19:05:09 2020 -0800
WIP.
---
getting-started.html | 8 ++++----
server-and-probe.html | 30 +++++++++++++++---------------
tools/sql_model_gen.html | 2 +-
tools/test_framework.html | 2 +-
4 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/getting-started.html b/getting-started.html
index 6fc966e..4a7c520 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -57,7 +57,7 @@ id: getting_started
<div class="tab-pane fade show active" id="nav-srv-start"
role="tabpanel">
<pre class="brush: plain">
$ cd build
- $ java -jar
apache-nlpcraft-{{site.latest_version}}-all-deps.jar -server
+ $ java -jar
apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar -server
</pre>
<!-- <p>-->
<!-- Alternatively, you can can also start it via Docker:-->
@@ -67,7 +67,7 @@ id: getting_started
<!-- </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-{{site.latest_version}}-all-deps.jar</code>
+ <code>ignite.xml</code> files located in the same folder
as <code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file). You should see the output similar to this:
</p>
<pre class="brush: plain">
@@ -95,11 +95,11 @@ id: getting_started
<div class="tab-pane fade show" id="nav-probe-start"
role="tabpanel">
<pre class="brush: plain">
$ cd build
- $ java -jar
apache-nlpcraft-{{site.latest_version}}-all-deps.jar -probe
+ $ java -jar
apache-nlpcraft-incubating-{{site.latest_version}}-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-{{site.latest_version}}-all-deps.jar</code> file) that
deploys
+ as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-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 ef8c8ef..5add969 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -60,18 +60,18 @@ id: server_and_probe
├── bin
├── sql
├── build
-│ └── apache-nlpcraft-{{site.latest_version}}
+│ └── apache-nlpcraft-incubating-{{site.latest_version}}
│ ├── <b>nlpcraft.conf</b>
│ ├── ignite.xml
│ ├── log4j2.xml
-│ └── <b>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</b>
+│ └──
<b>apache-nlpcraft-incubating-{{site.latest_version}}-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-{{site.latest_version}}/<b>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</b></code>.
+ necessary dependencies:
<code>build/apache-nlpcraft-incubating-{{site.latest_version}}/<b>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</b></code>.
This JAR file includes binaries for data probe, data model APIs
and the REST server.
</p>
</section>
@@ -96,20 +96,20 @@ id: server_and_probe
<div class="tab-pane fade show active" id="nav-srv-jar"
role="tabpanel">
<pre class="brush: plain">
$ cd build
- $ java -Xms1024m -jar
apache-nlpcraft-{{site.latest_version}}-all-deps.jar -server
+ $ java -Xms1024m -jar
apache-nlpcraft-incubating-{{site.latest_version}}-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-{{site.latest_version}}-all-deps.jar
org.apache.nlpcraft.NCStart -server
+ $ java -Xms1024m -cp
apache-nlpcraft-incubating-{{site.latest_version}}-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-{{site.latest_version}}-all-deps.jar</code>
+ class that is configured as <code>Main-Class</code> in
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
JAR file manifest.
</p>
</div>
@@ -136,7 +136,7 @@ id: server_and_probe
<dd>
<em>Optional</em> parameter to provide configuration file path.
Server will automatically look for <code>nlpcraft.conf</code>
configuration file in the same directory
- as
<code>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</code> file. If the
configuration
+ as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
file has different name or in different location use
<code>-config=path</code> parameter
where <code>path</code> is an absolute path to the
configuration file. Note that the server and the data
probe can use the same file for their configuration (just like
the
@@ -147,7 +147,7 @@ id: server_and_probe
<em>Optional</em> parameter to provide <a target=_
href="https://ignite.apache.org/";>Apache Ignite</a> configuration file path.
Note that Apache Ignite is used as a cluster computing plane
and a default distributed storage.
Server will automatically look for <code>ignite.xml</code>
- configuration file in the same directory as
<code>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</code> file.
+ configuration file in the same directory as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
If the configuration file has different name or in different
location use <code>-igniteConfig=path</code> parameter
where <code>path</code> is an absolute path to the Ignite
configuration file.
</dd>
@@ -212,7 +212,7 @@ id: server_and_probe
<div class="tab-pane fade show" id="nav-probe-jar" role="tabpanel">
<pre class="brush: plain">
$ cd build
- $ java -Xms1024m -jar
apache-nlpcraft-{{site.latest_version}}-all-deps.jar -probe
+ $ java -Xms1024m -jar
apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar -probe
</pre>
<div class="bq warn">
<p>
@@ -226,7 +226,7 @@ id: server_and_probe
<div class="tab-pane fade show active" id="nav-probe-cmd"
role="tabpanel">
<pre class="brush: plain">
$ cd build
- $ java -Xms1024m -cp
apache-nlpcraft-{{site.latest_version}}-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config=/my/project/probe.conf
+ $ java -Xms1024m -cp
apache-nlpcraft-incubating-{{site.latest_version}}-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.
@@ -242,7 +242,7 @@ id: server_and_probe
<b>Class <code>org.apache.nlpcraft.NCStart</code></b>
<p>
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-{{site.latest_version}}-all-deps.jar</code>
+ class that is configured as <code>Main-Class</code> in
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
JAR file manifest.
</p>
</div>
@@ -261,7 +261,7 @@ id: server_and_probe
<p>
<em>Optional</em> parameter to provide probe configuration
file path.
Data probe will automatically look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</code> file. If the
configuration
+ as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
file has different name or in different location use
<code>-config=path</code> parameter
where <code>path</code> is an absolute path to the data
probe configuration file. Note that the server and the data
probe can use the same file for their configuration (just
like the
@@ -274,12 +274,12 @@ id: server_and_probe
<p>
Note that when you are using a <em>command line</em> to start
the probe you can also add your own classes that implement
your models. To do that you need to use <code>-cp</code>
option instead of <code>-jar</code> and
- construct your JVM classpath to include both the
<code>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</code>
+ construct your JVM classpath to include both the
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
as well as directory where your compiled Java code is located:
</p>
<pre class="brush: plain, highlight: 2">
$ cd build
- $ java -cp
apache-nlpcraft-{{site.latest_version}}-all-deps.jar:/my/project/classes
org.apache.nlpcraft.NCStart -probe -config /my/project/probe.conf
+ $ java -cp
apache-nlpcraft-incubating-{{site.latest_version}}-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.
@@ -358,7 +358,7 @@ id: server_and_probe
<p>
By default, when REST server or data probe start they look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-{{site.latest_version}}-all-deps.jar</code> file and the
on their classpath. You can change this behavior with
+ as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file and the on their classpath. You can change this behavior with
<code>-config=path</code> parameter.
</p>
<p>
diff --git a/tools/sql_model_gen.html b/tools/sql_model_gen.html
index 5716dc3..19138ec 100644
--- a/tools/sql_model_gen.html
+++ b/tools/sql_model_gen.html
@@ -157,7 +157,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 4ea31ea..488ce83 100644
--- a/tools/test_framework.html
+++ b/tools/test_framework.html
@@ -189,7 +189,7 @@ java -ea
-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel or
</p>
<ul>
<li>
- When running auto validator from command line you set models
to test via <code>NLPCRAFT_TEST_MODELS</code>
+ 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.
</li>
</ul>
