Skip to content

Commit 2db9016

Browse files
committed
docs: update documentation to include depreciating variables
Signed-off-by: Bobbins228 <mcampbel@redhat.com>
1 parent 2ab6585 commit 2db9016

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/cluster-configuration.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ from codeflare_sdk import Cluster, ClusterConfiguration
99
cluster = Cluster(ClusterConfiguration(
1010
name='ray-example', # Mandatory Field
1111
namespace='default', # Default None
12-
head_cpus=1, # Default 2
13-
head_memory=1, # Default 8
12+
head_cpu_requests=1, # Default 2
13+
head_cpu_limits=1, # Default 2
14+
head_memory_requests=1, # Default 8
15+
head_memory_limits=1, # Default 8
1416
head_extended_resource_requests={'nvidia.com/gpu':0}, # Default 0
1517
worker_extended_resource_requests={'nvidia.com/gpu':0}, # Default 0
1618
num_workers=1, # Default 1
@@ -28,3 +30,15 @@ Note: 'quay.io/rhoai/ray:2.23.0-py39-cu121' is the default community image used
2830
The `labels={"exampleLabel": "example"}` parameter can be used to apply additional labels to the RayCluster resource.
2931

3032
After creating their `cluster`, a user can call `cluster.up()` and `cluster.down()` to respectively create or remove the Ray Cluster.
33+
34+
35+
## Depreciating Parameters
36+
The following parameters of the `ClusterConfiguration` are being depreciated in release `v0.22.0`. <!-- TODO: When removing depreciated parameters update this statement -->
37+
* `head_cpus` is replaced by `head_cpu_requests`, `head_cpu_limits`
38+
* `head_memory` is replaced by `head_memory_requests`, `head_memory_limits`
39+
* `min_cpus` is replaced by `worker_cpu_requests`
40+
* `max_cpus` is replaced by `worker_cpu_limits`
41+
* `min_memory` is replaced by `worker_memory_requests`
42+
* `max_memory` is replaced by `worker_memory_limits`
43+
* `head_gpus` is replaced by `head_extended_resource_requests`
44+
* `num_gpus` is replaced by `worker_extended_resource_requests`

0 commit comments

Comments
 (0)