anyscale 0.26.47__py3-none-any.whl → 0.26.49__py3-none-any.whl

anyscale/compute_config/_private/compute_config_sdk.py

@@ -16,6 +16,7 @@ from anyscale.cluster_compute import parse_cluster_compute_name_version
 from anyscale.compute_config.models import (
     CloudDeployment,
     ComputeConfig,
+    ComputeConfigType,
     ComputeConfigVersion,
     HeadNodeConfig,
     MarketType,
@@ -121,7 +122,7 @@ class PrivateComputeConfigSDK(BaseSDK):
 
         return api_models
 
-    def _convert_compute_config_to_api_model(
+    def _convert_single_deployment_compute_config_to_api_model(
         self, compute_config: ComputeConfig
     ) -> CloudDeploymentComputeConfig:
         # We should only make the head node schedulable when it's the *only* node in the cluster.
@@ -167,7 +168,7 @@ class PrivateComputeConfigSDK(BaseSDK):
         )
 
     def create_compute_config(
-        self, compute_config: ComputeConfig, *, name: Optional[str] = None
+        self, compute_config: ComputeConfigType, *, name: Optional[str] = None
     ) -> Tuple[str, str]:
         """Register the provided compute config and return its internal ID."""
 
@@ -179,10 +180,27 @@ class PrivateComputeConfigSDK(BaseSDK):
                     "The latest version tag will be generated and returned."
                 )
 
+        if isinstance(compute_config, MultiDeploymentComputeConfig):
+            return self.create_multi_deployment_compute_config(
+                compute_config, name=name
+            )
+        else:
+            assert isinstance(compute_config, ComputeConfig)
+            return self.create_single_deployment_compute_config(
+                compute_config, name=name
+            )
+
+    def create_single_deployment_compute_config(
+        self, compute_config: ComputeConfig, *, name: Optional[str] = None,
+    ) -> Tuple[str, str]:
+        """Register the provided single-deployment compute config and return its internal ID."""
+
         # Returns the default cloud if user-provided cloud is not specified (`None`).
         cloud_id = self.client.get_cloud_id(cloud_name=compute_config.cloud)  # type: ignore
 
-        deployment_config = self._convert_compute_config_to_api_model(compute_config)
+        deployment_config = self._convert_single_deployment_compute_config_to_api_model(
+            compute_config
+        )
 
         compute_config_api_model = ComputeTemplateConfig(
             cloud_id=cloud_id,
@@ -214,14 +232,6 @@ class PrivateComputeConfigSDK(BaseSDK):
         name: Optional[str] = None,
     ) -> Tuple[str, str]:
         """Register the provided multi-deployment compute config and return its internal ID."""
-        if name is not None:
-            _, version = parse_cluster_compute_name_version(name)
-            if version is not None:
-                raise ValueError(
-                    "A version tag cannot be provided when creating a compute config. "
-                    "The latest version tag will be generated and returned."
-                )
-
         # Returns the default cloud if user-provided cloud is not specified (`None`).
         cloud_id = self.client.get_cloud_id(cloud_name=compute_config.cloud)  # type: ignore
 
@@ -230,7 +240,9 @@ class PrivateComputeConfigSDK(BaseSDK):
         deployment_configs = []
         for config in compute_config.configs:
             assert isinstance(config, ComputeConfig)
