Deployed 584d746 with MkDocs version: 1.3.0

how-to-guides/install/index.html

@@ -405,6 +405,13 @@
     Command-line tools
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#update" class="md-nav__link">
+    Update
+  </a>
+  
 </li>
       
     </ul>
@@ -765,6 +772,13 @@
     Command-line tools
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#update" class="md-nav__link">
+    Update
+  </a>
+  
 </li>
       
     </ul>
@@ -808,13 +822,17 @@ Consider adding this directory to PATH or, if you prefer to suppress this warnin
 </blockquote>
 <p>This means that <code>great-ai.exe</code> and <code>large-file.exe</code> are not in your <code>PATH</code>. Either add their containing directory ('C:\Users...\Scripts' in this case) to your <code>PATH</code> or use <code>python3 -m great_ai</code> and <code>python3 -m great_ai.large_file</code> instead of the exe-s.</p>
 </div>
+<h2 id="update">Update<a class="headerlink" href="#update" title="Permanent link">#</a></h2>
+<p>If you wish to update to the latest version execute:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip install --upgrade great-ai
+</code></pre></div>
 
   <hr>
 <div class="md-source-file">
   <small>
     
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 12, 2022</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 13, 2022</span>
       
     
   </small>

how-to-guides/install/install.md

@@ -19,3 +19,11 @@ After installation, `great-ai` and `large-file` are available as commands. The f
     > Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
 
     This means that `great-ai.exe` and `large-file.exe` are not in your `PATH`. Either add their containing directory ('C:\Users\...\Scripts' in this case) to your `PATH` or use `python3 -m great_ai` and `python3 -m great_ai.large_file` instead of the exe-s.
+
+## Update
+
+If you wish to update to the latest version execute:
+
+```sh
+pip install --upgrade great-ai
+```

index.html

@@ -900,15 +900,15 @@
 <h2 id="hello-world">Hello world<a class="headerlink" href="#hello-world" title="Permanent link">#</a></h2>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip install great-ai
 </code></pre></div>
-<div class="highlight"><span class="filename">hello-world.py</span><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">from</span> <span class="nn">great_ai</span> <span class="kn">import</span> <span class="n">GreatAI</span>
+<div class="highlight"><span class="filename">demo.py</span><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">from</span> <span class="nn">great_ai</span> <span class="kn">import</span> <span class="n">GreatAI</span>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
 <a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="nd">@GreatAI</span><span class="o">.</span><span class="n">create</span>  <span class="c1">#(1) </span>
-<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>  <span class="c1">#(2) </span>
+<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="k">def</span> <span class="nf">greeter</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>  <span class="c1">#(2) </span>
 <a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>    <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Hello </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">!&quot;</span>
 </code></pre></div>
 <ol>
 <li>
-<p><code>@GreatAI.create</code> wraps your <code>hello_world</code> function with a <code>GreatAI</code> instance. The function will behave very similarly but:</p>
+<p><code>@GreatAI.create</code> wraps your <code>greeter</code> function with a <code>GreatAI</code> instance. The function will behave very similarly but:</p>
 <ol>
 <li>its return value becomes a <code>Trace[str]</code>,</li>
 <li>it gets a <code>process_batch</code> method for supporting parallel execution,</li>
@@ -921,17 +921,14 @@
 </ol>
 <details class="note">
 <summary>Note</summary>
-<p>In practice, <code>hello_world</code> could be an inference function of some AI/ML application. But it could also just wrap a black-box solution of some SaaS. Either ways, it is <a href="https://digital-strategy.ec.europa.eu/en/library/ethics-guidelines-trustworthy-ai" target="_blank">imperative to have continuos oversight</a> of the services you provide and data you process especially in the context of AI/ML applications.</p>
+<p>In practice, <code>greeter</code> could be an inference function of some AI/ML application. But it could also just wrap a black-box solution of some SaaS. Either ways, it is <a href="https://digital-strategy.ec.europa.eu/en/library/ethics-guidelines-trustworthy-ai" target="_blank">imperative to have continuos oversight</a> of the services you provide and data you process especially in the context of AI/ML applications.</p>
 </details>
