diff --git a/docs/detailed-documentation/job/index.html b/docs/detailed-documentation/job/index.html index bd8991c34..f4bfe93fc 100644 --- a/docs/detailed-documentation/job/index.html +++ b/docs/detailed-documentation/job/index.html @@ -28,7 +28,7 @@

Sub-modules

codeflare_sdk.job.jobs
-
+

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

codeflare_sdk.job.ray_jobs
diff --git a/docs/detailed-documentation/job/jobs.html b/docs/detailed-documentation/job/jobs.html index 08ce9833e..4e06013be 100644 --- a/docs/detailed-documentation/job/jobs.html +++ b/docs/detailed-documentation/job/jobs.html @@ -5,7 +5,7 @@ codeflare_sdk.job.jobs API documentation - + @@ -22,6 +22,7 @@

Module codeflare_sdk.job.jobs

+

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

Expand source code @@ -40,6 +41,9 @@

Module codeflare_sdk.job.jobs

# 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 diff --git a/src/codeflare_sdk/job/jobs.py b/src/codeflare_sdk/job/jobs.py index c3814971a..655107df4 100644 --- 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