Skip to content

Commit 677bca5

Browse files
committed
refactor: update demo notebooks with raycluster images and note
1 parent ad9fffd commit 677bca5

17 files changed

+118
-18
lines changed

demo-notebooks/additional-demos/hf_interactive.ipynb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@
6969
"id": "bc27f84c",
7070
"metadata": {},
7171
"source": [
72-
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper)."
72+
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper).\n",
73+
"\n",
74+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
75+
"The example here is a community image."
7376
]
7477
},
7578
{

demo-notebooks/additional-demos/local_interactive.ipynb

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@
3030
"auth.login()"
3131
]
3232
},
33+
{
34+
"cell_type": "markdown",
35+
"id": "18de2d65",
36+
"metadata": {},
37+
"source": [
38+
"\n",
39+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
40+
"The example here is a community image."
41+
]
42+
},
3343
{
3444
"cell_type": "code",
3545
"execution_count": null,
@@ -44,7 +54,18 @@
4454
"cluster_name = \"hfgputest-1\"\n",
4555
"local_interactive = True\n",
4656
"\n",
47-
"cluster = Cluster(ClusterConfiguration(local_interactive=local_interactive, namespace=namespace, name=cluster_name, num_workers=1, min_cpus=1, max_cpus=1, min_memory=4, max_memory=4, num_gpus=0, instascale=False, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
57+
"cluster = Cluster(ClusterConfiguration(local_interactive=local_interactive,\n",
58+
" namespace=namespace,\n",
59+
" name=cluster_name,\n",
60+
" num_workers=1,\n",
61+
" min_cpus=1,\n",
62+
" max_cpus=1,\n",
63+
" min_memory=4,\n",
64+
" max_memory=4,\n",
65+
" num_gpus=0,\n",
66+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
67+
" instascale=False,\n",
68+
" machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
4869
]
4970
},
5071
{

demo-notebooks/guided-demos/0_basic_ray.ipynb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@
4646
"id": "bc27f84c",
4747
"metadata": {},
4848
"source": [
49-
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper)."
49+
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper).\n",
50+
"\n",
51+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
52+
"The example here is a community image."
5053
]
5154
},
5255
{
@@ -66,7 +69,7 @@
6669
" min_memory=4,\n",
6770
" max_memory=4,\n",
6871
" num_gpus=0,\n",
69-
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\", #current default\n",
72+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7073
" instascale=False\n",
7174
"))"
7275
]
@@ -191,7 +194,7 @@
191194
"name": "python",
192195
"nbconvert_exporter": "python",
193196
"pygments_lexer": "ipython3",
194-
"version": "3.8.13"
197+
"version": "3.9.18"
195198
},
196199
"vscode": {
197200
"interpreter": {

demo-notebooks/guided-demos/1_basic_instascale.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):"
46+
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=8,\n",
6467
" max_memory=8,\n",
6568
" num_gpus=1,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=True, # InstaScale now enabled, will scale OCP cluster to guarantee resource request\n",
6771
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"] # Head, worker AWS machine types desired\n",
6872
"))"

demo-notebooks/guided-demos/2_basic_jobs.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Let's start by running through the same cluster setup as before:"
46+
"Let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=4,\n",
6467
" max_memory=4,\n",
6568
" num_gpus=0,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=False\n",
6771
"))"
6872
]

demo-notebooks/guided-demos/3_basic_interactive.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Once again, let's start by running through the same cluster setup as before:"
46+
"Once again, let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=8,\n",
6467
" max_memory=8,\n",
6568
" num_gpus=1,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=True, #<---instascale enabled\n",
6771
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"]\n",
6872
" \n",

demo-notebooks/guided-demos/4_gpt.ipynb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@
3030
"auth.login()"
3131
]
3232
},
33+
{
34+
"cell_type": "markdown",
35+
"id": "8f4b200f",
36+
"metadata": {},
37+
"source": [
38+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
39+
"The example here is a community image."
40+
]
41+
},
3342
{
3443
"cell_type": "code",
3544
"execution_count": null,
@@ -46,6 +55,7 @@
4655
" min_memory=8,\n",
4756
" max_memory=8,\n",
4857
" num_gpus=1,\n",
58+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
4959
" instascale=True, #<---instascale enabled\n",
5060
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"],\n",
5161
"))"

demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@
4646
"id": "bc27f84c",
4747
"metadata": {},
4848
"source": [
49-
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper)."
49+
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper).\n",
50+
"\n",
51+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
52+
"The example here is a community image."
5053
]
5154
},
5255
{
@@ -74,7 +77,7 @@
7477
" min_memory=4,\n",
7578
" max_memory=4,\n",
7679
" num_gpus=0,\n",
77-
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\", #current default\n",
80+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7881
" instascale=False\n",
7982
"))"
8083
]

