Changes in docs for release: v0.21.0

project-codeflare · Sep 27, 2024 · d383f94 · d383f94
1 parent c2eaa15
commit d383f94
Show file tree

Hide file tree

Showing 9 changed files with 1,071 additions and 161 deletions.
diff --git a/docs/detailed-documentation/cluster/cluster.html b/docs/detailed-documentation/cluster/cluster.html
diff --git a/docs/detailed-documentation/cluster/config.html b/docs/detailed-documentation/cluster/config.html
diff --git a/docs/detailed-documentation/cluster/index.html b/docs/detailed-documentation/cluster/index.html
@@ -49,6 +49,10 @@ <h1 class="title">Module <code>codeflare_sdk.cluster</code></h1>
     list_all_clusters,
 )
 
+from .widgets import (
+    view_clusters,
+)
+
 from .awload import AWManager</code></pre>
 </details>
 </section>
@@ -81,6 +85,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 states and AppWrapper states, and CodeFlare cluster states, as well as
 …</p></div>
 </dd>
+<dt><code class="name"><a title="codeflare_sdk.cluster.widgets" href="widgets.html">codeflare_sdk.cluster.widgets</a></code></dt>
+<dd>
+<div class="desc"><p>The widgets sub-module contains the ui widgets created using the ipywidgets package.</p></div>
+</dd>
 </dl>
 </section>
 <section>
@@ -108,6 +116,7 @@ <h1>Index</h1>
 <li><code><a title="codeflare_sdk.cluster.cluster" href="cluster.html">codeflare_sdk.cluster.cluster</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config" href="config.html">codeflare_sdk.cluster.config</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model" href="model.html">codeflare_sdk.cluster.model</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.widgets" href="widgets.html">codeflare_sdk.cluster.widgets</a></code></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/detailed-documentation/cluster/model.html b/docs/detailed-documentation/cluster/model.html
@@ -54,6 +54,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.model</code></h1>
 from dataclasses import dataclass, field
 from enum import Enum
 import typing
+from typing import Union
 
 
 class RayClusterStatus(Enum):
@@ -106,12 +107,15 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.model</code></h1>
 
     name: str
     status: RayClusterStatus
-    head_cpus: int
-    head_mem: str
-    workers: int
-    worker_mem_min: str
-    worker_mem_max: str
-    worker_cpu: int
+    head_cpu_requests: int
+    head_cpu_limits: int
+    head_mem_requests: str
+    head_mem_limits: str
+    num_workers: int
+    worker_mem_requests: str
+    worker_mem_limits: str
+    worker_cpu_requests: Union[int, str]
+    worker_cpu_limits: Union[int, str]
     namespace: str
     dashboard: str
     worker_extended_resources: typing.Dict[str, int] = field(default_factory=dict)
@@ -293,7 +297,7 @@ <h3>Class variables</h3>
 </dd>
 <dt id="codeflare_sdk.cluster.model.RayCluster"><code class="flex name class">
 <span>class <span class="ident">RayCluster</span></span>
