This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-513
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/NLPCRAFT-513 by this push:
new 536cc03 WIP
536cc03 is described below
commit 536cc03015cc0b496b67056fb4a2a9210e915148
Author: Aaron Radzinski <[email protected]>
AuthorDate: Fri Nov 18 13:06:21 2022 -0800
WIP
---
_includes/left-side-menu.html | 4 +--
_scss/misc.scss | 2 +-
first-example.html | 3 +++
key_concepts.html => key-concepts.html | 46 +++++++++++++++++++++++-----------
4 files changed, 38 insertions(+), 17 deletions(-)
diff --git a/_includes/left-side-menu.html b/_includes/left-side-menu.html
index 75e3da7..d453c25 100644
--- a/_includes/left-side-menu.html
+++ b/_includes/left-side-menu.html
@@ -42,9 +42,9 @@
<li class="side-nav-title">Developer Guide</li>
<li>
{% if page.id == "key_concepts" %}
- <a class="active" href="/key_concepts.html">Key Concepts</a>
+ <a class="active" href="/key-concepts.html">Key Concepts</a>
{% else %}
- <a href="/key_concepts.html">Key Concepts</a>
+ <a href="/key-concepts.html">Key Concepts</a>
{% endif %}
</li>
<li>
diff --git a/_scss/misc.scss b/_scss/misc.scss
index f23eb48..9ddb5a4 100644
--- a/_scss/misc.scss
+++ b/_scss/misc.scss
@@ -360,7 +360,7 @@ $bq-success-border-color: $brand-success;
}
.not-code {}
-a[target=javadoc]:not(.not-code) {
+a[target=scaladoc]:not(.not-code) {
font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono",
"Courier New", monospace;
word-break: keep-all;
white-space: nowrap !important;
diff --git a/first-example.html b/first-example.html
index 484340f..d48f5cc 100644
--- a/first-example.html
+++ b/first-example.html
@@ -24,6 +24,9 @@ id: first-example
<div class="col-md-8 second-column">
<section id="setup">
<h2 class="section-title">Overview <a href="#"><i class="top-link fas
fa-fw fa-angle-double-up"></i></a></h2>
+ <p>
+ It is highly recommended to familiarize yourself with the <a
href="/key-concepts.html">key concepts</a> first.
+ </p>
<p>
Let's develop the first NLPCraft example to familiarize ourselves
with the main workflow of NLPCraft.
We'll put together a NLI-powered home light switch prototype that
can be controlled through the natural language.
diff --git a/key_concepts.html b/key-concepts.html
similarity index 89%
rename from key_concepts.html
rename to key-concepts.html
index f421684..b31b27e 100644
--- a/key_concepts.html
+++ b/key-concepts.html
@@ -76,8 +76,8 @@ id: key_concepts
according to some rules. For example, the user input
"<b>Where is it?</b>" contains four tokens:
"<code>Where</code>", "<code>is</code>",
"<code>it</code>", "<code>?</code>".
Usually <code>tokens</code> are words and punctuation
symbols which also contain additional
- information like point of speech tags, relative position
in the overall input text, stem and lemma forms, etc.
- List of parsed <code>tokens</code> serves as an input for
parsing <code>entities</code>.
+ information like point of speech tags, relative position
in the overall input text, stopword flag,
+ stem and lemma forms, etc. List of parsed
<code>tokens</code> serves as an input for parsing <code>entities</code>.
</td>
</tr>
<tr>
@@ -85,21 +85,39 @@ id: key_concepts
<td>
<code>Entity</code> typically represents a real-world
object, such as a person, location, organization,
or product that can often be denoted with a proper name.
It can be abstract or have a physical existence.
- Each <code>entity</code> consists of zero or more
<code>tokens</code>. Entities form one or more parsing
- <code>variants</code> that serve as an input to <a
href="intent-matching.html">Intent matching</a>.
+ Each <code>entity</code> consists of zero or more
<code>tokens</code>. Combination of entities form one or more parsing
+ <code>variants</code>.
</td>
</tr>
<tr>
- <td><code>Variant</code></td>
+ <td><b>{% scaladoc NCVariant NCVariant %}</b></td>
<td>
- <code>Variant</code> represented as {% scaladoc NCVariant
NCVariant %}
- is a set of <code>entities</code> list. Potentially, each
<code>token</code> or group
- of <code>tokens</code> can be recognized as different
<code>entities</code>,
- so user input can be processed as set of
<code>variants</code>.
- For example user input <b>look at this crane</b> can be
processed as two <code>variants</code>,
- one of them contains <code>entity</code> <b>bird</b> and
one contains <code>entity</code> <b>mechanism</b>.
- When words are not overlapped with different
<code>entities</code> there is only one
- <code>variant</code> detected.
+ <code>Variant</code> is a unique set of
<code>entities</code>. In many cases, a <code>token</code> or a group
+ of <code>tokens</code> can be recognized as more than one
<code>entity</code> - resulting in multiple possible
+ interpretations of the original sequence of tokens. Each
such interpretation is defined as a parsing <code>variant</code>.
+ For example, user input <b>"Look at this crane."</b> can
be interpreted as two <code>variants</code>,
+ one of them containing <code>entity</code>
<b>BIRD<sub>[crane]</sub></b> and another containing <code>entity</code>
<b>MACHINE<sub>[crane]</sub></b>.
+ Set of <code>variants</code> ultimately serves as an input
to <a href="intent-matching.html">intent matching</a>.
+ </td>
+ </tr>
+ <tr>
+ <td><b>{% scaladoc NCPipeline NCPipeline %}</b></td>
+ <td>
+ <code>Variant</code> is a unique set of
<code>entities</code>. In many cases, a <code>token</code> or a group
+ of <code>tokens</code> can be recognized as more than one
<code>entity</code> - resulting in multiple possible
+ interpretations of the original sequence of tokens. Each
such interpretation is defined as a parsing <code>variant</code>.
+ For example, user input <b>"Look at this crane."</b> can
be interpreted as two <code>variants</code>,
+ one of them containing <code>entity</code>
<b>BIRD<sub>[crane]</sub></b> and another containing <code>entity</code>
<b>MACHINE<sub>[crane]</sub></b>.
+ </td>
+ </tr>
+ <tr>
+ <td><b><a target="scaladoc"
href="/apis/latest/">@NCIntent</a></b></td>
+ <td>
+ <code>Variant</code> is a unique set of
<code>entities</code>. In many cases, a <code>token</code> or a group
+ of <code>tokens</code> can be recognized as more than one
<code>entity</code> - resulting in multiple possible
+ interpretations of the original sequence of tokens. Each
such interpretation is defined as a parsing <code>variant</code>.
+ For example, user input <b>"Look at this crane."</b> can
be interpreted as two <code>variants</code>,
+ one of them containing <code>entity</code>
<b>BIRD<sub>[crane]</sub></b> and another containing <code>entity</code>
<b>MACHINE<sub>[crane]</sub></b>.
</td>
</tr>
@@ -108,7 +126,7 @@ id: key_concepts
<figure>
<img alt="named entities" class="img-fluid"
src="/images/text-tokens-entities2.png">
- <figcaption><b>Fig 1.</b> Text -> Tokens -> Entities.</figcaption>
+ <figcaption><b>Fig 1.</b> Text -> Tokens -> Entities -> Parsing
Variants.</figcaption>
</figure>
<p>
