skypilot-nightly 1.0.0.dev20250502__py3-none-any.whl → 1.0.0.dev20251203__py3-none-any.whl

sky/clouds/hyperbolic.py

@@ -0,0 +1,293 @@
+"""Hyperbolic Cloud provider implementation
+for SkyPilot.
+"""
+import os
+import typing
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+from sky import catalog
+from sky import clouds
+from sky.utils import registry
+from sky.utils import resources_utils
+from sky.utils.resources_utils import DiskTier
+
+if typing.TYPE_CHECKING:
+    from sky import resources as resources_lib
+    from sky.utils import volume as volume_lib
+
+
+@registry.CLOUD_REGISTRY.register
+class Hyperbolic(clouds.Cloud):
+    """Hyperbolic Cloud Provider."""
+
+    _REPR = 'Hyperbolic'
+    name = 'hyperbolic'
+    _MAX_CLUSTER_NAME_LEN_LIMIT = 120
+    API_KEY_PATH = os.path.expanduser('~/.hyperbolic/api_key')
+
+    _CLOUD_UNSUPPORTED_FEATURES = {
+        clouds.CloudImplementationFeatures.STOP: ('Stopping not supported.'),
+        clouds.CloudImplementationFeatures.MULTI_NODE:
+            ('Multi-node not supported.'),
+        clouds.CloudImplementationFeatures.CUSTOM_DISK_TIER:
+            ('Custom disk tiers not supported.'),
+        clouds.CloudImplementationFeatures.STORAGE_MOUNTING:
+            ('Storage mounting not supported.'),
+        clouds.CloudImplementationFeatures.HIGH_AVAILABILITY_CONTROLLERS:
+            ('High availability controllers not supported.'),
+        clouds.CloudImplementationFeatures.SPOT_INSTANCE:
+            ('Spot instances not supported.'),
+        clouds.CloudImplementationFeatures.CLONE_DISK_FROM_CLUSTER:
+            ('Disk cloning not supported.'),
+        clouds.CloudImplementationFeatures.DOCKER_IMAGE:
+            ('Docker images not supported.'),
+        clouds.CloudImplementationFeatures.OPEN_PORTS:
+            ('Opening ports not supported.'),
+        clouds.CloudImplementationFeatures.IMAGE_ID:
+            ('Custom image IDs not supported.'),
+        clouds.CloudImplementationFeatures.CUSTOM_NETWORK_TIER:
+            ('Custom network tiers not supported.'),
+        clouds.CloudImplementationFeatures.HOST_CONTROLLERS:
+            ('Host controllers not supported.'),
+        clouds.CloudImplementationFeatures.AUTO_TERMINATE:
+            ('Auto-termination not supported.'),
+        clouds.CloudImplementationFeatures.AUTOSTOP:
+            ('Auto-stop not supported.'),
+        clouds.CloudImplementationFeatures.AUTODOWN:
+            ('Auto-down not supported.'),
+        clouds.CloudImplementationFeatures.CUSTOM_MULTI_NETWORK:
+            ('Customized multiple network interfaces not supported.'),
+    }
+
+    PROVISIONER_VERSION = clouds.ProvisionerVersion.SKYPILOT
+    STATUS_VERSION = clouds.StatusVersion.SKYPILOT
+    OPEN_PORTS_VERSION = clouds.OpenPortsVersion.LAUNCH_ONLY
+
+    @classmethod
+    def _unsupported_features_for_resources(
+        cls,
+        resources: 'resources_lib.Resources',
+        region: Optional[str] = None,
+    ) -> Dict[clouds.CloudImplementationFeatures, str]:
+        del resources
+        return cls._CLOUD_UNSUPPORTED_FEATURES
+
+    @classmethod
+    def _max_cluster_name_length(cls) -> Optional[int]:
+        return cls._MAX_CLUSTER_NAME_LEN_LIMIT
+
+    def instance_type_exists(self, instance_type: str) -> bool:
+        return catalog.instance_type_exists(instance_type, 'hyperbolic')
+
+    @classmethod
+    def regions_with_offering(
+        cls,
+        instance_type: str,
+        accelerators: Optional[Dict[str, int]],
+        use_spot: bool,
+        region: Optional[str],
+        zone: Optional[str],
+        resources: Optional['resources_lib.Resources'] = None,
+    ) -> List[clouds.Region]:
+        assert zone is None, 'Hyperbolic does not support zones.'
+        del accelerators, zone  # unused
+
+        regions = catalog.get_region_zones_for_instance_type(
+            instance_type, use_spot, 'hyperbolic')
+        if region is not None:
+            regions = [r for r in regions if r.name == region]
+        return regions
+
+    @classmethod
+    def get_vcpus_mem_from_instance_type(
+            cls, instance_type: str) -> Tuple[Optional[float], Optional[float]]:
+        return catalog.get_vcpus_mem_from_instance_type(instance_type,
+                                                        clouds='hyperbolic')
+
+    def instance_type_to_hourly_cost(self,
+                                     instance_type: str,
+                                     use_spot: bool,
+                                     region: Optional[str] = None,
+                                     zone: Optional[str] = None) -> float:
+        return catalog.get_hourly_cost(instance_type,
+                                       use_spot=use_spot,
+                                       region=region,
+                                       zone=zone,
+                                       clouds='hyperbolic')
+
+    @classmethod
+    def get_default_instance_type(cls,
+                                  cpus: Optional[str] = None,
+                                  memory: Optional[str] = None,
+                                  disk_tier: Optional[DiskTier] = None,
+                                  region: Optional[str] = None,
+                                  zone: Optional[str] = None) -> Optional[str]:
+        return catalog.get_default_instance_type(cpus=cpus,
+                                                 memory=memory,
+                                                 disk_tier=disk_tier,
+                                                 region=region,
+                                                 zone=zone,
+                                                 clouds='hyperbolic')
+
+    @classmethod
+    def get_accelerators_from_instance_type(
+            cls, instance_type: str) -> Optional[Dict[str, Union[int, float]]]:
+        return catalog.get_accelerators_from_instance_type(instance_type,
+                                                           clouds='hyperbolic')
+
+    @classmethod
+    def _check_credentials(cls) -> Tuple[bool, Optional[str]]:
+        if os.path.exists(cls.API_KEY_PATH):
+            return True, None
+        return False, f'API key not found at {cls.API_KEY_PATH}'
+
+    @classmethod
+    def _check_compute_credentials(cls) -> Tuple[bool, Optional[str]]:
+        return cls._check_credentials()
+
+    @classmethod
+    def get_credential_file_mounts(cls) -> Dict[str, str]:
+        if os.path.exists(cls.API_KEY_PATH):
+            return {cls.API_KEY_PATH: '~/.hyperbolic/api_key'}
+        return {}
+
+    def __repr__(self):
+        return self._REPR
+
+    def _get_feasible_launchable_resources(
+        self, resources: 'resources_lib.Resources'
+    ) -> 'resources_utils.FeasibleResources':
+        # Check if the instance type exists in the catalog
+        if resources.instance_type is not None:
+            if catalog.instance_type_exists(resources.instance_type,
+                                            'hyperbolic'):
+                # Remove accelerators for launchable resources
+                resources_launch = resources.copy(accelerators=None)
+                return resources_utils.FeasibleResources([resources_launch], [],
+                                                         None)
+            else:
+                raise ValueError(
+                    f'Invalid instance type: {resources.instance_type}')
+
+        # If accelerators are specified
+        accelerators = resources.accelerators
+        if accelerators is not None:
+            assert len(accelerators) == 1, resources
+            acc, acc_count = list(accelerators.items())[0]
+            (instance_list,
+             fuzzy_candidate_list) = catalog.get_instance_type_for_accelerator(
+                 acc,
+                 acc_count,
+                 use_spot=resources.use_spot,
+                 cpus=resources.cpus,
+                 memory=resources.memory,
+                 region=resources.region,
+                 zone=resources.zone,
+                 clouds='hyperbolic')
+            if instance_list is None:
+                return resources_utils.FeasibleResources([],
+                                                         fuzzy_candidate_list,
+                                                         None)
+
+            def _make(instance_list):
+                resource_list = []
+                for instance_type in instance_list:
+                    r = resources.copy(
+                        cloud=self,
+                        instance_type=instance_type,
+                        accelerators=None,
+                        cpus=None,
+                        memory=None,
+                    )
+                    resource_list.append(r)
+                return resource_list
+
+            return resources_utils.FeasibleResources(_make(instance_list),
+                                                     fuzzy_candidate_list, None)
+
+        # If nothing is specified, return a default instance type
+        default_instance_type = self.get_default_instance_type(
+            cpus=resources.cpus,
+            memory=resources.memory,
+            disk_tier=resources.disk_tier,
+            region=resources.region,
+            zone=resources.zone)
+        if default_instance_type is None:
+            return resources_utils.FeasibleResources([], [], None)
+        else:
+            r = resources.copy(
+                cloud=self,
+                instance_type=default_instance_type,
+                accelerators=None,
+                cpus=None,
+                memory=None,
+            )
+            return resources_utils.FeasibleResources([r], [], None)
+
+    def validate_region_zone(
+            self, region: Optional[str],
+            zone: Optional[str]) -> Tuple[Optional[str], Optional[str]]:
+        if zone is not None:
+            raise ValueError('Hyperbolic does not support zones.')
+        return catalog.validate_region_zone(region, zone, 'hyperbolic')
+
+    @classmethod
+    def regions(cls) -> List[clouds.Region]:
+        """Returns the list of regions in Hyperbolic's catalog."""
+        return catalog.regions('hyperbolic')
+
+    @classmethod
+    def zones_provision_loop(cls,
+                             *,
+                             region: str,
+                             num_nodes: int,
+                             instance_type: str,
+                             accelerators: Optional[Dict[str, int]] = None,
+                             use_spot: bool = False):
+        yield None
+
+    @classmethod
+    def get_zone_shell_cmd(cls) -> Optional[str]:
+        return None
+
+    def get_egress_cost(self, num_gigabytes: float):
+        return 0.0
+
+    def accelerators_to_hourly_cost(self, accelerators: Dict[str, int],
+                                    use_spot: bool, region: Optional[str],
+                                    zone: Optional[str]) -> float:
+        return 0.0
+
+    def make_deploy_resources_variables(
+        self,
+        resources: 'resources_lib.Resources',
+        cluster_name: resources_utils.ClusterName,
+        region: 'clouds.Region',
+        zones: Optional[List['clouds.Zone']],
+        num_nodes: int,
+        dryrun: bool = False,
+        volume_mounts: Optional[List['volume_lib.VolumeMount']] = None,
+    ) -> Dict[str, Any]:
+        """Returns a dict of variables for the deployment template."""
+        del dryrun, region, cluster_name  # unused
+        assert zones is None, ('Hyperbolic does not support zones', zones)
+
+        resources = resources.assert_launchable()
+        # resources.accelerators is cleared but .instance_type encodes the info.
+        acc_dict = self.get_accelerators_from_instance_type(
+            resources.instance_type)
+        custom_resources = resources_utils.make_ray_custom_resources_str(
+            acc_dict)
+
+        return {
+            'instance_type': resources.instance_type,
+            'custom_resources': custom_resources,
+            'num_nodes': 1,  # Hyperbolic only supports single-node clusters
+        }
+
+    def cluster_name_in_hint(self, cluster_name_on_cloud: Optional[str],
+                             cluster_name: str) -> bool:
+        """Check if a node's name matches the cluster name pattern."""
+        if cluster_name_on_cloud is None:
+            return False
+        return cluster_name_on_cloud.startswith(cluster_name)

