This is an automated email from the ASF dual-hosted git repository.
sergeykamov pushed a commit to branch NLPCRAFT-468
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-468 by this push:
new 32fa9af1 WIP.
32fa9af1 is described below
commit 32fa9af1583a52e53cab0a92cfd594addd671bde
Author: Sergey Kamov <[email protected]>
AuthorDate: Wed Oct 13 09:45:38 2021 +0300
WIP.
---
.../scala/org/apache/nlpcraft/model/readme.txt | 45 ++++++++++++++++++++++
1 file changed, 45 insertions(+)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/readme.txt
b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/readme.txt
new file mode 100644
index 0000000..a58bc98
--- /dev/null
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/readme.txt
@@ -0,0 +1,45 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Interfaces, which can be implemented by user.
+(All of them already have built-in implementations)
+
+1. org.apache.nlpcraft.model.nlp.NCNlpTokenizer. Text-to-words tokenizer.
+Delivered:
+ - org.apache.nlpcraft.model.components.tokenizer.NCOpenNlpTokenizer (not
configured)
+ - Stanford impl.
+Default in config - NCOpenNlpTokenizer.
+
+2. org.apache.nlpcraft.model.nlp.NCNlpNerParse. Ners finder.
+Delivered:
+ - org.apache.nlpcraft.model.components.ner.opennlp.NCOpenNlpNerParser
(configured types from predefined set of supported NERS: DATE, PERSON etc)
+ - stanford impl (configured types from predefined set of supported NERS:
DATE, PERSON etc)
+ - org.apache.nlpcraft.model.components.ner.synonyms.NCSynonymsNerParser
(configured by synonyms, macros ect)
+Default in config - empty list.
+
+3. org.apache.nlpcraft.model.nlp.NCNlpWordsDetector. Special words finder.
+Delivered:
+ - org.apache.nlpcraft.model.components.detectors.NCDefaultStopWordsDetector
(EN, configured with additional and excluded words set)
+ - org.apache.nlpcraft.model.components.detectors.NCDefaultSwearWordsDetector
(EN, not configured)
+ - org.apache.nlpcraft.model.components.detectors.NCConfiguredWordsDetector
(configured by simple words set)
+Default in config - NCDefaultStopWordsDetector, NCDefaultSwearWordsDetector
+(`suspicious` doesn't have by default. Can be configured by
NCConfiguredWordsDetector)
+
+4. org.apache.nlpcraft.model.NCModelBehaviour
+Delivered:
+ - No special implementation, this interface has all empty default methods.
+Default in config - empty implementation.
\ No newline at end of file
