From fab22d042283dd30e4ca63b7117b61a58872359d Mon Sep 17 00:00:00 2001 From: Christopher Cooper Date: Wed, 30 Oct 2024 17:17:15 -0700 Subject: [PATCH] fix docstring for write_cluster_config This used to be true, but since #2943, 'ray' is the only provisioner. Add other keys that are now present instead. --- sky/backends/backend_utils.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/sky/backends/backend_utils.py b/sky/backends/backend_utils.py index 7a327b642de..98c11f826fc 100644 --- a/sky/backends/backend_utils.py +++ b/sky/backends/backend_utils.py @@ -641,11 +641,14 @@ def write_cluster_config( keep_launch_fields_in_existing_config: bool = True) -> Dict[str, str]: """Fills in cluster configuration templates and writes them out. - Returns: {provisioner: path to yaml, the provisioning spec}. - 'provisioner' can be - - 'ray' - - 'tpu-create-script' (if TPU is requested) - - 'tpu-delete-script' (if TPU is requested) + Returns: + Dict with the following keys: + - 'ray': Path to the generated Ray yaml config file + - 'cluster_name': Name of the cluster + - 'cluster_name_on_cloud': Name of the cluster as it appears in the + cloud provider + - 'config_hash': Hash of the cluster config and file mounts contents + Raises: exceptions.ResourcesUnavailableError: if the region/zones requested does not appear in the catalog, or an ssh_proxy_command is specified but