Deployed 2de6bd4 to v2.18 with MkDocs 1.6.1 and mike 2.1.3

v2.18/Researcher/Walkthroughs/quickstart-inference/index.html

@@ -46,7 +46,7 @@
 </code></pre></div> </div> <div class=tabbed-block> <p>Open a terminal and run:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>runai<span class=w> </span>project<span class=w> </span><span class=nb>set</span><span class=w> </span>team-a
 <a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a>runai<span class=w> </span>training<span class=w> </span>submit<span class=w> </span>inference-client-1<span class=w>  </span>-i<span class=w> </span>runai.jfrog.io/demo/example-triton-client<span class=w> </span><span class=se>\</span>
 <a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a>--<span class=w> </span>perf_analyzer<span class=w> </span>-m<span class=w> </span>inception_graphdef<span class=w>  </span>-p<span class=w> </span><span class=m>3600000</span><span class=w> </span>-u<span class=w>  </span>&lt;INFERENCE-ENDPOINT&gt;<span class=w>    </span>
-</code></pre></div> </div> <div class=tabbed-block> <ul> <li>In the Run:ai UI select <strong>Workloads</strong></li> <li>Select <strong>New Workload</strong> and then <strong>Training</strong></li> <li>You should already have <code>Cluster</code>, <code>Project</code> and a <code>start from scratch</code> <code>Template</code> selected. Enter <code>inference-client-1</code> as the name and press <strong>CONTINUE</strong>.</li> <li>Select <strong>NEW ENVIRONMENT</strong>. Enter <code>inference-client</code> as the name and <code>runai.jfrog.io/demo/example-triton-client</code> as the image. Select <strong>CREATE ENVIRONMENT</strong>.</li> <li>When the previous screen comes up, select <code>cpu-only</code> under the Compute resource.</li> <li>Under <code>runtime settings</code> enter the command as <code>perf_analyzer</code> and arguments <code>-m inception_graphdef -p 3600000 -u &lt;INFERENCE-ENDPOINT&gt;</code> (replace inference endpoint with the above URL).</li> <li>Select <strong>CREATE TRAINING</strong>.</li> </ul> </div> </div> </div> <p>In the user interface, under <code>inference-server-1</code>, go to the <code>Metrics</code> tab and watch as the various GPU and inference metrics graphs rise. </p> <h3 id=stop-workload>Stop Workload<a class=headerlink href=#stop-workload title="Permanent link">&para;</a></h3> <p>Run the following:</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:3><input checked=checked id=__tabbed_4_1 name=__tabbed_4 type=radio><input id=__tabbed_4_2 name=__tabbed_4 type=radio><input id=__tabbed_4_3 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=__tabbed_4_1>CLI V1</label><label for=__tabbed_4_2>CLI V2</label><label for=__tabbed_4_3>User Interface</label></div> <div class=tabbed-content> <div class=tabbed-block> <p>Not available right now</p> </div> <div class=tabbed-block> <p>Not available right now</p> </div> <div class=tabbed-block> <p>Select the two workloads and press <strong>DELETE</strong>.</p> </div> </div> </div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-26T08:25:39+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-26T08:25:39+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-26</span> </span> </aside> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
+</code></pre></div> </div> <div class=tabbed-block> <ul> <li>In the Run:ai UI select <strong>Workloads</strong></li> <li>Select <strong>New Workload</strong> and then <strong>Training</strong></li> <li>You should already have <code>Cluster</code>, <code>Project</code> and a <code>start from scratch</code> <code>Template</code> selected. Enter <code>inference-client-1</code> as the name and press <strong>CONTINUE</strong>.</li> <li>Select <strong>NEW ENVIRONMENT</strong>. Enter <code>inference-client</code> as the name and <code>runai.jfrog.io/demo/example-triton-client</code> as the image. Select <strong>CREATE ENVIRONMENT</strong>.</li> <li>When the previous screen comes up, select <code>cpu-only</code> under the Compute resource.</li> <li>Under <code>runtime settings</code> enter the command as <code>perf_analyzer</code> and arguments <code>-m inception_graphdef -p 3600000 -u &lt;INFERENCE-ENDPOINT&gt;</code> (replace inference endpoint with the above URL).</li> <li>Select <strong>CREATE TRAINING</strong>.</li> </ul> </div> </div> </div> <p>In the user interface, under <code>inference-server-1</code>, go to the <code>Metrics</code> tab and watch as the various GPU and inference metrics graphs rise. </p> <h3 id=stop-workload>Stop Workload<a class=headerlink href=#stop-workload title="Permanent link">&para;</a></h3> <p>Run the following:</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:3><input checked=checked id=__tabbed_4_1 name=__tabbed_4 type=radio><input id=__tabbed_4_2 name=__tabbed_4 type=radio><input id=__tabbed_4_3 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=__tabbed_4_1>CLI V1</label><label for=__tabbed_4_2>CLI V2</label><label for=__tabbed_4_3>User Interface</label></div> <div class=tabbed-content> <div class=tabbed-block> <p>Not available right now</p> </div> <div class=tabbed-block> <p>Not available right now</p> </div> <div class=tabbed-block> <p>Select the two workloads and press <strong>DELETE</strong>.</p> </div> </div> </div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-29T07:50:25+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-29</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-29T07:50:25+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-29</span> </span> </aside> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
 </script> <!-- Synchronize Giscus theme with palette --> <script>
     var giscus = document.querySelector("script[src*=giscus]")
 

