Changes in docs for release: v0.16.4

Author: codeflare-machine-account

docs/detailed-documentation/cluster/awload.html

@@ -61,7 +61,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.awload</code></h1>
 class AWManager:
     &#34;&#34;&#34;
     An object for submitting and removing existing AppWrapper yamls
-    to be added to the MCAD queue.
+    to be added to the Kueue localqueue.
     &#34;&#34;&#34;
 
     def __init__(self, filename: str) -&gt; None:
@@ -145,7 +145,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </code></dt>
 <dd>
 <div class="desc"><p>An object for submitting and removing existing AppWrapper yamls
-to be added to the MCAD queue.</p>
+to be added to the Kueue localqueue.</p>
 <p>Create the AppWrapper Manager object by passing in an
 AppWrapper yaml file</p></div>
 <details class="source">
@@ -155,7 +155,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <pre><code class="python">class AWManager:
     &#34;&#34;&#34;
     An object for submitting and removing existing AppWrapper yamls
-    to be added to the MCAD queue.
+    to be added to the Kueue localqueue.
     &#34;&#34;&#34;
 
     def __init__(self, filename: str) -&gt; None:

docs/detailed-documentation/cluster/cluster.html

@@ -179,11 +179,9 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
         template = self.config.template
         image = self.config.image
         appwrapper = self.config.appwrapper
-        instance_types = self.config.machine_types
         env = self.config.envs
         image_pull_secrets = self.config.image_pull_secrets
         write_to_file = self.config.write_to_file
-        verify_tls = self.config.verify_tls
         local_queue = self.config.local_queue
         labels = self.config.labels
         return generate_appwrapper(
@@ -201,20 +199,18 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
             template=template,
             image=image,
             appwrapper=appwrapper,
-            instance_types=instance_types,
             env=env,
             image_pull_secrets=image_pull_secrets,
             write_to_file=write_to_file,
-            verify_tls=verify_tls,
             local_queue=local_queue,
             labels=labels,
         )
 
     # creates a new cluster with the provided or default spec
     def up(self):
         &#34;&#34;&#34;
-        Applies the AppWrapper yaml, pushing the resource request onto
-        the MCAD queue.
+        Applies the Cluster yaml, pushing the resource request onto
+        the Kueue localqueue.
         &#34;&#34;&#34;
 
         # check if RayCluster CustomResourceDefinition exists if not throw RuntimeError
@@ -1229,11 +1225,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         template = self.config.template
         image = self.config.image
         appwrapper = self.config.appwrapper
-        instance_types = self.config.machine_types
         env = self.config.envs
         image_pull_secrets = self.config.image_pull_secrets
         write_to_file = self.config.write_to_file
-        verify_tls = self.config.verify_tls
         local_queue = self.config.local_queue
         labels = self.config.labels
         return generate_appwrapper(
@@ -1251,20 +1245,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             template=template,
             image=image,
             appwrapper=appwrapper,
-            instance_types=instance_types,
             env=env,
             image_pull_secrets=image_pull_secrets,
             write_to_file=write_to_file,
-            verify_tls=verify_tls,
             local_queue=local_queue,
             labels=labels,
         )
 
     # creates a new cluster with the provided or default spec
     def up(self):
         &#34;&#34;&#34;
-        Applies the AppWrapper yaml, pushing the resource request onto
-        the MCAD queue.
+        Applies the Cluster yaml, pushing the resource request onto
+        the Kueue localqueue.
         &#34;&#34;&#34;
 
         # check if RayCluster CustomResourceDefinition exists if not throw RuntimeError
@@ -1776,11 +1768,9 @@ <h3>Methods</h3>
     template = self.config.template
     image = self.config.image
     appwrapper = self.config.appwrapper
-    instance_types = self.config.machine_types
     env = self.config.envs
     image_pull_secrets = self.config.image_pull_secrets
     write_to_file = self.config.write_to_file
