Added description to job sub-module

project-codeflare · Jan 18, 2024 · b6b9786 · b6b9786
1 parent 309fabf
commit b6b9786
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/detailed-documentation/job/index.html b/docs/detailed-documentation/job/index.html
@@ -28,7 +28,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dl>
 <dt><code class="name"><a title="codeflare_sdk.job.jobs" href="jobs.html">codeflare_sdk.job.jobs</a></code></dt>
 <dd>
-<div class="desc"></div>
+<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>
 </dd>
 <dt><code class="name"><a title="codeflare_sdk.job.ray_jobs" href="ray_jobs.html">codeflare_sdk.job.ray_jobs</a></code></dt>
 <dd>

diff --git a/docs/detailed-documentation/job/jobs.html b/docs/detailed-documentation/job/jobs.html
@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>codeflare_sdk.job.jobs API documentation</title>
-<meta name="description" content="" />
+<meta name="description" content="The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK." />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,6 +22,7 @@
 <h1 class="title">Module <code>codeflare_sdk.job.jobs</code></h1>
 </header>
 <section id="section-intro">
+<p>The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
@@ -40,6 +41,9 @@ <h1 class="title">Module <code>codeflare_sdk.job.jobs</code></h1>
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+&#34;&#34;&#34;
+The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.
+&#34;&#34;&#34;
 
 import abc
 from typing import TYPE_CHECKING, Optional, Dict, List

diff --git a/src/codeflare_sdk/job/jobs.py b/src/codeflare_sdk/job/jobs.py
@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.
+"""
 
 import abc
 from typing import TYPE_CHECKING, Optional, Dict, List