v2.18/Researcher/Walkthroughs/quickstart-jupyter/index.html

@@ -40,7 +40,7 @@
 <a id=__codelineno-2-21 name=__codelineno-2-21 href=#__codelineno-2-21></a><span class=w>        </span><span class=o>]</span>
 <a id=__codelineno-2-22 name=__codelineno-2-22 href=#__codelineno-2-22></a><span class=w>    </span><span class=o>}</span>
 <a id=__codelineno-2-23 name=__codelineno-2-23 href=#__codelineno-2-23></a><span class=o>}</span><span class=err>&#39;</span>
-</code></pre></div> <ol> <li><code>&lt;COMPANY-URL&gt;</code> is the link to the Run:ai user interface. For example <code>acme.run.ai</code></li> <li><code>&lt;TOKEN&gt;</code> is an API access token. see above on how to obtain a valid token.</li> <li><code>&lt;PROJECT-ID&gt;</code> is the the ID of the <code>team-a</code> Project. You can get the Project ID via the <a href=https://app.run.ai/api/docs#tag/Projects/operation/get_projects target=_blank>Get Projects API</a></li> <li><code>&lt;CLUSTER-UUID&gt;</code> is the unique identifier of the Cluster. You can get the Cluster UUID by adding the "Cluster ID" column to the Clusters view. </li> <li><code>toolType</code> will show the Jupyter icon when connecting to the Jupyter tool via the user interface. </li> <li><code>toolName</code> text will show when connecting to the Jupyter tool via the user interface.</li> </ol> <div class="admonition note"> <p class=admonition-title>Note</p> <ul> <li>The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated <a href=../../../developer/cluster-api/submit-rest/ >Cluster API</a>.</li> <li>For more information on the Training Submit API see <a href=https://app.run.ai/api/docs#tag/Trainings/operation/create_training1>API Documentation</a> </li> </ul> </div> </div> </div> </div> <p>This would start a Workspace with a pre-configured Jupyter image with an allocation of a single GPU. </p> <h3 id=accessing-the-jupyter-notebook>Accessing the Jupyter Notebook<a class=headerlink href=#accessing-the-jupyter-notebook title="Permanent link">&para;</a></h3> <p>Via the Run:ai user interface, go to <code>Workloads</code>, select the <code>jup1</code> Workspace and press <code>Connect</code>.</p> <p>Alternatively, browse directly to <code>https://&lt;COMPANY-URL&gt;/team-a/jup1</code>.</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-26T08:25:39+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-26T08:25:39+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-26</span> </span> </aside> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
+</code></pre></div> <ol> <li><code>&lt;COMPANY-URL&gt;</code> is the link to the Run:ai user interface. For example <code>acme.run.ai</code></li> <li><code>&lt;TOKEN&gt;</code> is an API access token. see above on how to obtain a valid token.</li> <li><code>&lt;PROJECT-ID&gt;</code> is the the ID of the <code>team-a</code> Project. You can get the Project ID via the <a href=https://app.run.ai/api/docs#tag/Projects/operation/get_projects target=_blank>Get Projects API</a></li> <li><code>&lt;CLUSTER-UUID&gt;</code> is the unique identifier of the Cluster. You can get the Cluster UUID by adding the "Cluster ID" column to the Clusters view. </li> <li><code>toolType</code> will show the Jupyter icon when connecting to the Jupyter tool via the user interface. </li> <li><code>toolName</code> text will show when connecting to the Jupyter tool via the user interface.</li> </ol> <div class="admonition note"> <p class=admonition-title>Note</p> <ul> <li>The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated <a href=../../../developer/cluster-api/submit-rest/ >Cluster API</a>.</li> <li>For more information on the Training Submit API see <a href=https://app.run.ai/api/docs#tag/Trainings/operation/create_training1>API Documentation</a> </li> </ul> </div> </div> </div> </div> <p>This would start a Workspace with a pre-configured Jupyter image with an allocation of a single GPU. </p> <h3 id=accessing-the-jupyter-notebook>Accessing the Jupyter Notebook<a class=headerlink href=#accessing-the-jupyter-notebook title="Permanent link">&para;</a></h3> <p>Via the Run:ai user interface, go to <code>Workloads</code>, select the <code>jup1</code> Workspace and press <code>Connect</code>.</p> <p>Alternatively, browse directly to <code>https://&lt;COMPANY-URL&gt;/team-a/jup1</code>.</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-29T07:50:25+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-29</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2024-09-29T07:50:25+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-29</span> </span> </aside> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
 </script> <!-- Synchronize Giscus theme with palette --> <script>
     var giscus = document.querySelector("script[src*=giscus]")