Changes in docs for release: vv0.5.4

project-codeflare · Jul 6, 2023 · 2598f5f · 2598f5f
1 parent 52b94c4
commit 2598f5f
Show file tree

Hide file tree

Showing 13 changed files with 722 additions and 18 deletions.
diff --git a/docs/cluster/auth.html b/docs/cluster/auth.html
@@ -483,4 +483,4 @@ <h4><code><a title="codeflare_sdk.cluster.auth.TokenAuthentication" href="#codef
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/cluster/awload.html b/docs/cluster/awload.html
@@ -352,4 +352,4 @@ <h4><code><a title="codeflare_sdk.cluster.awload.AWManager" href="#codeflare_sdk
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/cluster/cluster.html b/docs/cluster/cluster.html
@@ -116,6 +116,8 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
+        local_interactive = self.config.local_interactive
+        image_pull_secrets = self.config.image_pull_secrets
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -130,6 +132,8 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            local_interactive=local_interactive,
+            image_pull_secrets=image_pull_secrets,
         )
 
     # creates a new cluster with the provided or default spec
@@ -635,6 +639,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
+        local_interactive = self.config.local_interactive
+        image_pull_secrets = self.config.image_pull_secrets
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -649,6 +655,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            local_interactive=local_interactive,
+            image_pull_secrets=image_pull_secrets,
         )
 
     # creates a new cluster with the provided or default spec
@@ -930,6 +938,8 @@ <h3>Methods</h3>
     instascale = self.config.instascale
     instance_types = self.config.machine_types
     env = self.config.envs
+    local_interactive = self.config.local_interactive
+    image_pull_secrets = self.config.image_pull_secrets
     return generate_appwrapper(
         name=name,
         namespace=namespace,
@@ -944,6 +954,8 @@ <h3>Methods</h3>
         instascale=instascale,
         instance_types=instance_types,
         env=env,
+        local_interactive=local_interactive,
+        image_pull_secrets=image_pull_secrets,
     )</code></pre>
 </details>
 </dd>
@@ -1261,4 +1273,4 @@ <h4><code><a title="codeflare_sdk.cluster.cluster.Cluster" href="#codeflare_sdk.
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/cluster/config.html b/docs/cluster/config.html
@@ -79,7 +79,9 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.config</code></h1>
     template: str = f&#34;{dir}/templates/base-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
+    local_interactive: bool = False
+    image_pull_secrets: list = field(default_factory=list)</code></pre>
 </details>
 </section>
 <section>
@@ -93,7 +95,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration"><code class="flex name class">
 <span>class <span class="ident">ClusterConfiguration</span></span>
-<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/meyceoz/Documents/codeflare-sdk/src/codeflare_sdk/templates/base-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>
+<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/base-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', local_interactive: bool = False, image_pull_secrets: list = &lt;factory&gt;)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -122,7 +124,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     template: str = f&#34;{dir}/templates/base-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
+    local_interactive: bool = False
+    image_pull_secrets: list = field(default_factory=list)</code></pre>
 </details>
 <h3>Class variables</h3>
 <dl>
@@ -142,10 +146,18 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets"><code class="name">var <span class="ident">image_pull_secrets</span> : list</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration.instascale"><code class="name">var <span class="ident">instascale</span> : bool</code></dt>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive"><code class="name">var <span class="ident">local_interactive</span> : bool</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration.machine_types"><code class="name">var <span class="ident">machine_types</span> : list</code></dt>
 <dd>
 <div class="desc"></div>
@@ -211,7 +223,9 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.gpu" href="#codeflare_sdk.cluster.config.ClusterConfiguration.gpu">gpu</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.head_info" href="#codeflare_sdk.cluster.config.ClusterConfiguration.head_info">head_info</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.image" href="#codeflare_sdk.cluster.config.ClusterConfiguration.image">image</a></code></li>
+<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>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.instascale" href="#codeflare_sdk.cluster.config.ClusterConfiguration.instascale">instascale</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive" href="#codeflare_sdk.cluster.config.ClusterConfiguration.local_interactive">local_interactive</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.machine_types" href="#codeflare_sdk.cluster.config.ClusterConfiguration.machine_types">machine_types</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus" href="#codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus">max_cpus</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.max_memory" href="#codeflare_sdk.cluster.config.ClusterConfiguration.max_memory">max_memory</a></code></li>
@@ -233,4 +247,4 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/cluster/index.html b/docs/cluster/index.html
@@ -88,4 +88,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/cluster/model.html b/docs/cluster/model.html
@@ -468,4 +468,4 @@ <h4><code><a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codefla
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/index.html b/docs/index.html
@@ -67,4 +67,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/job/index.html b/docs/job/index.html
@@ -62,4 +62,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>
diff --git a/docs/job/jobs.html b/docs/job/jobs.html
@@ -305,7 +305,7 @@ <h3>Methods</h3>
 </dd>
 <dt id="codeflare_sdk.job.jobs.DDPJobDefinition"><code class="flex name class">
 <span>class <span class="ident">DDPJobDefinition</span></span>
-<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/meyceoz/Documents/codeflare-sdk')</span>
+<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>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -593,4 +593,4 @@ <h4><code><a title="codeflare_sdk.job.jobs.JobDefinition" href="#codeflare_sdk.j
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>