Skip to content

Commit 310dbdf

Browse files
jiripetrlikgithub-actions[bot]
authored andcommitted
New release: 0.4.3
1 parent ad08d1f commit 310dbdf

File tree

13 files changed

+22
-19
lines changed

13 files changed

+22
-19
lines changed

docs/cluster/auth.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,4 +483,4 @@ <h4><code><a title="codeflare_sdk.cluster.auth.TokenAuthentication" href="#codef
483483
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
484484
</footer>
485485
</body>
486-
</html>
486+
</html>

docs/cluster/awload.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,4 +352,4 @@ <h4><code><a title="codeflare_sdk.cluster.awload.AWManager" href="#codeflare_sdk
352352
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
353353
</footer>
354354
</body>
355-
</html>
355+
</html>

docs/cluster/cluster.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,7 +1036,7 @@ <h3>Methods</h3>
10361036
</details>
10371037
</dd>
10381038
<dt id="codeflare_sdk.cluster.cluster.Cluster.list_jobs"><code class="name flex">
1039-
<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List[~T]</span>
1039+
<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List</span>
10401040
</code></dt>
10411041
<dd>
10421042
<div class="desc"><p>This method accesses the head ray node in your cluster and lists the running jobs.</p></div>
@@ -1261,4 +1261,4 @@ <h4><code><a title="codeflare_sdk.cluster.cluster.Cluster" href="#codeflare_sdk.
12611261
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
12621262
</footer>
12631263
</body>
1264-
</html>
1264+
</html>

docs/cluster/config.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
9393
<dl>
9494
<dt id="codeflare_sdk.cluster.config.ClusterConfiguration"><code class="flex name class">
9595
<span>class <span class="ident">ClusterConfiguration</span></span>
96-
<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/Users/aasthana/go/src/github.com/codeflare-sdk/src/codeflare_sdk/templates/new-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103')</span>
96+
<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/home/runner/work/codeflare-sdk/codeflare-sdk/src/codeflare_sdk/templates/new-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103')</span>
9797
</code></dt>
9898
<dd>
9999
<div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -102,7 +102,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
102102
<summary>
103103
<span>Expand source code</span>
104104
</summary>
105-
<pre><code class="python">class ClusterConfiguration:
105+
<pre><code class="python">@dataclass
106+
class ClusterConfiguration:
106107
&#34;&#34;&#34;
107108
This dataclass is used to specify resource requirements and other details, and
108109
is passed in as an argument when creating a Cluster object.
@@ -233,4 +234,4 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
233234
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
234235
</footer>
235236
</body>
236-
</html>
237+
</html>

docs/cluster/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ <h1>Index</h1>
8888
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
8989
</footer>
9090
</body>
91-
</html>
91+
</html>

docs/cluster/model.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
141141
<summary>
142142
<span>Expand source code</span>
143143
</summary>
144-
<pre><code class="python">class AppWrapper:
144+
<pre><code class="python">@dataclass
145+
class AppWrapper:
145146
&#34;&#34;&#34;
146147
For storing information about an AppWrapper.
147148
&#34;&#34;&#34;
@@ -284,7 +285,8 @@ <h3>Class variables</h3>
284285
<summary>
285286
<span>Expand source code</span>
286287
</summary>
287-
<pre><code class="python">class RayCluster:
288+
<pre><code class="python">@dataclass
289+
class RayCluster:
288290
&#34;&#34;&#34;
289291
For storing information about a Ray cluster.
290292
&#34;&#34;&#34;
@@ -468,4 +470,4 @@ <h4><code><a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codefla
468470
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
469471
</footer>
470472
</body>
471-
</html>
473+
</html>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ <h1>Index</h1>
6767
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
6868
</footer>
6969
</body>
70-
</html>
70+
</html>

docs/job/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ <h1>Index</h1>
6262
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
6363
</footer>
6464
</body>
65-
</html>
65+
</html>

docs/job/jobs.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ <h3>Methods</h3>
305305
</dd>
306306
<dt id="codeflare_sdk.job.jobs.DDPJobDefinition"><code class="flex name class">
307307
<span>class <span class="ident">DDPJobDefinition</span></span>
308-
<span>(</span><span>script: Optional[str] = None, m: Optional[str] = None, script_args: Optional[List[str]] = None, name: Optional[str] = None, cpu: Optional[int] = None, gpu: Optional[int] = None, memMB: Optional[int] = None, h: Optional[str] = None, j: Optional[str] = None, env: Optional[Dict[str, str]] = None, max_retries: int = 0, mounts: Optional[List[str]] = None, rdzv_port: int = 29500, rdzv_backend: str = None, scheduler_args: Optional[Dict[str, str]] = None, image: Optional[str] = None, workspace: Optional[str] = 'file:///Users/aasthana/go/src/github.com/codeflare-sdk')</span>
308+
<span>(</span><span>script: Optional[str] = None, m: Optional[str] = None, script_args: Optional[List[str]] = None, name: Optional[str] = None, cpu: Optional[int] = None, gpu: Optional[int] = None, memMB: Optional[int] = None, h: Optional[str] = None, j: Optional[str] = None, env: Optional[Dict[str, str]] = None, max_retries: int = 0, mounts: Optional[List[str]] = None, rdzv_port: int = 29500, rdzv_backend: str = None, scheduler_args: Optional[Dict[str, str]] = None, image: Optional[str] = None, workspace: Optional[str] = 'file:///home/runner/work/codeflare-sdk/codeflare-sdk')</span>
309309
</code></dt>
310310
<dd>
311311
<div class="desc"></div>
@@ -593,4 +593,4 @@ <h4><code><a title="codeflare_sdk.job.jobs.JobDefinition" href="#codeflare_sdk.j
593593
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
594594
</footer>
595595
</body>
596-
</html>
596+
</html>

docs/utils/generate_yaml.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -882,4 +882,4 @@ <h1>Index</h1>
882882
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
883883
</footer>
884884
</body>
885-
</html>
885+
</html>

0 commit comments

Comments
 (0)