Merge pull request #88 from fractalego/development

Development

README.md

@@ -47,6 +47,16 @@ Please see the examples in the following chapters.
 
 ## LLM side (needs a GPU)
 The second part (LLM side) is a model server for the speech-to-text model, the LLM, the embedding system, and the text-to-speech model.
+
+#### Installation
+In order to quickly run the LLM side, you can use the following installation commands:
+```bash
+pip install wafl-llm
+wafl-llm start
+```
+which will use the default models and start the server on port 8080.
+
+#### Docker
 A docker image can be used to run it as in the following:
 
 ```bash

documentation/build/html/_sources/index.rst.txt

@@ -17,6 +17,8 @@ Welcome to WAFL's 0.0.80 documentation!
    running_WAFL
    facts_and_rules
    examples
+   testcases
+   actions
    license
 
 Indices and tables

documentation/build/html/_sources/installation.rst.txt

@@ -32,20 +32,24 @@ Please see the examples in the following chapters.
 
 LLM side (needs a GPU)
 ----------------------
+The second part (LLM side) is a model server for the speech-to-text model, the LLM, the embedding system, and the text-to-speech model.
+In order to quickly run the LLM side, you can use the following installation commands:
 
-The second part is a machine that runs on a machine accessible from the interface side.
-The initial configuration is for a local deployment of language models.
-No action is needed to run WAFL if you want to run it as a local instance.
+.. code-block:: bash
+
+    $ pip install wafl-llm
+    $ wafl-llm start
+
+    which will use the default models and start the server on port 8080.
 
-However, a multi-user setup will benefit for a dedicated server.
-In this case, a docker image can be used
+Alternatively, a Docker image can be used to run it as in the following:
 
 .. code-block:: bash
 
-    $ docker run -p8080:8080 --env NVIDIA_DISABLE_REQUIRE=1 --gpus all fractalego/wafl-llm:latest
+    $ docker run -p8080:8080 --env NVIDIA_DISABLE_REQUIRE=1 --gpus all fractalego/wafl-llm:0.80
 
 
 The interface side has a `config.json` file that needs to be filled with the IP address of the LLM side.
 The default is localhost.
-Alternatively, you can run the LLM side by cloning `this repository <https://github.com/fractalego/wafl-llm>`_.
 
+Finally, you can run the LLM side by cloning [this repository](https://github.com/fractalego/wafl-llm).

documentation/build/html/examples.html

@@ -55,6 +55,8 @@
 <li class="toctree-l2"><a class="reference internal" href="rules_with_remember_command.html">Rule with remember command</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

documentation/build/html/genindex.html

@@ -46,6 +46,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

documentation/build/html/index.html

@@ -48,6 +48,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 
@@ -110,6 +112,12 @@ <h1>Welcome to WAFL’s 0.0.80 documentation!<a class="headerlink" href="#welcom
 <li class="toctree-l2"><a class="reference internal" href="rules_with_remember_command.html">Rule with remember command</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="testcases.html#running-the-testcases">Running the testcases</a></li>
+<li class="toctree-l2"><a class="reference internal" href="testcases.html#negative-testcases">Negative testcases</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 </div>

documentation/build/html/installation.html

@@ -53,6 +53,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 
@@ -103,17 +105,21 @@ <h2>Interface side<a class="headerlink" href="#interface-side" title="Permalink
 </section>
 <section id="llm-side-needs-a-gpu">
 <h2>LLM side (needs a GPU)<a class="headerlink" href="#llm-side-needs-a-gpu" title="Permalink to this heading"></a></h2>
-<p>The second part is a machine that runs on a machine accessible from the interface side.
-The initial configuration is for a local deployment of language models.
-No action is needed to run WAFL if you want to run it as a local instance.</p>
-<p>However, a multi-user setup will benefit for a dedicated server.
-In this case, a docker image can be used</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-p8080:8080<span class="w"> </span>--env<span class="w"> </span><span class="nv">NVIDIA_DISABLE_REQUIRE</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>fractalego/wafl-llm:latest
+<p>The second part (LLM side) is a model server for the speech-to-text model, the LLM, the embedding system, and the text-to-speech model.
+In order to quickly run the LLM side, you can use the following installation commands:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>wafl-llm
+$<span class="w"> </span>wafl-llm<span class="w"> </span>start
+
+which<span class="w"> </span>will<span class="w"> </span>use<span class="w"> </span>the<span class="w"> </span>default<span class="w"> </span>models<span class="w"> </span>and<span class="w"> </span>start<span class="w"> </span>the<span class="w"> </span>server<span class="w"> </span>on<span class="w"> </span>port<span class="w"> </span><span class="m">8080</span>.
+</pre></div>
+</div>
+<p>Alternatively, a Docker image can be used to run it as in the following:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-p8080:8080<span class="w"> </span>--env<span class="w"> </span><span class="nv">NVIDIA_DISABLE_REQUIRE</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>fractalego/wafl-llm:0.80
 </pre></div>
 </div>
 <p>The interface side has a <cite>config.json</cite> file that needs to be filled with the IP address of the LLM side.
-The default is localhost.
-Alternatively, you can run the LLM side by cloning <a class="reference external" href="https://github.com/fractalego/wafl-llm">this repository</a>.</p>
+The default is localhost.</p>
+<p>Finally, you can run the LLM side by cloning [this repository](<a class="reference external" href="https://github.com/fractalego/wafl-llm">https://github.com/fractalego/wafl-llm</a>).</p>
 </section>
 </section>
 

documentation/build/html/introduction.html

@@ -49,6 +49,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

documentation/build/html/license.html

@@ -17,7 +17,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Rule with remember command" href="rules_with_remember_command.html" /> 
+    <link rel="prev" title="Running Actions" href="actions.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -48,6 +48,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li>
 </ul>
 
@@ -88,7 +90,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headin
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="rules_with_remember_command.html" class="btn btn-neutral float-left" title="Rule with remember command" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="actions.html" class="btn btn-neutral float-left" title="Running Actions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

documentation/build/html/running_WAFL.html

@@ -55,6 +55,8 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>
 

documentation/build/html/search.html

@@ -49,6 +49,8 @@
 <li class="toctree-l1"><a class="reference internal" href="running_WAFL.html">Running WAFL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="facts_and_rules.html">The rules.yaml file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="testcases.html">Creating a testcase</a></li>
+<li class="toctree-l1"><a class="reference internal" href="actions.html">Running Actions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 </ul>