sky/clouds/ibm.py

@@ -5,11 +5,11 @@ from typing import Any, Dict, Iterator, List, Optional, Tuple, Union
 
 import colorama
 
+from sky import catalog
 from sky import clouds
 from sky import sky_logging
 from sky.adaptors import ibm
 from sky.adaptors.ibm import CREDENTIAL_FILE
-from sky.clouds import service_catalog
 from sky.utils import registry
 from sky.utils import resources_utils
 from sky.utils import status_lib
@@ -18,6 +18,7 @@ from sky.utils import ux_utils
 if typing.TYPE_CHECKING:
     # renaming to avoid shadowing variables
     from sky import resources as resources_lib
+    from sky.utils import volume as volume_lib
 
 logger = sky_logging.init_logger(__name__)
 
@@ -36,7 +37,9 @@ class IBM(clouds.Cloud):
 
     @classmethod
     def _unsupported_features_for_resources(
-        cls, resources: 'resources_lib.Resources'
+        cls,
+        resources: 'resources_lib.Resources',
+        region: Optional[str] = None,
     ) -> Dict[clouds.CloudImplementationFeatures, str]:
         features = {
             clouds.CloudImplementationFeatures.CLONE_DISK_FROM_CLUSTER:
@@ -52,6 +55,9 @@ class IBM(clouds.Cloud):
                 (f'Opening ports is currently not supported on {cls._REPR}.'),
             clouds.CloudImplementationFeatures.HIGH_AVAILABILITY_CONTROLLERS:
                 ('High availability controllers are not supported on IBM.'),
+            clouds.CloudImplementationFeatures.CUSTOM_MULTI_NETWORK:
+                ('Customized multiple network interfaces are not supported on '
+                 f'{cls._REPR}.'),
         }
         if resources.use_spot:
             features[clouds.CloudImplementationFeatures.STOP] = (
@@ -64,14 +70,19 @@ class IBM(clouds.Cloud):
         return cls._MAX_CLUSTER_NAME_LEN_LIMIT
 
     @classmethod
-    def regions_with_offering(cls, instance_type: str,
-                              accelerators: Optional[Dict[str, int]],
-                              use_spot: bool, region: Optional[str],
-                              zone: Optional[str]) -> List[clouds.Region]:
+    def regions_with_offering(
+        cls,
+        instance_type: str,
+        accelerators: Optional[Dict[str, int]],
+        use_spot: bool,
+        region: Optional[str],
+        zone: Optional[str],
+        resources: Optional['resources_lib.Resources'] = None,
+    ) -> List[clouds.Region]:
         del accelerators  # unused
         if use_spot:
             return []
-        regions = service_catalog.get_region_zones_for_instance_type(
+        regions = catalog.get_region_zones_for_instance_type(
             instance_type, use_spot, 'ibm')
 
         if region is not None:
@@ -131,11 +142,11 @@ class IBM(clouds.Cloud):
                                      zone: Optional[str] = None) -> float:
         # Currently doesn't support spot instances, hence use_spot set to False.
         del use_spot
-        return service_catalog.get_hourly_cost(instance_type,
-                                               use_spot=False,
-                                               region=region,
-                                               zone=zone,
-                                               clouds='ibm')
+        return catalog.get_hourly_cost(instance_type,
+                                       use_spot=False,
+                                       region=region,
+                                       zone=zone,
+                                       clouds='ibm')
 
     def accelerators_to_hourly_cost(self,
                                     accelerators: Dict[str, int],
@@ -175,7 +186,8 @@ class IBM(clouds.Cloud):
         zones: Optional[List['clouds.Zone']],
         num_nodes: int,
         dryrun: bool = False,
-    ) -> Dict[str, Optional[str]]:
+        volume_mounts: Optional[List['volume_lib.VolumeMount']] = None,
+    ) -> Dict[str, Any]:
         """Converts planned sky.Resources to cloud-specific resource variables.
 
         These variables are used to fill the node type section (instance type,
@@ -204,30 +216,32 @@ class IBM(clouds.Cloud):
         # clouds implementing 'zones_provision_loop()'
         zone_names = [zone.name for zone in zones]  # type: ignore[union-attr]
 
-        r = resources
-        assert not r.use_spot, \
+        resources = resources.assert_launchable()
+        assert not resources.use_spot, \
             'IBM does not currently support spot instances in this framework'
 
-        acc_dict = self.get_accelerators_from_instance_type(r.instance_type)
+        acc_dict = self.get_accelerators_from_instance_type(
+            resources.instance_type)
         custom_resources = resources_utils.make_ray_custom_resources_str(
             acc_dict)
 
-        instance_resources = _get_profile_resources(r.instance_type)
+        instance_resources = _get_profile_resources(resources.instance_type)
 
         worker_instance_type = get_cred_file_field('worker_instance_type',
-                                                   r.instance_type)
+                                                   resources.instance_type)
         worker_instance_resources = _get_profile_resources(worker_instance_type)
         # r.image_id: {clouds.Region:image_id} - property of Resources class
-        image_id = r.image_id[
-            region.name] if r.image_id else self.get_default_image(region_name)
+        image_id = resources.image_id[
+            region.name] if resources.image_id else self.get_default_image(
+                region_name)
 
         return {
-            'instance_type': r.instance_type,
+            'instance_type': resources.instance_type,
             'instance_resources': instance_resources,
             'worker_instance_type': worker_instance_type,
             'worker_instance_resources': worker_instance_resources,
             'custom_resources': custom_resources,
-            'use_spot': r.use_spot,
+            'use_spot': resources.use_spot,
             'region': region_name,
             'zones': ','.join(zone_names),
             'image_id': image_id,
@@ -241,8 +255,8 @@ class IBM(clouds.Cloud):
         cls,
         instance_type: str,
     ) -> Tuple[Optional[float], Optional[float]]:
-        return service_catalog.get_vcpus_mem_from_instance_type(instance_type,
-                                                                clouds='ibm')
+        return catalog.get_vcpus_mem_from_instance_type(instance_type,
+                                                        clouds='ibm')
 
     @classmethod
     def get_accelerators_from_instance_type(
@@ -250,20 +264,23 @@ class IBM(clouds.Cloud):
         instance_type: str,
     ) -> Optional[Dict[str, Union[int, float]]]:
         """Returns {acc: acc_count} held by 'instance_type', if any."""
-        return service_catalog.get_accelerators_from_instance_type(
-            instance_type, clouds='ibm')
+        return catalog.get_accelerators_from_instance_type(instance_type,
+                                                           clouds='ibm')
 
     @classmethod
     def get_default_instance_type(
-        cls,
-        cpus: Optional[str] = None,
-        memory: Optional[str] = None,
-        disk_tier: Optional['resources_utils.DiskTier'] = None
-    ) -> Optional[str]:
-        return service_catalog.get_default_instance_type(cpus=cpus,
-                                                         memory=memory,
-                                                         disk_tier=disk_tier,
-                                                         clouds='ibm')
+            cls,
+            cpus: Optional[str] = None,
+            memory: Optional[str] = None,
+            disk_tier: Optional['resources_utils.DiskTier'] = None,
+            region: Optional[str] = None,
+            zone: Optional[str] = None) -> Optional[str]:
+        return catalog.get_default_instance_type(cpus=cpus,
+                                                 memory=memory,
+                                                 disk_tier=disk_tier,
+                                                 region=region,
+                                                 zone=zone,
+                                                 clouds='ibm')
 
     def _get_feasible_launchable_resources(
         self, resources: 'resources_lib.Resources'
@@ -298,7 +315,9 @@ class IBM(clouds.Cloud):
             default_instance_type = IBM.get_default_instance_type(
                 cpus=resources.cpus,
                 memory=resources.memory,
-                disk_tier=resources.disk_tier)
+                disk_tier=resources.disk_tier,
+                region=resources.region,
+                zone=resources.zone)
             if default_instance_type is None:
                 return resources_utils.FeasibleResources([], [], None)
             else:
@@ -307,15 +326,15 @@ class IBM(clouds.Cloud):
 
         assert len(accelerators) == 1, resources
         acc, acc_count = list(accelerators.items())[0]
-        (instance_list, fuzzy_candidate_list
-        ) = service_catalog.get_instance_type_for_accelerator(
-            acc,
-            acc_count,
-            cpus=resources.cpus,
-            memory=resources.memory,
-            region=resources.region,
-            zone=resources.zone,
-            clouds='ibm')
+        (instance_list,
+         fuzzy_candidate_list) = catalog.get_instance_type_for_accelerator(
+             acc,
+             acc_count,
+             cpus=resources.cpus,
+             memory=resources.memory,
+             region=resources.region,
+             zone=resources.zone,
+             clouds='ibm')
         if instance_list is None:
             return resources_utils.FeasibleResources([], fuzzy_candidate_list,
                                                      None)
@@ -397,13 +416,15 @@ class IBM(clouds.Cloud):
         return image_size
 
     @classmethod
-    def _check_compute_credentials(cls) -> Tuple[bool, Optional[str]]:
+    def _check_compute_credentials(
+            cls) -> Tuple[bool, Optional[Union[str, Dict[str, str]]]]:
         """Checks if the user has access credentials to
         IBM's compute service."""
         return cls._check_credentials()
 
     @classmethod
-    def _check_storage_credentials(cls) -> Tuple[bool, Optional[str]]:
+    def _check_storage_credentials(
+            cls) -> Tuple[bool, Optional[Union[str, Dict[str, str]]]]:
         """Checks if the user has access credentials to
         IBM's storage service."""
         # TODO(seungjin): Implement separate check for
@@ -458,11 +479,11 @@ class IBM(clouds.Cloud):
 
     def instance_type_exists(self, instance_type):
         """Returns whether the instance type exists for this cloud."""
-        return service_catalog.instance_type_exists(instance_type, clouds='ibm')
+        return catalog.instance_type_exists(instance_type, clouds='ibm')
 
     def validate_region_zone(self, region: Optional[str], zone: Optional[str]):
         """Validates the region and zone."""
-        return service_catalog.validate_region_zone(region, zone, clouds='ibm')
+        return catalog.validate_region_zone(region, zone, clouds='ibm')
 
     @classmethod
     def query_status(cls, name: str, tag_filters: Dict[str, str],