You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/08/17 02:23:27 UTC

[incubator-nlpcraft] 03/03: Updated docs for auto-test capability.

This is an automated email from the ASF dual-hosted git repository.

aradzinski pushed a commit to branch NLPCRAFT-41
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git

commit 00c473f4b0eb3dc308c662e0615d7eced38c9890
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Sun Aug 16 19:23:11 2020 -0700

    Updated docs for auto-test capability.
---
 .../scala/org/apache/nlpcraft/model/tools/test/package-info.java  | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/package-info.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/package-info.java
index aad453e..19fc8f5 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/package-info.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/package-info.java
@@ -18,7 +18,7 @@
 /**
  * Contains model testing framework.
  * <p>
- * Here's an code snippet from <code>Alarm Clock</code> example illustrating
+ * Here's an code snippet of using direct <b>test client</b> for <code>Alarm Clock</code> example illustrating
  * the usage of test framework together with JUnit 5:
  * <pre class="brush: java">
  * public class AlarmTest {
@@ -56,5 +56,11 @@
  *     }
  * }
  * </pre>
+ * <p>
+ * You can also <b>auto-test</b> the same model by using <code>NCTestAutoModelValidator</code> class without any
+ * additional coding utilizing <code>@NCIntentSample</code> annotation on the models' callback method. Add necessary classpath to:
+ * <pre class="brush: plain">
+ *     java -ea -DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
+ * </pre>
  */
 package org.apache.nlpcraft.model.tools.test;
\ No newline at end of file