Skip to content

Commit 1235fc8

Browse files
docs: update documentation to include depreciating variables
Signed-off-by: Bobbins228 <[email protected]>
1 parent 2133af9 commit 1235fc8

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/cluster-configuration.md

+18-2
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,17 @@ Note: 'quay.io/modh/ray:2.35.0-py39-cu121' is the default image used by the Code
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+
## Deprecating Parameters
36+
The following parameters of the `ClusterConfiguration` are being deprecated in release `v0.22.0`. <!-- TODO: When removing deprecated parameters update this statement -->
37+
| Deprecated Parameter | Replaced By |
38+
| :--------- | :-------- |
39+
| `head_cpus` | `head_cpu_requests`, `head_cpu_limits` |
40+
| `head_memory` | `head_memory_requests`, `head_memory_limits` |
41+
| `min_cpus` | `worker_cpu_requests` |
42+
| `max_cpus` | `worker_cpu_limits` |
43+
| `min_memory` | `worker_memory_requests` |
44+
| `max_memory` | `worker_memory_limits` |
45+
| `head_gpus` | `head_extended_resource_requests` |
46+
| `num_gpus` | `worker_extended_resource_requests` |

0 commit comments

Comments
 (0)