Skip to content

Commit 421a3db

Browse files
codeflare-machine-accountopenshift-merge-bot[bot]
codeflare-machine-account
authored and
openshift-merge-bot[bot]
committed
Changes in docs for release: v0.15.0
1 parent 0dda865 commit 421a3db

File tree

11 files changed

+825
-2153
lines changed

11 files changed

+825
-2153
lines changed

‎docs/detailed-documentation/cluster/cluster.html‎

Lines changed: 386 additions & 613 deletions
Large diffs are not rendered by default.

‎docs/detailed-documentation/cluster/config.html‎

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,22 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.config</code></h1>
7878
num_gpus: int = 0
7979
template: str = f&#34;{dir}/templates/base-template.yaml&#34;
8080
instascale: bool = False
81-
mcad: bool = True
81+
mcad: bool = False
8282
envs: dict = field(default_factory=dict)
8383
image: str = &#34;&#34;
8484
local_interactive: bool = False
8585
image_pull_secrets: list = field(default_factory=list)
8686
dispatch_priority: str = None
87-
openshift_oauth: bool = False # NOTE: to use the user must have permission to create a RoleBinding for system:auth-delegator
88-
ingress_options: dict = field(default_factory=dict)
89-
ingress_domain: str = None</code></pre>
87+
write_to_file: bool = False
88+
verify_tls: bool = True
89+
90+
def __post_init__(self):
91+
if not self.verify_tls:
92+
print(
93+
&#34;Warning: TLS verification has been disabled - Endpoint checks will be bypassed&#34;
94+
)
95+
96+
local_queue: str = None</code></pre>
9097
</details>
9198
</section>
9299
<section>
@@ -100,7 +107,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
100107
<dl>
101108
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration"><code class="flex name class">
102109
<span>class <span class="ident">ClusterConfiguration</span></span>
103-
<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, head_cpus: int = 2, head_memory: int = 8, head_gpus: int = 0, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, num_workers: int = 1, min_memory: int = 2, max_memory: int = 2, num_gpus: int = 0, template: str = '/home/runner/work/codeflare-sdk/codeflare-sdk/src/codeflare_sdk/templates/base-template.yaml', instascale: bool = False, mcad: bool = True, envs: dict = &lt;factory&gt;, image: str = '', local_interactive: bool = False, image_pull_secrets: list = &lt;factory&gt;, dispatch_priority: str = None, openshift_oauth: bool = False, ingress_options: dict = &lt;factory&gt;, ingress_domain: str = None)</span>
110+
<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, head_cpus: int = 2, head_memory: int = 8, head_gpus: int = 0, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, num_workers: int = 1, min_memory: int = 2, max_memory: int = 2, num_gpus: int = 0, template: str = '/home/runner/work/codeflare-sdk/codeflare-sdk/src/codeflare_sdk/templates/base-template.yaml', instascale: bool = False, mcad: bool = False, envs: dict = &lt;factory&gt;, image: str = '', local_interactive: bool = False, image_pull_secrets: list = &lt;factory&gt;, dispatch_priority: str = None, write_to_file: bool = False, verify_tls: bool = True, local_queue: str = None)</span>
104111
</code></dt>
105112
<dd>
106113
<div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -130,15 +137,22 @@ <h2 class="section-title" id="header-classes">Classes</h2>
130137
num_gpus: int = 0
131138
template: str = f&#34;{dir}/templates/base-template.yaml&#34;
132139
instascale: bool = False
133-
mcad: bool = True
140+
mcad: bool = False
134141
envs: dict = field(default_factory=dict)
135142
image: str = &#34;&#34;
136143
local_interactive: bool = False
137144
image_pull_secrets: list = field(default_factory=list)
138145
dispatch_priority: str = None
139-
openshift_oauth: bool = False # NOTE: to use the user must have permission to create a RoleBinding for system:auth-delegator
140-
ingress_options: dict = field(default_factory=dict)
141-
ingress_domain: str = None</code></pre>
146+
write_to_file: bool = False
147+
verify_tls: bool = True
148+
149+
def __post_init__(self):
150+
if not self.verify_tls:
151+
print(
152+
&#34;Warning: TLS verification has been disabled - Endpoint checks will be bypassed&#34;
153+
)
154+
155+
local_queue: str = None</code></pre>
142156
</details>
143157
<h3>Class variables</h3>
144158
<dl>
@@ -174,19 +188,15 @@ <h3>Class variables</h3>
174188
<dd>
175189
<div class="desc"></div>
176190
</dd>
177-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.ingress_domain"><code class="name">var <span class="ident">ingress_domain</span> : str</code></dt>
178-
<dd>
179-
<div class="desc"></div>
180-
</dd>
181-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.ingress_options"><code class="name">var <span class="ident">ingress_options</span> : dict</code></dt>
191+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.instascale"><code class="name">var <span class="ident">instascale</span> : bool</code></dt>
182192
<dd>
183193
<div class="desc"></div>
184194
</dd>
185-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.instascale"><code class="name">var <span class="ident">instascale</span> : bool</code></dt>
195+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive"><code class="name">var <span class="ident">local_interactive</span> : bool</code></dt>
186196
<dd>
187197
<div class="desc"></div>
188198
</dd>
189-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive"><code class="name">var <span class="ident">local_interactive</span> : bool</code></dt>
199+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.local_queue"><code class="name">var <span class="ident">local_queue</span> : str</code></dt>
190200
<dd>
191201
<div class="desc"></div>
192202
</dd>
@@ -230,11 +240,15 @@ <h3>Class variables</h3>
230240
<dd>
231241
<div class="desc"></div>
232242
</dd>
233-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.openshift_oauth"><code class="name">var <span class="ident">openshift_oauth</span> : bool</code></dt>
243+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.template"><code class="name">var <span class="ident">template</span> : str</code></dt>
244+
<dd>
245+
<div class="desc"></div>
246+
</dd>
247+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.verify_tls"><code class="name">var <span class="ident">verify_tls</span> : bool</code></dt>
234248
<dd>
235249
<div class="desc"></div>
236250
</dd>
237-
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.template"><code class="name">var <span class="ident">template</span> : str</code></dt>
251+
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.write_to_file"><code class="name">var <span class="ident">write_to_file</span> : bool</code></dt>
238252
<dd>
239253
<div class="desc"></div>
240254
</dd>
@@ -267,10 +281,9 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
267281
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.head_memory" href="#codeflare_sdk.cluster.config.ClusterConfiguration.head_memory">head_memory</a></code></li>
268282
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.image" href="#codeflare_sdk.cluster.config.ClusterConfiguration.image">image</a></code></li>
269283
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets" href="#codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets">image_pull_secrets</a></code></li>
270-
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.ingress_domain" href="#codeflare_sdk.cluster.config.ClusterConfiguration.ingress_domain">ingress_domain</a></code></li>
271-
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.ingress_options" href="#codeflare_sdk.cluster.config.ClusterConfiguration.ingress_options">ingress_options</a></code></li>
272284
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.instascale" href="#codeflare_sdk.cluster.config.ClusterConfiguration.instascale">instascale</a></code></li>
273285
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive" href="#codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive">local_interactive</a></code></li>
286+
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.local_queue" href="#codeflare_sdk.cluster.config.ClusterConfiguration.local_queue">local_queue</a></code></li>
274287
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.machine_types" href="#codeflare_sdk.cluster.config.ClusterConfiguration.machine_types">machine_types</a></code></li>
275288
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus" href="#codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus">max_cpus</a></code></li>
276289
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.max_memory" href="#codeflare_sdk.cluster.config.ClusterConfiguration.max_memory">max_memory</a></code></li>
@@ -281,8 +294,9 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
281294
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.namespace" href="#codeflare_sdk.cluster.config.ClusterConfiguration.namespace">namespace</a></code></li>
282295
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.num_gpus" href="#codeflare_sdk.cluster.config.ClusterConfiguration.num_gpus">num_gpus</a></code></li>
283296
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.num_workers" href="#codeflare_sdk.cluster.config.ClusterConfiguration.num_workers">num_workers</a></code></li>
284-
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.openshift_oauth" href="#codeflare_sdk.cluster.config.ClusterConfiguration.openshift_oauth">openshift_oauth</a></code></li>
285297
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.template" href="#codeflare_sdk.cluster.config.ClusterConfiguration.template">template</a></code></li>
298+
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.verify_tls" href="#codeflare_sdk.cluster.config.ClusterConfiguration.verify_tls">verify_tls</a></code></li>
299+
<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.write_to_file" href="#codeflare_sdk.cluster.config.ClusterConfiguration.write_to_file">write_to_file</a></code></li>
286300
</ul>
287301
</li>
288302
</ul>

