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.git
commit 632a5db8580b84cb61b9f6714b2ffc23d8e77afa
Author: Aaron Radzinski <aradzin...@datalingvo.com>
AuthorDate: Tue Mar 29 12:52:14 2022 -0700
Update NCPipeline.java
---
.../main/scala/org/apache/nlpcraft/NCPipeline.java | 26 ++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
index 0683aa6..1e8b440 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
@@ -22,6 +22,32 @@ import java.util.List;
import java.util.Optional;
/**
+ * Input request NLP processing pipeline.
+ * <p>
+ * An NLP pipeline is a container for various processing components that take
the input text at the beginning of the
+ * pipeline and produce the list of {@link NCEntity entities} at the end of
the pipeline.
+ * <p>
+ * Schematically the pipeline looks like this:
+ * <pre>
+ * +----------+ +-----------+
+ * *=========* +---------+ +---+-------+ | +---+-------+ |
+ * : Text : -> | Token | -> | Token | | -> | Token | | ---.
+ * : Input : | Parser | | Enrichers |--+ | Validators |--+ \
+ * *=========* +---------+ +-----------+ +------------+ \
+ * \
+ *
}
+ * +-----------+ +----------+ +--------+ /
+ * *=========* +---+--------+ | +---+-------+ | +---+-----+ | /
+ * : Entity : <- | Entity | | <- | Entity | | <- | Entity | | <-'
+ * : List : | Validators |--+ | Enrichers |--+ | Parsers |--+
+ * *=========* +------------+ +-----------+ +---------+
+ * </pre>
+ * <p>
+ * Pipeline has the following components:
+ * <ul>
+ * <li></li>
+ * </ul>
+ *
*
*/
public interface NCPipeline {
