andras/great-ai
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 4 Packages Wiki Activity Actions

Deployed 584d746 with MkDocs version: 1.3.0

Browse source
This commit is contained in:
2022-07-13 17:58:53 +00:00
parent 81a2cc9164
commit 664786d231
10 changed files with 41 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

17
index.html
View file

@ -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>