‎docs/detailed-documentation/cluster/index.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@ <h1 class="title">Module <code>codeflare_sdk.cluster</code></h1>
4141
AppWrapper,
4242
)
4343

44-
from .cluster import Cluster, ClusterConfiguration
44+
from .cluster import (
45+
Cluster,
46+
ClusterConfiguration,
47+
get_cluster,
48+
list_all_queued,
49+
list_all_clusters,
50+
)
4551

4652
from .awload import AWManager</code></pre>
4753
</details>

‎docs/detailed-documentation/cluster/model.html‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.model</code></h1>
6565
UNHEALTHY = &#34;unhealthy&#34;
6666
FAILED = &#34;failed&#34;
6767
UNKNOWN = &#34;unknown&#34;
68+
SUSPENDED = &#34;suspended&#34;
6869

6970

7071
class AppWrapperStatus(Enum):
@@ -92,6 +93,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.model</code></h1>
9293
QUEUEING = 4
9394
FAILED = 5
9495
UNKNOWN = 6
96+
SUSPENDED = 7
9597

9698

9799
@dataclass
@@ -254,7 +256,8 @@ <h3>Class variables</h3>
254256
QUEUED = 3
255257
QUEUEING = 4
256258
FAILED = 5
257-
UNKNOWN = 6</code></pre>
259+
UNKNOWN = 6
260+
SUSPENDED = 7</code></pre>
258261
</details>
259262
<h3>Ancestors</h3>
260263
<ul class="hlist">
@@ -282,6 +285,10 @@ <h3>Class variables</h3>
282285
<dd>
283286
<div class="desc"></div>
284287
</dd>
288+
<dt id="codeflare_sdk.cluster.model.CodeFlareClusterStatus.SUSPENDED"><code class="name">var <span class="ident">SUSPENDED</span></code></dt>
289+
<dd>
290+
<div class="desc"></div>
291+
</dd>
285292
<dt id="codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN"><code class="name">var <span class="ident">UNKNOWN</span></code></dt>
286293
<dd>
287294
<div class="desc"></div>
@@ -387,7 +394,8 @@ <h3>Class variables</h3>
387394
READY = &#34;ready&#34;
388395
UNHEALTHY = &#34;unhealthy&#34;
389396
FAILED = &#34;failed&#34;
390-
UNKNOWN = &#34;unknown&#34;</code></pre>
397+
UNKNOWN = &#34;unknown&#34;
398+
SUSPENDED = &#34;suspended&#34;</code></pre>
391399
</details>
392400
<h3>Ancestors</h3>
393401
<ul class="hlist">
@@ -403,6 +411,10 @@ <h3>Class variables</h3>
403411
<dd>
404412
<div class="desc"></div>
405413
</dd>
414+
<dt id="codeflare_sdk.cluster.model.RayClusterStatus.SUSPENDED"><code class="name">var <span class="ident">SUSPENDED</span></code></dt>
415+
<dd>
416+
<div class="desc"></div>
417+
</dd>
406418
<dt id="codeflare_sdk.cluster.model.RayClusterStatus.UNHEALTHY"><code class="name">var <span class="ident">UNHEALTHY</span></code></dt>
407419
<dd>
408420
<div class="desc"></div>
@@ -458,6 +470,7 @@ <h4><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus" href="#c
458470
<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.QUEUEING" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.QUEUEING">QUEUEING</a></code></li>
459471
<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.READY" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.READY">READY</a></code></li>
460472
<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.STARTING" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.STARTING">STARTING</a></code></li>
473+
<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.SUSPENDED" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.SUSPENDED">SUSPENDED</a></code></li>
461474
<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN">UNKNOWN</a></code></li>
462475
</ul>
463476
</li>
@@ -483,6 +496,7 @@ <h4><code><a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codefla
483496
<ul class="">
484497
<li><code><a title="codeflare_sdk.cluster.model.RayClusterStatus.FAILED" href="#codeflare_sdk.cluster.model.RayClusterStatus.FAILED">FAILED</a></code></li>
485498
<li><code><a title="codeflare_sdk.cluster.model.RayClusterStatus.READY" href="#codeflare_sdk.cluster.model.RayClusterStatus.READY">READY</a></code></li>
499+
<li><code><a title="codeflare_sdk.cluster.model.RayClusterStatus.SUSPENDED" href="#codeflare_sdk.cluster.model.RayClusterStatus.SUSPENDED">SUSPENDED</a></code></li>
486500
<li><code><a title="codeflare_sdk.cluster.model.RayClusterStatus.UNHEALTHY" href="#codeflare_sdk.cluster.model.RayClusterStatus.UNHEALTHY">UNHEALTHY</a></code></li>
487501
<li><code><a title="codeflare_sdk.cluster.model.RayClusterStatus.UNKNOWN" href="#codeflare_sdk.cluster.model.RayClusterStatus.UNKNOWN">UNKNOWN</a></code></li>
488502
</ul>