-<div class="highlight"><span class="filename">terminal</span><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>great-ai hello-world.py
+<div class="highlight"><span class="filename">terminal</span><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>great-ai demo.py
 </code></pre></div>
 <blockquote>
 <p>Navigate to <a href="http://127.0.0.1:6060">localhost:6060</a> in your browser.</p>
 </blockquote>
-<div style="display: flex; justify-content: space-evenly;">
-<p><img alt="" loading="lazy" src="media/hello-world-dashboard.png" /></p>
-<p><img alt="" loading="lazy" src="media/hello-world-docs.png" /></p>
-</div>
+<p><img alt="demo screen capture" loading="lazy" src="media/demo.gif" /></p>
 <div class="admonition success">
 <p class="admonition-title">Success</p>
 <p>Your GreatAI service is ready for production use. Many of the <a href="https://se-ml.github.io" target="_blank">SE4ML best-practices</a> are configured and implemented automatically. To have full control over your service and to understand what else you might need to do in your use case, continue reading this documentation.</p>
@@ -964,7 +961,7 @@
   <small>
     
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 12, 2022</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 13, 2022</span>
       
     
   </small>

index.md

@@ -54,15 +54,15 @@ Applying AI is becoming increasingly easier but many case studies have shown tha
 pip install great-ai
 ```
 
-```python title="hello-world.py" 
+```python title="demo.py" 
 from great_ai import GreatAI
 
 @GreatAI.create  #(1) 
-def hello_world(name: str) -> str:  #(2) 
+def greeter(name: str) -> str:  #(2) 
     return f"Hello {name}!"
 ```
 
-1.  `@GreatAI.create` wraps your `hello_world` function with a `GreatAI` instance. The function will behave very similarly but:
+1.  `@GreatAI.create` wraps your `greeter` function with a `GreatAI` instance. The function will behave very similarly but:
     1. its return value becomes a `Trace[str]`,
     2. it gets a `process_batch` method for supporting parallel execution,
     3. and it can be deployed using the `great-ai` command-line tool.
@@ -70,18 +70,14 @@ def hello_world(name: str) -> str:  #(2)
 2.  [Typing functions](https://docs.python.org/3/library/typing.html){ target=_blank } is recommended in general, however, not required for GreatAI to work.
 
 ??? note
-    In practice, `hello_world` could be an inference function of some AI/ML application. But it could also just wrap a black-box solution of some SaaS. Either ways, it is [imperative to have continuos oversight](https://digital-strategy.ec.europa.eu/en/library/ethics-guidelines-trustworthy-ai){ target=_blank } of the services you provide and data you process especially in the context of AI/ML applications.
+    In practice, `greeter` could be an inference function of some AI/ML application. But it could also just wrap a black-box solution of some SaaS. Either ways, it is [imperative to have continuos oversight](https://digital-strategy.ec.europa.eu/en/library/ethics-guidelines-trustworthy-ai){ target=_blank } of the services you provide and data you process especially in the context of AI/ML applications.
 
 ```sh title="terminal" 
-great-ai hello-world.py
+great-ai demo.py
 ```
 > Navigate to [localhost:6060](http://127.0.0.1:6060) in your browser.
 
-<div style="display: flex; justify-content: space-evenly;" markdown>
-![](media/hello-world-dashboard.png){ loading=lazy }
-
-![](media/hello-world-docs.png){ loading=lazy }
-</div>
+![demo screen capture](media/demo.gif){ loading=lazy }
 
 !!! success
     Your GreatAI service is ready for production use. Many of the [SE4ML best-practices](https://se-ml.github.io){ target=_blank } are configured and implemented automatically. To have full control over your service and to understand what else you might need to do in your use case, continue reading this documentation.