-            deployment_configs.append(self._convert_compute_config_to_api_model(config))
+            deployment_configs.append(
+                self._convert_single_deployment_compute_config_to_api_model(config)
+            )
         default_config = deployment_configs[0]
 
         compute_config_api_model = ComputeTemplateConfig(
@@ -369,7 +381,7 @@ class PrivateComputeConfigSDK(BaseSDK):
 
         return configs
 
-    def _convert_cloud_deployment_compute_config_api_model_to_compute_config(
+    def _convert_cloud_deployment_compute_config_api_model_to_single_deployment_compute_config(
         self, cloud_name: str, api_model: CloudDeploymentComputeConfig,
     ) -> ComputeConfig:
         worker_nodes = None
@@ -431,7 +443,7 @@ class PrivateComputeConfigSDK(BaseSDK):
         configs = None
         if api_model_config.deployment_configs:
             configs = [
-                self._convert_cloud_deployment_compute_config_api_model_to_compute_config(
+                self._convert_cloud_deployment_compute_config_api_model_to_single_deployment_compute_config(
                     cloud.name, config
                 )
                 for config in api_model_config.deployment_configs
@@ -446,9 +458,7 @@ class PrivateComputeConfigSDK(BaseSDK):
             return ComputeConfigVersion(
                 name=f"{api_model.name}:{api_model.version}",
                 id=api_model.id,
-                multi_deployment_config=MultiDeploymentComputeConfig(
-                    cloud=cloud.name, configs=configs,
-                ),
+                config=MultiDeploymentComputeConfig(cloud=cloud.name, configs=configs),
             )
 
         # If there are no deployment configs, this is a compute config for a single cloud deployment - parse the top-level fields.

anyscale/compute_config/commands.py

@@ -3,9 +3,8 @@ from typing import Optional
 from anyscale._private.sdk import sdk_command
 from anyscale.compute_config._private.compute_config_sdk import PrivateComputeConfigSDK
 from anyscale.compute_config.models import (
-    ComputeConfig,
+    ComputeConfigType,
     ComputeConfigVersion,
-    MultiDeploymentComputeConfig,
 )
 
 
@@ -15,7 +14,7 @@ _CREATE_EXAMPLE = """
 import anyscale
 from anyscale.compute_config.models import ComputeConfig, HeadNodeConfig, MarketType, WorkerNodeGroupConfig
 
-config = ComputeConfig(
+single_deployment_compute_config = ComputeConfig(
     head_node=HeadNodeConfig(
         instance_type="m5.8xlarge",
     ),
@@ -33,39 +32,9 @@ config = ComputeConfig(
         ),
     ],
 )
-full_name: str = anyscale.compute_config.create(config, name="my-compute-config")
-"""
+full_name: str = anyscale.compute_config.create(single_deployment_compute_config, name="my-single-deployment-compute-config")
 
-_CREATE_ARG_DOCSTRINGS = {
-    "config": "The config options defining the compute config.",
-    "name": "The name of the compute config. This should *not* include a version tag. If a name is not provided, one will be automatically generated.",
-}
-
-
-@sdk_command(
-    _COMPUTE_CONFIG_SDK_SINGLETON_KEY,
-    PrivateComputeConfigSDK,
-    doc_py_example=_CREATE_EXAMPLE,
-    arg_docstrings=_CREATE_ARG_DOCSTRINGS,
-)
-def create(
-    config: ComputeConfig,
-    *,
-    name: Optional[str],
-    _private_sdk: Optional[PrivateComputeConfigSDK] = None,
-) -> str:
-    """Create a new version of a compute config.
-
-    Returns the full name of the registered compute config, including the version.
-    """
-    full_name, _ = _private_sdk.create_compute_config(config, name=name)  # type: ignore
-    return full_name
-
-
-_CREATE_MULTI_DEPLOYMENT_EXAMPLE = """
-import anyscale
-from anyscale.compute_config.models import MultiDeploymentComputeConfig, ComputeConfig, HeadNodeConfig, WorkerNodeGroupConfig
-config = MultiDeploymentComputeConfig(
+multi_deployment_compute_config = MultiDeploymentComputeConfig(
     configs=[
         ComputeConfig(
             cloud_deployment="vm-aws-us-west-1",
@@ -95,11 +64,11 @@ config = MultiDeploymentComputeConfig(
         )
     ]
 )
-full_name: str = anyscale.compute_config.create_multi_deployment(config, name="my-compute-config")
+full_name: str = anyscale.compute_config.create(multi_deployment_compute_config, name="my-multi-deployment-compute-config")
 """
 
-_CREATE_MULTI_DEPLOYMENT_ARG_DOCSTRINGS = {
-    "config": "The config options defining the multi-deployment compute config.",
+_CREATE_ARG_DOCSTRINGS = {
+    "config": "The config options defining the compute config.",
     "name": "The name of the compute config. This should *not* include a version tag. If a name is not provided, one will be automatically generated.",
 }
 
@@ -107,19 +76,20 @@ _CREATE_MULTI_DEPLOYMENT_ARG_DOCSTRINGS = {
 @sdk_command(
     _COMPUTE_CONFIG_SDK_SINGLETON_KEY,
     PrivateComputeConfigSDK,
-    doc_py_example=_CREATE_MULTI_DEPLOYMENT_EXAMPLE,
-    arg_docstrings=_CREATE_MULTI_DEPLOYMENT_ARG_DOCSTRINGS,
+    doc_py_example=_CREATE_EXAMPLE,
+    arg_docstrings=_CREATE_ARG_DOCSTRINGS,
 )
-def create_multi_deployment(
-    config: MultiDeploymentComputeConfig,
+def create(
+    config: ComputeConfigType,
     *,
     name: Optional[str],
     _private_sdk: Optional[PrivateComputeConfigSDK] = None,
 ) -> str:
-    """EXPERIMENTAL. Create a new version of a compute config with multiple possible cloud deployments.
+    """Create a new version of a compute config.
+
     Returns the full name of the registered compute config, including the version.
     """
-    full_name, _ = _private_sdk.create_multi_deployment_compute_config(config, name=name)  # type: ignore
+    full_name, _ = _private_sdk.create_compute_config(config, name=name)  # type: ignore
     return full_name
 
 

anyscale/compute_config/models.py

@@ -315,7 +315,7 @@ worker_nodes:
 
 @dataclass(frozen=True)
 class ComputeConfig(ModelBase):
-    """Configuration for instance types and cloud resources for a cluster."""
+    """Compute configuration for instance types and cloud resources for a cluster with a single cloud deployment."""
 
     __doc_py_example__ = """
 from anyscale.compute_config.models import (
@@ -586,7 +586,7 @@ advanced_instance_config: # (Optional) Defaults to no advanced configurations.
         default=False,
         repr=False,
         metadata={
-            "docstring": "Allow worker groups to be automatically configured based on workload. When false, worker groups must be explicitly configured.",
+            "docstring": "Allow worker groups to be automatically configured based on the workload's logical resource requests. When false, worker groups must be explicitly configured.",
         },
     )
 
@@ -608,6 +608,7 @@ from anyscale.compute_config.models import (
     MultiDeploymentComputeConfig, ComputeConfig, HeadNodeConfig, WorkerNodeGroupConfig
 )
 config = MultiDeploymentComputeConfig(
+    cloud="my-cloud",
     configs=[
         ComputeConfig(
             cloud_deployment="vm-aws-us-west-1",
@@ -657,7 +658,6 @@ configs:
     min_nodes: 1
     max_nodes: 10
 """
-
     cloud: Optional[str] = field(
         default=None,
         metadata={
@@ -698,9 +698,6 @@ configs:
             assert isinstance(config, ComputeConfig)
             config_models.append(config)
 
-            if not config.cloud_deployment:
-                raise ValueError("'cloud_deployment' is required for each config.")
-
             if config.cloud:
                 unique_clouds.add(config.cloud)
 
@@ -722,6 +719,47 @@ configs:
         return config_models
 
 
+ComputeConfigType = Union[ComputeConfig, MultiDeploymentComputeConfig]
+
+
+def compute_config_type_from_yaml(config_file: str) -> ComputeConfigType:
+    """
+    Parse a YAML compute config file into either a ComputeConfig or MultiDeploymentComputeConfig.
+    """
+    error_message = f"Could not parse config file '{config_file}' as a ComputeConfig or MultiDeploymentComputeConfig:\n"
+
+    try:
+        return ComputeConfig.from_yaml(config_file)
+    except Exception as e:  # noqa: BLE001
+        error_message += f"ComputeConfig: {e}\n"
+
+    try:
+        return MultiDeploymentComputeConfig.from_yaml(config_file)
+    except Exception as e:  # noqa: BLE001
+        error_message += f"MultiDeploymentComputeConfig: {e}\n"
+
+    raise TypeError(error_message.rstrip())
+
+
+def compute_config_type_from_dict(config_dict: Dict) -> ComputeConfigType:
+    """
+    Parse a compute config dict into either a ComputeConfig or MultiDeploymentComputeConfig.
+    """
+    error_message = f"Could not parse config dict '{config_dict}' as a ComputeConfig or MultiDeploymentComputeConfig:\n"
+
+    try:
+        return ComputeConfig.from_dict(config_dict)
+    except Exception as e:  # noqa: BLE001
+        error_message += f"ComputeConfig: {e}\n"
+
+    try:
+        return MultiDeploymentComputeConfig.from_dict(config_dict)
+    except Exception as e:  # noqa: BLE001
+        error_message += f"MultiDeploymentComputeConfig: {e}\n"
+
+    raise TypeError(error_message.rstrip())
+
+
 @dataclass(frozen=True)
 class ComputeConfigVersion(ModelBase):
     """Details of a created version of a compute config.
@@ -775,29 +813,14 @@ config:
         if not isinstance(id, str):
             raise TypeError("'id' must be a string.")
 
-    config: Optional[ComputeConfig] = field(
+    config: Optional[ComputeConfigType] = field(
         default=None, metadata={"docstring": "The compute configuration."},
     )
 
-    def _validate_config(self, config: Optional[ComputeConfig]):
-        if config is not None and not isinstance(config, ComputeConfig):
-            raise TypeError("'config' must be a ComputeConfig")
-
-    multi_deployment_config: Optional[MultiDeploymentComputeConfig] = field(
-        default=None,
-        repr=False,
-        metadata={
-            "docstring": "Compute configuration for a cluster with multiple possible cloud deployments.",
-            "customer_hosted_only": True,
-        },
-    )
-
-    def _validate_multi_deployment_config(
-        self, multi_deployment_config: Optional[MultiDeploymentComputeConfig]
-    ):
-        if multi_deployment_config is not None and not isinstance(
-            multi_deployment_config, MultiDeploymentComputeConfig
+    def _validate_config(self, config: Optional[ComputeConfigType]):
+        if config is not None and not isinstance(
+            config, (ComputeConfig, MultiDeploymentComputeConfig)
         ):
             raise TypeError(
-                "'multi_deployment_config' must be a MultiDeploymentComputeConfig"
+                "'config' must be a ComputeConfig or MultiDeploymentComputeConfig"
             )