First draft of documentation

Roboy · Jan 25, 2018 · fd6cfef · fd6cfef
1 parent 9b4aad3
commit fd6cfef
Show file tree

Hide file tree

Showing 378 changed files with 6,368 additions and 3,090 deletions.
diff --git a/docs/Usage/6_semantic_parser.rst b/docs/Usage/6_semantic_parser.rst
@@ -0,0 +1,42 @@
+Semantic Parser
+===============
+
+Semantic parser is used to translate text representation into formal language representation. The aim is to be able to process user utterances and react upon them. 
+
+roboy_parser is based on [SEMPRE](https://nlp.stanford.edu/software/sempre/). It is currently being modified to fulfill Roboy Dialog system needs. 
+
+
+Installation
+------------
+
+In order to use semantic parser, you need to clone roboy_parser repository::
+	git clone https://github.com/Roboy/roboy_parser
+
+navigate to created repository::
+	cd roboy_parser
+
+build it::
+	ant freebase
+
+and run it::
+	./quick_start [options]
+
+
+Implementation
+--------------
+
+roboy_parser is 
+
+
+Functionalities
+"""""""""""""""
+
+
+Usage
+-----
+
+Options
+"""""""
+
+Options
+"""""""
diff --git a/docs/doxyxml/_abstract_boolean_state_8java.xml b/docs/doxyxml/_abstract_boolean_state_8java.xml
@@ -69,6 +69,6 @@
 <codeline lineno="83"><highlight class="normal"></highlight></codeline>
 <codeline lineno="84"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/dialog/personality/states/AbstractBooleanState.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/dialog/personality/states/AbstractBooleanState.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_abstract_value_8java.xml b/docs/doxyxml/_abstract_value_8java.xml
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.11">
+  <compounddef id="_abstract_value_8java" kind="file" language="Java">
+    <compoundname>AbstractValue.java</compoundname>
+    <innerclass refid="interfaceroboy_1_1context_1_1_abstract_value" prot="public">roboy::context::AbstractValue</innerclass>
+    <innernamespace refid="namespaceroboy_1_1context">roboy::context</innernamespace>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline lineno="1"><highlight class="keyword">package<sp/></highlight><highlight class="normal">roboy.context;</highlight></codeline>
+<codeline lineno="2"><highlight class="normal"></highlight></codeline>
+<codeline lineno="7" refid="interfaceroboy_1_1context_1_1_abstract_value" refkind="compound"><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">interface<sp/></highlight><highlight class="normal"><ref refid="interfaceroboy_1_1context_1_1_abstract_value" kindref="compound">AbstractValue</ref>&lt;V&gt;<sp/>{</highlight></codeline>
+<codeline lineno="8"><highlight class="normal"><sp/><sp/><sp/><sp/>V<sp/>getValue();</highlight></codeline>
+<codeline lineno="9"><highlight class="normal"></highlight></codeline>
+<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>updateValue(V<sp/>key);</highlight></codeline>
+<codeline lineno="11"><highlight class="normal">}</highlight></codeline>
+    </programlisting>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/context/AbstractValue.java"/>
+  </compounddef>
+</doxygen>
diff --git a/docs/doxyxml/_abstract_value_history_8java.xml b/docs/doxyxml/_abstract_value_history_8java.xml
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.11">
+  <compounddef id="_abstract_value_history_8java" kind="file" language="Java">
+    <compoundname>AbstractValueHistory.java</compoundname>
+    <innerclass refid="interfaceroboy_1_1context_1_1_abstract_value_history" prot="public">roboy::context::AbstractValueHistory</innerclass>
+    <innernamespace refid="namespaceroboy_1_1context">roboy::context</innernamespace>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline lineno="1"><highlight class="keyword">package<sp/></highlight><highlight class="normal">roboy.context;</highlight></codeline>
+<codeline lineno="2"><highlight class="normal"></highlight></codeline>
+<codeline lineno="3"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/>java.util.Map;</highlight></codeline>
+<codeline lineno="4"><highlight class="normal"></highlight></codeline>
+<codeline lineno="9" refid="interfaceroboy_1_1context_1_1_abstract_value_history" refkind="compound"><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">interface<sp/></highlight><highlight class="normal"><ref refid="interfaceroboy_1_1context_1_1_abstract_value_history" kindref="compound">AbstractValueHistory</ref>&lt;K,<sp/>V&gt;<sp/></highlight><highlight class="keyword">extends</highlight><highlight class="normal"><sp/><ref refid="interfaceroboy_1_1context_1_1_abstract_value" kindref="compound">AbstractValue</ref>&lt;V&gt;<sp/>{</highlight></codeline>
+<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/>Map&lt;K,<sp/>V&gt;<sp/>getLastNValues(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>n);</highlight></codeline>
+<codeline lineno="11"><highlight class="normal">}</highlight></codeline>
+    </programlisting>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/context/AbstractValueHistory.java"/>
+  </compounddef>
+</doxygen>
diff --git a/docs/doxyxml/_action_8java.xml b/docs/doxyxml/_action_8java.xml
@@ -15,6 +15,6 @@
 <codeline lineno="9"><highlight class="normal"></highlight></codeline>
 <codeline lineno="10"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/dialog/action/Action.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/dialog/action/Action.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_analyzer_8java.xml b/docs/doxyxml/_analyzer_8java.xml
@@ -17,6 +17,6 @@
 <codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight></codeline>
 <codeline lineno="12"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/linguistics/sentenceanalysis/Analyzer.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/linguistics/sentenceanalysis/Analyzer.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_anecdote_state_8java.xml b/docs/doxyxml/_anecdote_state_8java.xml
@@ -44,6 +44,6 @@
 <codeline lineno="36"><highlight class="normal"></highlight></codeline>
 <codeline lineno="37"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/dialog/personality/states/AnecdoteState.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/dialog/personality/states/AnecdoteState.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_answer_analyzer_8java.xml b/docs/doxyxml/_answer_analyzer_8java.xml
@@ -99,6 +99,6 @@
 <codeline lineno="98"><highlight class="normal"></highlight></codeline>
 <codeline lineno="99"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/linguistics/sentenceanalysis/AnswerAnalyzer.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/linguistics/sentenceanalysis/AnswerAnalyzer.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_answer_analyzer_test_8java.xml b/docs/doxyxml/_answer_analyzer_test_8java.xml
@@ -104,6 +104,6 @@
 <codeline lineno="93"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight></codeline>
 <codeline lineno="94"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/test/java/roboy/linguistics/sentenceanalysis/AnswerAnalyzerTest.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/test/java/roboy/linguistics/sentenceanalysis/AnswerAnalyzerTest.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_attribute_manager_8java.xml b/docs/doxyxml/_attribute_manager_8java.xml
@@ -35,6 +35,6 @@
 <codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="28"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/context/AttributeManager.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/context/AttributeManager.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_bing_input_8java.xml b/docs/doxyxml/_bing_input_8java.xml
@@ -30,6 +30,6 @@
 <codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight></codeline>
 <codeline lineno="23"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/BingInput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/BingInput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_bing_output_8java.xml b/docs/doxyxml/_bing_output_8java.xml
@@ -40,6 +40,6 @@
 <codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight></codeline>
 <codeline lineno="33"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/BingOutput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/BingOutput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_celebrity_similarity_input_8java.xml b/docs/doxyxml/_celebrity_similarity_input_8java.xml
@@ -25,6 +25,6 @@
 <codeline lineno="17"><highlight class="normal"></highlight></codeline>
 <codeline lineno="18"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/CelebritySimilarityInput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/CelebritySimilarityInput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_celebrity_state_8java.xml b/docs/doxyxml/_celebrity_state_8java.xml
@@ -98,6 +98,6 @@
 <codeline lineno="92"><highlight class="normal"></highlight></codeline>
 <codeline lineno="93"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/dialog/personality/states/CelebrityState.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/dialog/personality/states/CelebrityState.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_cerevoice_output_8java.xml b/docs/doxyxml/_cerevoice_output_8java.xml
@@ -43,6 +43,6 @@
 <codeline lineno="35"><highlight class="normal"></highlight></codeline>
 <codeline lineno="36"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/CerevoiceOutput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/CerevoiceOutput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_command_line_communication_8java.xml b/docs/doxyxml/_command_line_communication_8java.xml
@@ -69,6 +69,6 @@
 <codeline lineno="58"><highlight class="normal"></highlight></codeline>
 <codeline lineno="59"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/CommandLineCommunication.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/CommandLineCommunication.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_command_line_input_8java.xml b/docs/doxyxml/_command_line_input_8java.xml
@@ -35,6 +35,6 @@
 <codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="28"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/CommandLineInput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/CommandLineInput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_command_line_output_8java.xml b/docs/doxyxml/_command_line_output_8java.xml
@@ -37,6 +37,6 @@
 <codeline lineno="29"><highlight class="normal"></highlight></codeline>
 <codeline lineno="30"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/CommandLineOutput.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/CommandLineOutput.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_communication_8java.xml b/docs/doxyxml/_communication_8java.xml
@@ -21,6 +21,6 @@
 <codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>communicate();</highlight></codeline>
 <codeline lineno="11"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/io/Communication.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/io/Communication.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_config_8java.xml b/docs/doxyxml/_config_8java.xml
@@ -125,7 +125,7 @@
 <codeline lineno="143"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">try</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="144"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
 <codeline lineno="145"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>File<sp/>propertiesFile<sp/>=<sp/></highlight><highlight class="keyword">new</highlight><highlight class="normal"><sp/>File(yamlConfigFile);</highlight></codeline>
-<codeline lineno="146"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal">(propertiesFile<sp/>==<sp/>null)<sp/>{</highlight></codeline>
+<codeline lineno="146"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal">(!<sp/>propertiesFile.exists())<sp/>{<sp/></highlight><highlight class="comment">//<sp/>propertiesFile<sp/>==<sp/>null<sp/>doesn&apos;t<sp/>work!</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="147"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>System.out.println(</highlight><highlight class="stringliteral">&quot;Could<sp/>not<sp/>find<sp/>&quot;</highlight><highlight class="normal">+yamlConfigFile+</highlight><highlight class="stringliteral">&quot;<sp/>file<sp/>in<sp/>project<sp/>path!<sp/>YAML<sp/>configurations<sp/>will<sp/>be<sp/>unavailable.&quot;</highlight><highlight class="normal">);</highlight></codeline>
 <codeline lineno="148"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal">;</highlight></codeline>
 <codeline lineno="149"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
@@ -140,6 +140,6 @@
 <codeline lineno="158"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="159"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/dialog/Config.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/dialog/Config.java"/>
   </compounddef>
 </doxygen>
diff --git a/docs/doxyxml/_context_8java.xml b/docs/doxyxml/_context_8java.xml
@@ -125,6 +125,6 @@
 <codeline lineno="134"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="135"><highlight class="normal">}</highlight></codeline>
     </programlisting>
-    <location file="/home/laura/Downloads/Roboy/Dialog/DialogSystem/src/main/java/roboy/context/Context.java"/>
+    <location file="/home/roboy/cognition_ws/src/roboy_cognition/roboy_dialog/src/main/java/roboy/context/Context.java"/>
   </compounddef>
 </doxygen>