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 b51e6a5 WIP.
b51e6a5 is described below
commit b51e6a5f787ff6272e1de97bbe8973829308de59
Author: Aaron Radzinski <[email protected]>
AuthorDate: Mon May 10 18:43:41 2021 -0700
WIP.
---
_scss/misc.scss | 8 ++++++++
basic-concepts.html | 30 ++++++++++++++++--------------
blogs/composable_named_entities.html | 2 +-
blogs/quick_intro_apache_nlpcraft.html | 2 +-
blogs/short_term_memory.html | 15 ++++++++++-----
cheat-sheet.html | 2 +-
data-model.html | 34 +++++++++++++++++++++-------------
7 files changed, 58 insertions(+), 35 deletions(-)
diff --git a/_scss/misc.scss b/_scss/misc.scss
index a4b852b..1aa6f54 100644
--- a/_scss/misc.scss
+++ b/_scss/misc.scss
@@ -285,6 +285,14 @@ $bq-success-border-color: $brand-success;
padding-right: 5px;
color: $bq-success-border-color;
}
+
+ div.bq-idea-container {
+ display: inline-flex;
+
+ div:nth-child(1) {
+ margin-right: 7px;
+ }
+ }
}
.gradient-table {
diff --git a/basic-concepts.html b/basic-concepts.html
index 89b20c9..643765e 100644
--- a/basic-concepts.html
+++ b/basic-concepts.html
@@ -47,9 +47,9 @@ id: basic_concepts
A data model defines:
</p>
<ul>
- <li>Set of model <a href="data-model.html">elements</a> (a.k.a.
<em>named entities</em>) to be detected in the user input.</li>
- <li>How to query a particular data source based on detected named
entities.</li>
- <li>Common model configuration and <a
href="data-model.html">life-cycle</a> callbacks.</li>
+ <li>Set of model <a href="data-model.html#elements">elements</a>
(a.k.a. named entities) to be detected in the user input.</li>
+ <li>Zero or more intents and their callbacks.</li>
+ <li>Common model configuration and various life-cycle
callbacks.</li>
</ul>
<p>
Note that model-as-a-code approach allows you to use any software
lifecycle tools and
@@ -64,8 +64,8 @@ id: basic_concepts
<section id="ne">
<h2 class="section-sub-title">Named Entities <a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
- Named entity, also known as a model element or a token, is main a
component defined by the NLPCraft data model. A named
- entity is one or more individual words that have a consistent
semantic meaning and typically denote a
+ Named entity, also known as a model element or a token, is one of
the main a components defined by the NLPCraft data model.
+ A named entity is one or more individual words that have a
consistent semantic meaning and typically denote a
real-world object, such as persons, locations, number, date and
time, organizations, products, etc. Such
object can be abstract or have a physical existence.
</p>
@@ -112,15 +112,14 @@ id: basic_concepts
<p>
In most cases named entities will have associated <em>normalized
value</em>. It is especially important for named entities that have many
different notational forms such as time and date, currency,
geographical locations, etc. For example, <code>New York</code>,
- <code>New York City</code> and <code>NYC</code> all refer to the
same "New York City, NY USA" location which is a valid normalized form.
+ <code>New York City</code> and <code>NYC</code> all refer to the
same "New York City, NY USA" location which is a standard normalized form.
</p>
<p>
The process of detecting named entities is called Named Entity
Recognition (NER). There are many
different ways of how a certain named entity can be detected:
through list of synonyms, by name, rule-based or by using
- statistical techniques like neural networks with large corpus of
predefined data. NLPCraft allows you define
- named entities through powerful <a
href="/intent-matching.html">Intent Definition Language</a> (IDL)) and also
supports named
- entities that can be composed from other named entities
- including named entities from external projects such OpenNLP,
spaCy or Stanford CoreNLP.
+ statistical techniques like neural networks with large corpus of
predefined data. NLPCraft natively supports synonym-based
+ named entities definition as well as the ability to compose
compose new named entities through powerful <a
href="/intent-matching.html">Intent Definition Language</a> (IDL)
+ combining other named entities including named entities from
external projects such OpenNLP, spaCy or Stanford CoreNLP.
</p>
<p>
Named entities allow you to abstract from basic linguistic forms
like nouns and verbs to deal with the higher level semantic
@@ -145,10 +144,13 @@ id: basic_concepts
conversational STM that is used to fill in missing tokens from
memory.
</p>
<div class="bq success">
- <p>
- You can think of NLPCraft data model as a mechanism to define
named entities and intents that use
- these named entities to pattern match the user input.
- </p>
+ <div class="bq-idea-container">
+ <div><div>💡</div></div>
+ <div>
+ You can think of NLPCraft data model as a mechanism to
define named entities and intents that use
+ these named entities to pattern match the user input.
+ </div>
+ </div>
</div>
<p>
Learn more details about intent matching <a
href="intent-matching.html">here</a>.
diff --git a/blogs/composable_named_entities.html
b/blogs/composable_named_entities.html
index 0472ce2..b3488e0 100644
--- a/blogs/composable_named_entities.html
+++ b/blogs/composable_named_entities.html
@@ -26,7 +26,7 @@ publish_date: January 20, 2021
-->
<section>
- <div class="bq success">
+ <div class="bq info">
This blog is an English adaptation of Sergey Kamov's <a target=habr
href="https://habr.com/ru/post/530878/">blog</a> written in Russian.
</div>
<p>
diff --git a/blogs/quick_intro_apache_nlpcraft.html
b/blogs/quick_intro_apache_nlpcraft.html
index 43eaee0..71f69a0 100644
--- a/blogs/quick_intro_apache_nlpcraft.html
+++ b/blogs/quick_intro_apache_nlpcraft.html
@@ -26,7 +26,7 @@ publish_date: November 16, 2020
-->
<section>
- <div class="bq success">
+ <div class="bq info">
This blog is an English adaptation of Sergey Kamov's <a target=habr
href="https://habr.com/ru/post/526950/">blog</a> written in Russian.
</div>
<p>
diff --git a/blogs/short_term_memory.html b/blogs/short_term_memory.html
index ca3171e..9d5484d 100644
--- a/blogs/short_term_memory.html
+++ b/blogs/short_term_memory.html
@@ -104,7 +104,7 @@ publish_date: July 26, 2019
Entities that additionally have one or more specific values like
<code>current</code> and <code>Tokyo</code> entities.
</li>
</ul>
- <div class="bq success">
+ <div class="bq info">
<div style="display: inline-block; margin-bottom: 20px">
<a style="margin-right: 10px" target="opennlp"
href="https://opennlp.apache.org"><img src="/images/opennlp-logo.png"
height="32px" alt=""></a>
<a style="margin-right: 10px" target="google"
href="https://cloud.google.com/natural-language/"><img
src="/images/google-cloud-logo-small.png" height="32px" alt=""></a>
@@ -266,10 +266,15 @@ publish_date: July 26, 2019
Here's the rule we developed at NLPCraft and have been successfully
using in various models:
</p>
<div class="bq success">
- <b>Overriding Rule</b>
- <p>
- The entity will override other entity or entities in STM that
belong to the same group set or its superset.
- </p>
+ <div class="bq-idea-container">
+ <div><div>💡</div></div>
+ <div>
+ <b>Overriding Rule</b>
+ <p>
+ The entity will override other entity or entities in STM
that belong to the same group set or its superset.
+ </p>
+ </div>
+ </div>
</div>
<p>
In other words, an entity with a smaller group set (more specific one)
will override entity with the same
diff --git a/cheat-sheet.html b/cheat-sheet.html
index 6fdf21d..8d076f1 100644
--- a/cheat-sheet.html
+++ b/cheat-sheet.html
@@ -484,7 +484,7 @@ id: cheat_sheet
</div>
</div>
</div>
- <div class="bq success">
+ <div class="bq info">
<p>
<b>NOTES:</b>
</p>
diff --git a/data-model.html b/data-model.html
index 93ad47e..879fc2b 100644
--- a/data-model.html
+++ b/data-model.html
@@ -36,7 +36,7 @@ id: data_model
</p>
<ul>
<li>Set of model <a href="#elements">elements</a> (a.k.a. named
entities) to be detected in the user input.</li>
- <li>Zero or more intent callbacks.</li>
+ <li>Zero or more intents and their callbacks.</li>
<li>Common model configuration and various life-cycle
callbacks.</li>
</ul>
<p>
@@ -265,13 +265,18 @@ public class AlarmModel extends NCModelFileAdapter {
<a target="javadoc"
href="/apis/latest/org/apache/nlpcraft/model/NCModelFactory.html">NCModelFactory</a>
for more information.
</p>
<div class="bq success">
- <p>
- <b>Using Adapters</b>
- </p>
- <p>
- It is recommended to use one of the adapter classes when
defining your
- own data model in the most uses cases.
- </p>
+ <div class="bq-idea-container">
+ <div><div>💡</div></div>
+ <div>
+ <p>
+ <b>Using Adapters</b>
+ </p>
+ <p>
+ It is recommended to use one of the adapter classes
when defining your
+ own data model in the most uses cases.
+ </p>
+ </div>
+ </div>
</div>
<h2 id="deployment" class="section-title">Deployment <a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
@@ -457,11 +462,14 @@ intents:
</div>
</div>
<div class="bq success">
- <p>
- Note that using JSON/YAML-based configuration is a
<b>canonical way</b> for
- creating data models in NLPCraft as it allows to cleanly
separate static configuration from model's
- programmable logic.
- </p>
+ <div class="bq-idea-container">
+ <div><div>💡</div></div>
+ <div>
+ Note that using JSON/YAML-based configuration is a
<b>canonical way</b> for
+ creating data models in NLPCraft as it allows to cleanly
separate static configuration from model's
+ programmable logic.
+ </div>
+ </div>
</div>
</section>
<section id="elements">