demo-notebooks/guided-demos/notebook-ex-outputs/1_basic_instascale.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):"
46+
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -71,6 +74,7 @@
7174
" min_memory=8,\n",
7275
" max_memory=8,\n",
7376
" num_gpus=1,\n",
77+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7478
" instascale=True, # InstaScale now enabled, will scale OCP cluster to guarantee resource request\n",
7579
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"] # Head, worker AWS machine types desired\n",
7680
"))"

demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_jobs.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Let's start by running through the same cluster setup as before:"
46+
"Let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -71,6 +74,7 @@
7174
" min_memory=4,\n",
7275
" max_memory=4,\n",
7376
" num_gpus=0,\n",
77+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7478
" instascale=False\n",
7579
"))"
7680
]

demo-notebooks/guided-demos/notebook-ex-outputs/3_basic_interactive.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Once again, let's start by running through the same cluster setup as before:"
46+
"Once again, let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -71,6 +74,7 @@
7174
" min_memory=8,\n",
7275
" max_memory=8,\n",
7376
" num_gpus=1,\n",
77+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7478
" instascale=True, #<---instascale enabled\n",
7579
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"]\n",
7680
" \n",

demo-notebooks/guided-demos/notebook-ex-outputs/4_gpt.ipynb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@
3030
"auth.login()"
3131
]
3232
},
33+
{
34+
"cell_type": "markdown",
35+
"id": "b43e8e21",
36+
"metadata": {},
37+
"source": [
38+
"\n",
39+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
40+
"The example here is a community image."
41+
]
42+
},
3343
{
3444
"cell_type": "code",
3545
"execution_count": 2,
@@ -54,6 +64,7 @@
5464
" min_memory=8,\n",
5565
" max_memory=8,\n",
5666
" num_gpus=1,\n",
67+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
5768
" instascale=True, #<---instascale enabled\n",
5869
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"],\n",
5970
"))"

demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@
4646
"id": "bc27f84c",
4747
"metadata": {},
4848
"source": [
49-
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper)."
49+
"Here, we want to define our cluster by specifying the resources we require for our batch workload. Below, we define our cluster object (which generates a corresponding AppWrapper).\n",
50+
"\n",
51+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
52+
"The example here is a community image."
5053
]
5154
},
5255
{
@@ -66,7 +69,7 @@
6669
" min_memory=4,\n",
6770
" max_memory=4,\n",
6871
" num_gpus=0,\n",
69-
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\", #current default\n",
72+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
7073
" instascale=False\n",
7174
"))"
7275
]

demo-notebooks/guided-demos/preview_nbs/1_basic_instascale.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):"
46+
"This time, we are working in a cloud environment, and our OpenShift cluster does not have the resources needed for our desired workloads. We will use InstaScale to dynamically scale-up guaranteed resources based on our request (that will also automatically scale-down when we are finished working):\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=8,\n",
6467
" max_memory=8,\n",
6568
" num_gpus=1,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=True, # InstaScale now enabled, will scale OCP cluster to guarantee resource request\n",
6771
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"] # Head, worker AWS machine types desired\n",
6872
"))"

demo-notebooks/guided-demos/preview_nbs/2_basic_jobs.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Let's start by running through the same cluster setup as before:"
46+
"Let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=4,\n",
6467
" max_memory=4,\n",
6568
" num_gpus=0,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=False\n",
6771
"))"
6872
]

demo-notebooks/guided-demos/preview_nbs/3_basic_interactive.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343
"id": "bc27f84c",
4444
"metadata": {},
4545
"source": [
46-
"Once again, let's start by running through the same cluster setup as before:"
46+
"Once again, let's start by running through the same cluster setup as before:\n",
47+
"\n",
48+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
49+
"The example here is a community image."
4750
]
4851
},
4952
{
@@ -63,6 +66,7 @@
6366
" min_memory=8,\n",
6467
" max_memory=8,\n",
6568
" num_gpus=1,\n",
69+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
6670
" instascale=True, #<---instascale enabled\n",
6771
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"]\n",
6872
" \n",

demo-notebooks/guided-demos/preview_nbs/4_gpt.ipynb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@
3030
"auth.login()"
3131
]
3232
},
33+
{
34+
"cell_type": "markdown",
35+
"id": "5e4e9ee9",
36+
"metadata": {},
37+
"source": [
38+
"NOTE: We must specify the `image` which will be used in our RayCluster, we recommend you bring your own image which suits your purposes. \n",
39+
"The example here is a community image."
40+
]
41+
},
3342
{
3443
"cell_type": "code",
3544
"execution_count": null,
@@ -46,6 +55,7 @@
4655
" min_memory=8,\n",
4756
" max_memory=8,\n",
4857
" num_gpus=1,\n",
58+
" image=\"quay.io/project-codeflare/ray:latest-py39-cu118\",\n",
4959
" instascale=True, #<---instascale enabled\n",
5060
" machine_types=[\"m5.xlarge\", \"g4dn.xlarge\"],\n",
5161
"))"

0 commit comments

Comments
 (0)