Skip to content

Commit 09a6352

Browse files
author
Shilpa Chugh
committed
Make ray image parameter as optional
1 parent e7a45ba commit 09a6352

13 files changed

+73
-30
lines changed

demo-notebooks/additional-demos/hf_interactive.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@
6868
"source": [
6969
"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 Ray Cluster).\n",
7070
"\n",
71-
"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",
72-
"The example here is a community image."
71+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
72+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
7373
]
7474
},
7575
{
@@ -98,7 +98,7 @@
9898
" max_cpus=8, \n",
9999
" min_memory=16, \n",
100100
" max_memory=16, \n",
101-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
101+
" # image=\"\", # Optional Field \n",
102102
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
103103
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
104104
" ))"

demo-notebooks/additional-demos/local_interactive.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
"metadata": {},
3636
"source": [
3737
"\n",
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."
38+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
39+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
4040
]
4141
},
4242
{
@@ -62,7 +62,7 @@
6262
" max_cpus=1,\n",
6363
" min_memory=4,\n",
6464
" max_memory=4,\n",
65-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
65+
" # image=\"\", # Optional Field \n",
6666
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
6767
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
6868
" ))"

demo-notebooks/additional-demos/ray_job_client.ipynb

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@
3535
"auth.login()"
3636
]
3737
},
38+
{
39+
"cell_type": "markdown",
40+
"id": "18de2d65",
41+
"metadata": {},
42+
"source": [
43+
"\n",
44+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
45+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
46+
]
47+
},
3848
{
3949
"cell_type": "code",
4050
"execution_count": null,
@@ -53,7 +63,7 @@
5363
" max_cpus=1,\n",
5464
" min_memory=4,\n",
5565
" max_memory=4,\n",
56-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
66+
" # image=\"\", # Optional Field \n",
5767
" write_to_file=False # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
5868
"))"
5969
]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"source": [
4848
"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 RayCluster).\n",
4949
"\n",
50-
"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",
51-
"The example here is a community image."
50+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
51+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
5252
]
5353
},
5454
{
@@ -70,7 +70,7 @@
7070
" max_cpus=1,\n",
7171
" min_memory=4,\n",
7272
" max_memory=4,\n",
73-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
73+
" # image=\"\", # Optional Field \n",
7474
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
7575
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
7676
"))"

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@
3434
"auth.login()"
3535
]
3636
},
37+
{
38+
"cell_type": "markdown",
39+
"id": "bc27f84c",
40+
"metadata": {},
41+
"source": [
42+
"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 RayCluster).\n",
43+
"\n",
44+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
45+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
46+
]
47+
},
3748
{
3849
"cell_type": "code",
3950
"execution_count": null,
@@ -52,7 +63,7 @@
5263
" max_cpus=1,\n",
5364
" min_memory=4,\n",
5465
" max_memory=4,\n",
55-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
66+
" # image=\"\", # Optional Field \n",
5667
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
5768
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
5869
"))"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
"source": [
4545
"Once again, let's start by running through the same cluster setup as before:\n",
4646
"\n",
47-
"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",
48-
"The example here is a community image."
47+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
48+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
4949
]
5050
},
5151
{
@@ -69,7 +69,7 @@
6969
" max_cpus=2,\n",
7070
" min_memory=8,\n",
7171
" max_memory=8,\n",
72-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
72+
" # image=\"\", # Optional Field \n",
7373
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
7474
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
7575
"))"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"source": [
4848
"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 RayCluster).\n",
4949
"\n",
50-
"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",
51-
"The example here is a community image."
50+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
51+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
5252
]
5353
},
5454
{
@@ -78,7 +78,7 @@
7878
" max_cpus=1,\n",
7979
" min_memory=4,\n",
8080
" max_memory=4,\n",
81-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
81+
" # image=\"\", # Optional Field \n",
8282
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
8383
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
8484
"))"

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@
3434
"auth.login()"
3535
]
3636
},
37+
{
38+
"cell_type": "markdown",
39+
"id": "bc27f84c",
40+
"metadata": {},
41+
"source": [
42+
"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 RayCluster).\n",
43+
"\n",
44+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
45+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
46+
]
47+
},
3748
{
3849
"cell_type": "code",
3950
"execution_count": null,
@@ -52,7 +63,7 @@
5263
" max_cpus=1,\n",
5364
" min_memory=4,\n",
5465
" max_memory=4,\n",
55-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
66+
" # image=\"\", # Optional Field \n",
5667
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
5768
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
5869
"))"

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@
4444
"source": [
4545
"Once again, let's start by running through the same cluster setup as before:\n",
4646
"\n",
47-
"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",
48-
"The example here is a community image."
49-
]
47+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
48+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
5049
},
5150
{
5251
"cell_type": "code",
@@ -77,7 +76,7 @@
7776
" max_cpus=2,\n",
7877
" min_memory=8,\n",
7978
" max_memory=8,\n",
80-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
79+
" # image=\"\", # Optional Field \n",
8180
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
8281
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
8382
"))"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"source": [
4848
"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 RayCluster).\n",
4949
"\n",
50-
"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",
51-
"The example here is a community image."
50+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
51+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
5252
]
5353
},
5454
{
@@ -70,7 +70,7 @@
7070
" max_cpus=1,\n",
7171
" min_memory=4,\n",
7272
" max_memory=4,\n",
73-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
73+
" # image=\"\", # Optional Field \n",
7474
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
7575
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
7676
"))"

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@
3434
"auth.login()"
3535
]
3636
},
37+
{
38+
"cell_type": "markdown",
39+
"id": "bc27f84c",
40+
"metadata": {},
41+
"source": [
42+
"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 RayCluster).\n",
43+
"\n",
44+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
45+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
46+
]
47+
},
3748
{
3849
"cell_type": "code",
3950
"execution_count": null,
@@ -52,7 +63,7 @@
5263
" max_cpus=1,\n",
5364
" min_memory=4,\n",
5465
" max_memory=4,\n",
55-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
66+
" # image=\"\", # Optional Field \n",
5667
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources\n",
5768
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
5869
"))"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
"source": [
4545
"Once again, let's start by running through the same cluster setup as before:\n",
4646
"\n",
47-
"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",
48-
"The example here is a community image."
47+
"NOTE: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. \n",
48+
"If you have your own Ray image which suits your purposes, specify it in image field to override the default image."
4949
]
5050
},
5151
{
@@ -69,7 +69,7 @@
6969
" max_cpus=2,\n",
7070
" min_memory=8,\n",
7171
" max_memory=8,\n",
72-
" image=\"quay.io/rhoai/ray:2.23.0-py39-cu121\",\n",
72+
" # image=\"\", # Optional Field \n",
7373
" write_to_file=False, # When enabled Ray Cluster yaml files are written to /HOME/.codeflare/resources \n",
7474
" # local_queue=\"local-queue-name\" # Specify the local queue manually\n",
7575
"))"

docs/cluster-configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ cluster = Cluster(ClusterConfiguration(
1919
min_memory=2, # Default 2
2020
max_memory=2, # Default 2
2121
num_gpus=0, # Default 0
22-
image="quay.io/rhoai/ray:2.23.0-py39-cu121", # Mandatory Field
22+
# image="", # Optional Field
2323
machine_types=["m5.xlarge", "g4dn.xlarge"],
2424
labels={"exampleLabel": "example", "secondLabel": "example"},
2525
))
2626
```
27+
Note: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used by the CodeFlare SDK for creating a RayCluster resource. If you have your own Ray image which suits your purposes, specify it in image field to override the default image.
2728

2829
The `labels={"exampleLabel": "example"}` parameter can be used to apply additional labels to the RayCluster resource.
2930

0 commit comments

Comments
 (0)