-    verify_tls = self.config.verify_tls
     local_queue = self.config.local_queue
     labels = self.config.labels
     return generate_appwrapper(
@@ -1798,11 +1788,9 @@ <h3>Methods</h3>
         template=template,
         image=image,
         appwrapper=appwrapper,
-        instance_types=instance_types,
         env=env,
         image_pull_secrets=image_pull_secrets,
         write_to_file=write_to_file,
-        verify_tls=verify_tls,
         local_queue=local_queue,
         labels=labels,
     )</code></pre>
@@ -1974,7 +1962,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="codeflare_sdk.cluster.cluster.Cluster.list_jobs"><code class="name flex">
-<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List[~T]</span>
+<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This method accesses the head ray node in your cluster and lists the running jobs.</p></div>
@@ -2090,16 +2078,16 @@ <h3>Methods</h3>
 <span>def <span class="ident">up</span></span>(<span>self)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Applies the AppWrapper yaml, pushing the resource request onto
-the MCAD queue.</p></div>
+<div class="desc"><p>Applies the Cluster yaml, pushing the resource request onto
+the Kueue localqueue.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def up(self):
     &#34;&#34;&#34;
-    Applies the AppWrapper yaml, pushing the resource request onto
-    the MCAD queue.
+    Applies the Cluster yaml, pushing the resource request onto
+    the Kueue localqueue.
     &#34;&#34;&#34;
 
     # check if RayCluster CustomResourceDefinition exists if not throw RuntimeError

docs/detailed-documentation/cluster/config.html

@@ -133,7 +133,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class ClusterConfiguration:
+<pre><code class="python">@dataclass
+class ClusterConfiguration:
     &#34;&#34;&#34;
     This dataclass is used to specify resource requirements and other details, and
     is passed in as an argument when creating a Cluster object.

docs/detailed-documentation/cluster/model.html

@@ -146,7 +146,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class AppWrapper:
+<pre><code class="python">@dataclass
+class AppWrapper:
     &#34;&#34;&#34;
     For storing information about an AppWrapper.
     &#34;&#34;&#34;
@@ -299,7 +300,8 @@ <h3>Class variables</h3>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class RayCluster:
+<pre><code class="python">@dataclass
+class RayCluster:
     &#34;&#34;&#34;
     For storing information about a Ray cluster.
     &#34;&#34;&#34;

docs/detailed-documentation/job/ray_jobs.html

@@ -191,7 +191,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="codeflare_sdk.job.ray_jobs.RayJobClient"><code class="flex name class">
 <span>class <span class="ident">RayJobClient</span></span>
-<span>(</span><span>address: Optional[str] = None, create_cluster_if_needed: bool = False, cookies: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, Any]] = None, headers: Optional[Dict[str, Any]] = None, verify: Union[str, bool, None] = True)</span>
+<span>(</span><span>address: Optional[str] = None, create_cluster_if_needed: bool = False, cookies: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, Any]] = None, headers: Optional[Dict[str, Any]] = None, verify: Union[str, bool, ForwardRef(None)] = True)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>A class that functions as a wrapper for the Ray Job Submission Client.</p>
@@ -461,7 +461,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="codeflare_sdk.job.ray_jobs.RayJobClient.submit_job"><code class="name flex">
-<span>def <span class="ident">submit_job</span></span>(<span>self, entrypoint: str, job_id: Optional[str] = None, runtime_env: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, str]] = None, submission_id: Optional[str] = None, entrypoint_num_cpus: Union[int, float, None] = None, entrypoint_num_gpus: Union[int, float, None] = None, entrypoint_resources: Optional[Dict[str, float]] = None) ‑> str</span>
+<span>def <span class="ident">submit_job</span></span>(<span>self, entrypoint: str, job_id: Optional[str] = None, runtime_env: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, str]] = None, submission_id: Optional[str] = None, entrypoint_num_cpus: Union[int, float, ForwardRef(None)] = None, entrypoint_num_gpus: Union[int, float, ForwardRef(None)] = None, entrypoint_resources: Optional[Dict[str, float]] = None) ‑> str</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Method for submitting jobs to a Ray Cluster and returning the job id with entrypoint being a mandatory field.</p>