Skip to content

Commit ed9840b

Browse files
Added description to job sub-module
1 parent 2926dbc commit ed9840b

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

docs/detailed-documentation/job/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
2828
<dl>
2929
<dt><code class="name"><a title="codeflare_sdk.job.jobs" href="jobs.html">codeflare_sdk.job.jobs</a></code></dt>
3030
<dd>
31-
<div class="desc"></div>
31+
<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>
3232
</dd>
3333
<dt><code class="name"><a title="codeflare_sdk.job.ray_jobs" href="ray_jobs.html">codeflare_sdk.job.ray_jobs</a></code></dt>
3434
<dd>

docs/detailed-documentation/job/jobs.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
66
<meta name="generator" content="pdoc 0.10.0" />
77
<title>codeflare_sdk.job.jobs API documentation</title>
8-
<meta name="description" content="" />
8+
<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." />
99
<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>
1010
<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>
1111
<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 @@
2222
<h1 class="title">Module <code>codeflare_sdk.job.jobs</code></h1>
2323
</header>
2424
<section id="section-intro">
25+
<p>The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.</p>
2526
<details class="source">
2627
<summary>
2728
<span>Expand source code</span>
@@ -40,6 +41,9 @@ <h1 class="title">Module <code>codeflare_sdk.job.jobs</code></h1>
4041
# See the License for the specific language governing permissions and
4142
# limitations under the License.
4243

44+
&#34;&#34;&#34;
45+
The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.
46+
&#34;&#34;&#34;
4347

4448
import abc
4549
from typing import TYPE_CHECKING, Optional, Dict, List

src/codeflare_sdk/job/jobs.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""
16+
The jobs sub-module contains methods needed to submit Distributed Data Parallel(DDP) jobs to Ray Clusters created by the CodeFlare SDK.
17+
"""
1518

1619
import abc
1720
from typing import TYPE_CHECKING, Optional, Dict, List

0 commit comments

Comments
 (0)