-<span>(</span><span>name: str, status: <a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codeflare_sdk.cluster.model.RayClusterStatus">RayClusterStatus</a>, head_cpus: int, head_mem: str, workers: int, worker_mem_min: str, worker_mem_max: str, worker_cpu: int, namespace: str, dashboard: str, worker_extended_resources: Dict[str, int] = &lt;factory&gt;, head_extended_resources: Dict[str, int] = &lt;factory&gt;)</span>
+<span>(</span><span>name: str, status: <a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codeflare_sdk.cluster.model.RayClusterStatus">RayClusterStatus</a>, head_cpu_requests: int, head_cpu_limits: int, head_mem_requests: str, head_mem_limits: str, num_workers: int, worker_mem_requests: str, worker_mem_limits: str, worker_cpu_requests: Union[int, str], worker_cpu_limits: Union[int, str], namespace: str, dashboard: str, worker_extended_resources: Dict[str, int] = &lt;factory&gt;, head_extended_resources: Dict[str, int] = &lt;factory&gt;)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>For storing information about a Ray cluster.</p></div>
@@ -309,12 +313,15 @@ <h3>Class variables</h3>
 
     name: str
     status: RayClusterStatus
-    head_cpus: int
-    head_mem: str
-    workers: int
-    worker_mem_min: str
-    worker_mem_max: str
-    worker_cpu: int
+    head_cpu_requests: int
+    head_cpu_limits: int
+    head_mem_requests: str
+    head_mem_limits: str
+    num_workers: int
+    worker_mem_requests: str
+    worker_mem_limits: str
+    worker_cpu_requests: Union[int, str]
+    worker_cpu_limits: Union[int, str]
     namespace: str
     dashboard: str
     worker_extended_resources: typing.Dict[str, int] = field(default_factory=dict)
@@ -326,15 +333,23 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.head_cpus"><code class="name">var <span class="ident">head_cpus</span> : int</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.head_cpu_limits"><code class="name">var <span class="ident">head_cpu_limits</span> : int</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="codeflare_sdk.cluster.model.RayCluster.head_cpu_requests"><code class="name">var <span class="ident">head_cpu_requests</span> : int</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
 <dt id="codeflare_sdk.cluster.model.RayCluster.head_extended_resources"><code class="name">var <span class="ident">head_extended_resources</span> : Dict[str, int]</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.head_mem"><code class="name">var <span class="ident">head_mem</span> : str</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.head_mem_limits"><code class="name">var <span class="ident">head_mem_limits</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="codeflare_sdk.cluster.model.RayCluster.head_mem_requests"><code class="name">var <span class="ident">head_mem_requests</span> : str</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
@@ -346,27 +361,31 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.model.RayCluster.num_workers"><code class="name">var <span class="ident">num_workers</span> : int</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.model.RayCluster.status"><code class="name">var <span class="ident">status</span> : <a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codeflare_sdk.cluster.model.RayClusterStatus">RayClusterStatus</a></code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.worker_cpu"><code class="name">var <span class="ident">worker_cpu</span> : int</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.worker_cpu_limits"><code class="name">var <span class="ident">worker_cpu_limits</span> : Union[int, str]</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.worker_extended_resources"><code class="name">var <span class="ident">worker_extended_resources</span> : Dict[str, int]</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.worker_cpu_requests"><code class="name">var <span class="ident">worker_cpu_requests</span> : Union[int, str]</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.worker_mem_max"><code class="name">var <span class="ident">worker_mem_max</span> : str</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.worker_extended_resources"><code class="name">var <span class="ident">worker_extended_resources</span> : Dict[str, int]</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.worker_mem_min"><code class="name">var <span class="ident">worker_mem_min</span> : str</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.worker_mem_limits"><code class="name">var <span class="ident">worker_mem_limits</span> : str</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
-<dt id="codeflare_sdk.cluster.model.RayCluster.workers"><code class="name">var <span class="ident">workers</span> : int</code></dt>
+<dt id="codeflare_sdk.cluster.model.RayCluster.worker_mem_requests"><code class="name">var <span class="ident">worker_mem_requests</span> : str</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
@@ -474,17 +493,20 @@ <h4><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus" href="#c
 <h4><code><a title="codeflare_sdk.cluster.model.RayCluster" href="#codeflare_sdk.cluster.model.RayCluster">RayCluster</a></code></h4>
 <ul class="">
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.dashboard" href="#codeflare_sdk.cluster.model.RayCluster.dashboard">dashboard</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_cpus" href="#codeflare_sdk.cluster.model.RayCluster.head_cpus">head_cpus</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_cpu_limits" href="#codeflare_sdk.cluster.model.RayCluster.head_cpu_limits">head_cpu_limits</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_cpu_requests" href="#codeflare_sdk.cluster.model.RayCluster.head_cpu_requests">head_cpu_requests</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_extended_resources" href="#codeflare_sdk.cluster.model.RayCluster.head_extended_resources">head_extended_resources</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_mem" href="#codeflare_sdk.cluster.model.RayCluster.head_mem">head_mem</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_mem_limits" href="#codeflare_sdk.cluster.model.RayCluster.head_mem_limits">head_mem_limits</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.head_mem_requests" href="#codeflare_sdk.cluster.model.RayCluster.head_mem_requests">head_mem_requests</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.name" href="#codeflare_sdk.cluster.model.RayCluster.name">name</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.namespace" href="#codeflare_sdk.cluster.model.RayCluster.namespace">namespace</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.num_workers" href="#codeflare_sdk.cluster.model.RayCluster.num_workers">num_workers</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.status" href="#codeflare_sdk.cluster.model.RayCluster.status">status</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_cpu" href="#codeflare_sdk.cluster.model.RayCluster.worker_cpu">worker_cpu</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_cpu_limits" href="#codeflare_sdk.cluster.model.RayCluster.worker_cpu_limits">worker_cpu_limits</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_cpu_requests" href="#codeflare_sdk.cluster.model.RayCluster.worker_cpu_requests">worker_cpu_requests</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_extended_resources" href="#codeflare_sdk.cluster.model.RayCluster.worker_extended_resources">worker_extended_resources</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_mem_max" href="#codeflare_sdk.cluster.model.RayCluster.worker_mem_max">worker_mem_max</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_mem_min" href="#codeflare_sdk.cluster.model.RayCluster.worker_mem_min">worker_mem_min</a></code></li>
-<li><code><a title="codeflare_sdk.cluster.model.RayCluster.workers" href="#codeflare_sdk.cluster.model.RayCluster.workers">workers</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_mem_limits" href="#codeflare_sdk.cluster.model.RayCluster.worker_mem_limits">worker_mem_limits</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.RayCluster.worker_mem_requests" href="#codeflare_sdk.cluster.model.RayCluster.worker_mem_requests">worker_mem_requests</a></code></li>
 </ul>
 </li>
 <li>