This is an automated email from the ASF dual-hosted git repository.
sergeykamov 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 86424ef WIP.
86424ef is described below
commit 86424ef9fb95b71593acad7b89f2019c350849e3
Author: skhdl <[email protected]>
AuthorDate: Thu Nov 3 16:04:39 2022 +0400
WIP.
---
api-components.html | 10 +++++++++-
built-in-builder.html | 2 +-
built-in-entity-parser.html | 4 ++--
built-in-overview.html | 4 ++++
built-in-token-enricher.html | 4 ++--
built-in-token-parser.html | 4 ++--
custom-components.html | 2 ++
7 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/api-components.html b/api-components.html
index b21d876..74d0e1e 100644
--- a/api-components.html
+++ b/api-components.html
@@ -331,6 +331,7 @@ id: api-components
<code>Tokens enricher</code> is a component which allow to
add additional properties for prepared tokens,
like part of speech, quote, stop-words flags or any other.
NLPCraft provides built-in English language set of token
enrichers implementations.
+ Here is an <a
href="custom-components.html#token-enrichers">example</a>.
</td>
</tr>
<tr>
@@ -339,6 +340,7 @@ id: api-components
<td>
<code>Token validator</code> is a component which allow to
inspect prepared tokens and
throw an exception to break user input processing.
+ Here is an <a
href="custom-components.html#token-validators">example</a>.
</td>
</tr>
<tr>
@@ -351,6 +353,7 @@ id: api-components
<a href="https://opennlp.apache.org/";>Apache OpenNLP</a>
and
<a href="https://nlp.stanford.edu/";>Stanford NLP</a> and
its own implementations.
Note that at least one entity parser must be defined.
+ Here is an <a
href="custom-components.html#entity-parsers">example</a>.
</td>
</tr>
<tr>
@@ -359,6 +362,7 @@ id: api-components
<td>
<code>Entity enricher</code> is component which allows to
add additional properties for prepared entities.
Can be useful for extending existing entity enrichers
functionality.
+ Here is an <a
href="custom-components.html#entity-enrichers">example</a>.
</td>
</tr>
<tr>
@@ -367,6 +371,7 @@ id: api-components
<td>
<code>Entity mappers</code> is component which allows to
map one set of entities to another after the entities
were parsed and enriched. Can be useful for building
complex parsers based on existing.
+ Here is an <a
href="custom-components.html#entity-mappers">example</a>.
</td>
</tr>
<tr>
@@ -375,13 +380,16 @@ id: api-components
<td>
<code>Entity validator</code> is a component which allow
to inspect prepared entities and
throw an exception to break user input processing.
+ Here is an <a
href="custom-components.html#entity-validators">example</a>.
</td>
</tr>
<tr>
<td> {% scaladoc NCVariantFilter NCVariantFilter %}</td>
<td>Optional single</td>
<td>
- <code>Variant filter</code> is a component which allows
filtering detected variants and rejecting undesirable.
+ <code>Variant filter</code> is a component which allows
filtering detected variants and
+ rejecting undesirable.
+ Here is an <a
href="custom-components.html#variant-filters">example</a>.
</td>
</tr>
</tbody>
diff --git a/built-in-builder.html b/built-in-builder.html
index a5d9b04..dd13e3e 100644
--- a/built-in-builder.html
+++ b/built-in-builder.html
@@ -23,7 +23,7 @@ id: built-in-builder
<div class="col-md-8 second-column">
<section id="overview">
- <h2 class="section-title">Pipeline builder<a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
+ <h2 class="section-title">Pipeline Builder<a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
{% scaladoc NCPipelineBuilder NCPipelineBuilder %} class
diff --git a/built-in-entity-parser.html b/built-in-entity-parser.html
index 8f0c9a1..24e1756 100644
--- a/built-in-entity-parser.html
+++ b/built-in-entity-parser.html
@@ -26,8 +26,8 @@ id: built-in-entity-parser
<h2 class="section-title">Overview<a href="#"><i class="top-link fas
fa-fw fa-angle-double-up"></i></a></h2>
<p>
- {% scaladoc NCEntityParser NCEntityParser %}
- is a component which allows to find user defined named entities
+ {% scaladoc NCEntityParser NCEntityParser %} trait is part <a
href="api-components.html#model-pipeline">Model Pipeline</a>.
+ Its implementation should allow to find user defined named entities
based on prepared tokens as input.
</p>
diff --git a/built-in-overview.html b/built-in-overview.html
index 8eebc84..5f8dd5a 100644
--- a/built-in-overview.html
+++ b/built-in-overview.html
@@ -52,6 +52,10 @@ id: built-in-overview
</li>
</ul>
+ <p>
+ <a href="built-in-builder.html">Pipeline Builder</a> section
describes helpers class and its methods for pipeline creation.
+ </p>
+
<div class="bq info">
<p><b>Built-in component licenses.</b></p>
<p>
diff --git a/built-in-token-enricher.html b/built-in-token-enricher.html
index 592dcff..5f23082 100644
--- a/built-in-token-enricher.html
+++ b/built-in-token-enricher.html
@@ -26,8 +26,8 @@ id: built-in-token-enricher
<h2 class="section-title">Overview<a href="#"><i class="top-link fas
fa-fw fa-angle-double-up"></i></a></h2>
<p>
- {% scaladoc NCTokenEnricher NCTokenEnricher %}
- is a component which allows to add additional properties to
prepared tokens,
+ {% scaladoc NCTokenEnricher NCTokenEnricher %} trait is part of <a
href="api-components.html#model-pipeline">Model Pipeline</a>.
+ Its implementation should allow to add additional properties to
prepared tokens,
like part of speech, quote, stop-words flags or any other.
NLPCraft provides English language default set of token enrichers
implementations.
</p>
diff --git a/built-in-token-parser.html b/built-in-token-parser.html
index cb684dc..e9bac95 100644
--- a/built-in-token-parser.html
+++ b/built-in-token-parser.html
@@ -26,8 +26,8 @@ id: built-in-token-parser
<h2 class="section-title">Overview<a href="#"><i class="top-link fas
fa-fw fa-angle-double-up"></i></a></h2>
<p>
- {% scaladoc NCTokenParser NCTokenParser %}
- component implementation should parse user input plain text and
split this text
+ {% scaladoc NCTokenParser NCTokenParser %} trait is part <a
href="api-components.html#model-pipeline">Model Pipeline</a>.
+ Its implementation should parse user input plain text and split
this text
into <code>tokens</code> list.
NLPCraft provides two English language token parser
implementations:
<a href="#parser-opennlp">Apache OpenNLP Based Parser</a> and
diff --git a/custom-components.html b/custom-components.html
index 192a43b..ee8e94d 100644
--- a/custom-components.html
+++ b/custom-components.html
@@ -26,6 +26,8 @@ id: custom-components
<h2 class="section-title">Overview <a href="#"><i class="top-link fas
fa-fw fa-angle-double-up"></i></a></h2>
<p>
+ <a href="api-components.html#model-pipeline">Model Pipeline</a>
contains a chain of component traits
+ which are responsible for sentence processing.
NLPCraft provides a numeric of useful <a
href="/built-in-overview.html">built-in components</a> which allow to solve a
wide range of tasks
without coding.
But you can need to extend provided functionality and develop your
own components.
