update: Demo notebooks to use simplified import statements for the codeflare-sdk

VanillaSpoon · openshift-merge-bot[bot] · commit 8298e9eec87e · 2024-02-26T11:59:09.000Z
diff --git a/demo-notebooks/additional-demos/hf_interactive.ipynb b/demo-notebooks/additional-demos/hf_interactive.ipynb
@@ -42,8 +42,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/additional-demos/local_interactive.ipynb b/demo-notebooks/additional-demos/local_interactive.ipynb
@@ -10,8 +10,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -116,7 +115,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.utils import generate_cert\n",
+    "from codeflare_sdk import generate_cert\n",
     "\n",
     "if local_interactive:\n",
     "    generate_cert.generate_tls_cert(cluster_name, namespace)\n",
diff --git a/demo-notebooks/guided-demos/0_basic_ray.ipynb b/demo-notebooks/guided-demos/0_basic_ray.ipynb
@@ -19,8 +19,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/1_basic_instascale.ipynb b/demo-notebooks/guided-demos/1_basic_instascale.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/2_basic_jobs.ipynb b/demo-notebooks/guided-demos/2_basic_jobs.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -108,7 +107,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/3_basic_interactive.ipynb b/demo-notebooks/guided-demos/3_basic_interactive.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/4_gpt.ipynb b/demo-notebooks/guided-demos/4_gpt.ipynb
@@ -8,8 +8,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -98,7 +97,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb
@@ -19,8 +19,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/notebook-ex-outputs/1_basic_instascale.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/1_basic_instascale.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_jobs.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_jobs.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -183,7 +182,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/notebook-ex-outputs/3_basic_interactive.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/3_basic_interactive.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/notebook-ex-outputs/4_gpt.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/4_gpt.ipynb
@@ -8,8 +8,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -174,7 +173,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb b/demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb
@@ -19,8 +19,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/preview_nbs/1_basic_instascale.ipynb b/demo-notebooks/guided-demos/preview_nbs/1_basic_instascale.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/preview_nbs/2_basic_jobs.ipynb b/demo-notebooks/guided-demos/preview_nbs/2_basic_jobs.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -108,7 +107,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/preview_nbs/3_basic_interactive.ipynb b/demo-notebooks/guided-demos/preview_nbs/3_basic_interactive.ipynb
@@ -16,8 +16,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
diff --git a/demo-notebooks/guided-demos/preview_nbs/4_gpt.ipynb b/demo-notebooks/guided-demos/preview_nbs/4_gpt.ipynb
@@ -8,8 +8,7 @@
    "outputs": [],
    "source": [
     "# Import pieces from codeflare-sdk\n",
-    "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",
-    "from codeflare_sdk.cluster.auth import TokenAuthentication"
+    "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"
    ]
   },
   {
@@ -98,7 +97,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from codeflare_sdk.job.jobs import DDPJobDefinition"
+    "from codeflare_sdk import DDPJobDefinition"
    ]
   },
   {
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -5,7 +5,7 @@ Authenticating with your cluster allows you to perform actions such as creating
 ## Method 1 Token Authentication
 This is how a typical user would authenticate to their cluster using `TokenAuthentication`.
 ```
-from codeflare_sdk.cluster.auth import TokenAuthentication
+from codeflare_sdk import TokenAuthentication
 
 auth = TokenAuthentication(
     token = "XXXXX",
@@ -27,7 +27,7 @@ If the user has not specifically authenticated through the SDK by other means su
 A user can specify a config file via a different authentication class `KubeConfigFileAuthentication` for authenticating with the SDK.<br>
 This is what loading a custom config file would typically look like.
 ```
-from codeflare_sdk.cluster.auth import KubeConfigFileAuthentication
+from codeflare_sdk import KubeConfigFileAuthentication
 
 auth = KubeConfigFileAuthentication(
     kube_config_path="/path/to/config",
diff --git a/docs/cluster-configuration.md b/docs/cluster-configuration.md
@@ -4,7 +4,7 @@ To create Ray Clusters using the CodeFlare SDK a cluster configuration needs to
 This is what a typical cluster configuration would look like; Note: The values for CPU and Memory are at the minimum requirements for creating the Ray Cluster.
 
 ```
-from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration
+from codeflare_sdk import Cluster, ClusterConfiguration
 
 cluster = Cluster(ClusterConfiguration(
     name='ray-example', # Mandatory Field

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,7 @@`
`42`	`42`	`"outputs": [],`
`43`	`43`	`"source": [`
`44`	`44`	`"# Import pieces from codeflare-sdk\n",`
`45`		`- "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",`
`46`		`- "from codeflare_sdk.cluster.auth import TokenAuthentication"`
	`45`	`+ "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"`
`47`	`46`	`]`
`48`	`47`	`},`
`49`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,7 @@`
`19`	`19`	`"outputs": [],`
`20`	`20`	`"source": [`
`21`	`21`	`"# Import pieces from codeflare-sdk\n",`
`22`		`- "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",`
`23`		`- "from codeflare_sdk.cluster.auth import TokenAuthentication"`
	`22`	`+ "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"`
`24`	`23`	`]`
`25`	`24`	`},`
`26`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,7 @@`
`16`	`16`	`"outputs": [],`
`17`	`17`	`"source": [`
`18`	`18`	`"# Import pieces from codeflare-sdk\n",`
`19`		`- "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",`
`20`		`- "from codeflare_sdk.cluster.auth import TokenAuthentication"`
	`19`	`+ "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"`
`21`	`20`	`]`
`22`	`21`	`},`
`23`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,7 @@`
`8`	`8`	`"outputs": [],`
`9`	`9`	`"source": [`
`10`	`10`	`"# Import pieces from codeflare-sdk\n",`
`11`		`- "from codeflare_sdk.cluster.cluster import Cluster, ClusterConfiguration\n",`
`12`		`- "from codeflare_sdk.cluster.auth import TokenAuthentication"`
	`11`	`+ "from codeflare_sdk import Cluster, ClusterConfiguration, TokenAuthentication"`
`13`	`12`	`]`
`14`	`13`	`},`
`15`	`14`	`{`
`@@ -98,7 +97,7 @@`
`98`	`97`	`"metadata": {},`
`99`	`98`	`"outputs": [],`
`100`	`99`	`"source": [`
`101`		`- "from codeflare_sdk.job.jobs import DDPJobDefinition"`
	`100`	`+ "from codeflare_sdk import DDPJobDefinition"`
`102`	`101`	`]`
`103`	`102`	`},`
`104`	`103`	`{`