docs: update docs

Author: VanillaSpoon

docs/cluster/cluster.html

@@ -116,6 +116,7 @@ <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
+        pull_secret = self.config.pull_secret
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -130,6 +131,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            pull_secret=pull_secret,
         )
 
     # creates a new cluster with the provided or default spec
@@ -635,6 +637,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
+        pull_secret = self.config.pull_secret
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -649,6 +652,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            pull_secret=pull_secret,
         )
 
     # creates a new cluster with the provided or default spec
@@ -930,6 +934,7 @@ <h3>Methods</h3>
     instascale = self.config.instascale
     instance_types = self.config.machine_types
     env = self.config.envs
+    pull_secret = self.config.pull_secret
     return generate_appwrapper(
         name=name,
         namespace=namespace,
@@ -944,6 +949,7 @@ <h3>Methods</h3>
         instascale=instascale,
         instance_types=instance_types,
         env=env,
+        pull_secret=pull_secret,
     )</code></pre>
 </details>
 </dd>
@@ -1036,7 +1042,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>

docs/cluster/config.html

@@ -79,7 +79,8 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.config</code></h1>
     template: str = f&#34;{dir}/templates/new-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;
+    pull_secret: dict = field(default_factory=dict)</code></pre>
 </details>
 </section>
 <section>
@@ -93,7 +94,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 = '/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>
+<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/eoingallinagh/Documents/RedHat/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', pull_secret: dict = &lt;factory&gt;)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -102,7 +103,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.
@@ -122,7 +124,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     template: str = f&#34;{dir}/templates/new-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;
+    pull_secret: dict = field(default_factory=dict)</code></pre>
 </details>
 <h3>Class variables</h3>
 <dl>
@@ -182,6 +185,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.pull_secret"><code class="name">var <span class="ident">pull_secret</span> : dict</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration.template"><code class="name">var <span class="ident">template</span> : str</code></dt>
 <dd>
 <div class="desc"></div>
@@ -221,6 +228,7 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.min_worker" href="#codeflare_sdk.cluster.config.ClusterConfiguration.min_worker">min_worker</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.name" href="#codeflare_sdk.cluster.config.ClusterConfiguration.name">name</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.namespace" href="#codeflare_sdk.cluster.config.ClusterConfiguration.namespace">namespace</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.pull_secret" href="#codeflare_sdk.cluster.config.ClusterConfiguration.pull_secret">pull_secret</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.template" href="#codeflare_sdk.cluster.config.ClusterConfiguration.template">template</a></code></li>
 </ul>
 </li>

docs/cluster/model.html

@@ -141,7 +141,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;
@@ -284,7 +285,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/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:///Users/aasthana/go/src/github.com/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/eoingallinagh/Documents/RedHat/codeflare-sdk')</span>
 </code></dt>
 <dd>
 <div class="desc"></div>