‎docs/detailed-documentation/index.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,12 @@ <h1 class="title">Package <code>codeflare_sdk</code></h1>
3939
CodeFlareClusterStatus,
4040
RayCluster,
4141
AppWrapper,
42+
get_cluster,
43+
list_all_queued,
44+
list_all_clusters,
4245
)
4346

44-
from .job import JobDefinition, Job, DDPJobDefinition, DDPJob, RayJobClient
47+
from .job import RayJobClient
4548

4649
from .utils import generate_cert</code></pre>
4750
</details>

‎docs/detailed-documentation/job/index.html‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,12 @@ <h1 class="title">Module <code>codeflare_sdk.job</code></h1>
2626
<summary>
2727
<span>Expand source code</span>
2828
</summary>
29-
<pre><code class="python">from .jobs import JobDefinition, Job, DDPJobDefinition, DDPJob
30-
31-
from .ray_jobs import RayJobClient</code></pre>
29+
<pre><code class="python">from .ray_jobs import RayJobClient</code></pre>
3230
</details>
3331
</section>
3432
<section>
3533
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
3634
<dl>
37-
<dt><code class="name"><a title="codeflare_sdk.job.jobs" href="jobs.html">codeflare_sdk.job.jobs</a></code></dt>
38-
<dd>
39-
<div class="desc"><p>The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.</p></div>
40-
</dd>
4135
<dt><code class="name"><a title="codeflare_sdk.job.ray_jobs" href="ray_jobs.html">codeflare_sdk.job.ray_jobs</a></code></dt>
4236
<dd>
4337
<div class="desc"><p>The ray_jobs sub-module contains methods needed to submit jobs and connect to Ray Clusters that were not created by CodeFlare.
@@ -65,7 +59,6 @@ <h1>Index</h1>
6559
</li>
6660
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
6761
<ul>
68-
<li><code><a title="codeflare_sdk.job.jobs" href="jobs.html">codeflare_sdk.job.jobs</a></code></li>
6962
<li><code><a title="codeflare_sdk.job.ray_jobs" href="ray_jobs.html">codeflare_sdk.job.ray_jobs</a></code></li>
7063
</ul>
7164
</li>

0 commit comments

Comments
 (0)