anyscale 0.24.88__py3-none-any.whl → 0.25.0__py3-none-any.whl

anyscale/resource_quota/__init__.py

@@ -0,0 +1,99 @@
+from typing import List, Optional
+
+from anyscale._private.anyscale_client import AnyscaleClientInterface
+from anyscale._private.sdk import sdk_docs
+from anyscale._private.sdk.base_sdk import Timer
+from anyscale.cli_logger import BlockLogger
+from anyscale.resource_quota._private.resource_quota_sdk import PrivateResourceQuotaSDK
+from anyscale.resource_quota.commands import (
+    _CREATE_DOCSTRINGS,
+    _CREATE_EXAMPLE,
+    _DELETE_DOCSTRINGS,
+    _DELETE_EXAMPLE,
+    _DISABLE_DOCSTRINGS,
+    _DISABLE_EXAMPLE,
+    _ENABLE_DOCSTRINGS,
+    _ENABLE_EXAMPLE,
+    _LIST_DOCSTRINGS,
+    _LIST_EXAMPLE,
+    create,
+    delete,
+    disable,
+    enable,
+    list,
+)
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
+
+
+class ResourceQuotaSDK:
+    def __init__(
+        self,
+        *,
+        client: Optional[AnyscaleClientInterface] = None,
+        logger: Optional[BlockLogger] = None,
+        timer: Optional[Timer] = None,
+    ):
+        self._private_sdk = PrivateResourceQuotaSDK(
+            client=client, logger=logger, timer=timer
+        )
+
+    @sdk_docs(
+        doc_py_example=_CREATE_EXAMPLE, arg_docstrings=_CREATE_DOCSTRINGS,
+    )
+    def create(  # noqa: F811
+        self, create_resource_quota: CreateResourceQuota,
+    ) -> ResourceQuota:
+        """Create a resource quota.
+        """
+        return self._private_sdk.create(create_resource_quota)
+
+    @sdk_docs(
+        doc_py_example=_LIST_EXAMPLE, arg_docstrings=_LIST_DOCSTRINGS,
+    )
+    def list(  # noqa: F811
+        self,
+        name: Optional[str] = None,
+        cloud: Optional[str] = None,
+        creator_id: Optional[str] = None,
+        is_enabled: Optional[bool] = None,
+        max_items: int = 20,
+    ) -> List[ResourceQuota]:
+        """List resource quotas.
+        """
+        return self._private_sdk.list(
+            name=name,
+            cloud=cloud,
+            creator_id=creator_id,
+            is_enabled=is_enabled,
+            max_items=max_items,
+        )
+
+    @sdk_docs(
+        doc_py_example=_DELETE_EXAMPLE, arg_docstrings=_DELETE_DOCSTRINGS,
+    )
+    def delete(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Delete a resource quota.
+        """
+        return self._private_sdk.delete(resource_quota_id)
+
+    @sdk_docs(
+        doc_py_example=_ENABLE_EXAMPLE, arg_docstrings=_ENABLE_DOCSTRINGS,
+    )
+    def enable(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Enable a resource quota.
+        """
+        return self._private_sdk.set_status(resource_quota_id, True)
+
+    @sdk_docs(
+        doc_py_example=_DISABLE_EXAMPLE, arg_docstrings=_DISABLE_DOCSTRINGS,
+    )
+    def disable(  # noqa: F811
+        self, resource_quota_id: str,
+    ):
+        """Disable a resource quota.
+        """
+        return self._private_sdk.set_status(resource_quota_id, False)

anyscale/resource_quota/_private/resource_quota_sdk.py

@@ -0,0 +1,111 @@
+from typing import List, Optional
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.client.openapi_client.models.create_resource_quota import (
+    CreateResourceQuota as CreateResourceQuotaModel,
+)
+from anyscale.client.openapi_client.models.quota import Quota as QuotaModel
+from anyscale.resource_quota.models import CreateResourceQuota, Quota, ResourceQuota
+
+
+class PrivateResourceQuotaSDK(BaseSDK):
+    def create(self, create_resource_quota: CreateResourceQuota) -> ResourceQuota:
+        cloud_id = self.client.get_cloud_id(
+            cloud_name=create_resource_quota.cloud, compute_config_id=None
+        )
+
+        project_id = (
+            self.client.get_project_id(
+                parent_cloud_id=cloud_id, name=create_resource_quota.project
+            )
+            if create_resource_quota.project
+            else None
+        )
+
+        user_id = (
+            self.client.get_organization_collaborator(
+                email=create_resource_quota.user_email
+            ).user_id
+            if create_resource_quota.user_email
+            else None
+        )
+
+        create_resource_quota_model = CreateResourceQuotaModel(
+            name=create_resource_quota.name,
+            cloud_id=cloud_id,
+            project_id=project_id,
+            user_id=user_id,
+            quota=QuotaModel(
+                num_cpus=create_resource_quota.num_cpus,
+                num_instances=create_resource_quota.num_instances,
+                num_gpus=create_resource_quota.num_gpus,
+                num_accelerators=create_resource_quota.num_accelerators,
+            ),
+        )
+
+        resource_quota = self.client.create_resource_quota(
+            create_resource_quota=create_resource_quota_model
+        )
+
+        return ResourceQuota(
+            id=resource_quota.id,
+            name=resource_quota.name,
+            cloud_id=resource_quota.cloud_id,
+            project_id=resource_quota.project_id,
+            user_id=resource_quota.user_id,
+            is_enabled=resource_quota.is_enabled,
+            created_at=resource_quota.created_at,
+            deleted_at=resource_quota.deleted_at,
+            quota=Quota(
+                num_cpus=resource_quota.quota.num_cpus,
+                num_instances=resource_quota.quota.num_instances,
+                num_gpus=resource_quota.quota.num_gpus,
+                num_accelerators=resource_quota.quota.num_accelerators,
+            ),
+        )
+
+    def list(
+        self,
+        name: Optional[str] = None,
+        cloud: Optional[str] = None,
+        creator_id: Optional[str] = None,
+        is_enabled: Optional[bool] = None,
+        max_items: int = 20,
+    ) -> List[ResourceQuota]:
+        cloud_id = (
+            self.client.get_cloud_id(cloud_name=cloud, compute_config_id=None)
+            if cloud
+            else None
+        )
+
+        resource_quotas = self.client.list_resource_quotas(
+            name, cloud_id, creator_id, is_enabled, max_items,
+        )
+
+        return [
+            ResourceQuota(
+                id=resource_quota.id,
+                name=resource_quota.name,
+                cloud_id=resource_quota.cloud_id,
+                project_id=resource_quota.project_id,
+                user_id=resource_quota.user_id,
+                is_enabled=resource_quota.is_enabled,
+                created_at=resource_quota.created_at,
+                deleted_at=resource_quota.deleted_at,
+                quota=Quota(
+                    num_cpus=resource_quota.quota.num_cpus,
+                    num_instances=resource_quota.quota.num_instances,
+                    num_gpus=resource_quota.quota.num_gpus,
+                    num_accelerators=resource_quota.quota.num_accelerators,
+                ),
+            )
+            for resource_quota in resource_quotas
+        ]
+
+    def delete(self, resource_quota_id: str) -> None:
+        self.client.delete_resource_quota(resource_quota_id=resource_quota_id)
+
+    def set_status(self, resource_quota_id: str, is_enabled: bool) -> None:
+        self.client.set_resource_quota_status(
+            resource_quota_id=resource_quota_id, is_enabled=is_enabled
+        )

anyscale/resource_quota/commands.py

@@ -0,0 +1,150 @@
+from typing import List, Optional
+
+from anyscale._private.sdk import sdk_command
+from anyscale.resource_quota._private.resource_quota_sdk import PrivateResourceQuotaSDK
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
+
+
+_RESOURCE_QUOTA_SDK_SINGLETON_KEY = "resource_quota_sdk"
+
+_CREATE_EXAMPLE = """
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota
+
+anyscale.resource_quota.create(
+    ResourceQuota(
+        name="my-resource-quota",
+        cloud="my-cloud",
+        project="my-project",
+        num_cpus=2,
+    ),
+)
+"""
+
+_CREATE_DOCSTRINGS = {"create_resource_quota": "The resource quota to be created."}
+
+_LIST_EXAMPLE = """
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota
+
+anyscale.resource_quota.list(
+    name="my-resource-quota",
+    cloud="my-cloud",
+    creator_id="usr_123",
+    is_enabled=True,
+    max_items=20,
+)
+"""
+
+_LIST_DOCSTRINGS = {
+    "name": "Name of the resource quota.",
+    "cloud": "Name of the cloud that this resource quota applies to.",
+    "creator_id": "ID of the creator of the resource quota.",
+    "is_enabled": "Whether the resource quota is enabled.",
+    "max_items": "Maximum number of items to return.",
+}
+
+_DELETE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.delete(
+    resource_quota_id="rq_123",
+)
+"""
+
+_DELETE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to delete.",
+}
+
+_ENABLE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.enable(
+    resource_quota_id="rq_123",
+)
+"""
+
+_ENABLE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to enable.",
+}
+
+_DISABLE_EXAMPLE = """
+import anyscale
+
+anyscale.resource_quota.disable(
+    resource_quota_id="rq_123",
+)
+"""
+
+_DISABLE_DOCSTRINGS = {
+    "resource_quota_id": "ID of the resource quota to disable.",
+}
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_CREATE_EXAMPLE,
+    arg_docstrings=_CREATE_DOCSTRINGS,
+)
+def create(
+    create_resource_quota: CreateResourceQuota, *, _sdk: PrivateResourceQuotaSDK
+) -> ResourceQuota:
+    """Create a resource quota.
+    """
+    return _sdk.create(create_resource_quota)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_LIST_EXAMPLE,
+    arg_docstrings=_LIST_DOCSTRINGS,
+)
+def list(  # noqa: A001
+    name: Optional[str] = None,
+    cloud: Optional[str] = None,
+    creator_id: Optional[str] = None,
+    is_enabled: Optional[bool] = None,
+    max_items: int = 20,
+    *,
+    _sdk: PrivateResourceQuotaSDK
+) -> List[ResourceQuota]:
+    """List resource quotas. """
+    return _sdk.list(name, cloud, creator_id, is_enabled, max_items,)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_DELETE_EXAMPLE,
+    arg_docstrings=_DELETE_DOCSTRINGS,
+)
+def delete(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Delete a resource quota.
+    """
+    return _sdk.delete(resource_quota_id)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_ENABLE_EXAMPLE,
+    arg_docstrings=_ENABLE_DOCSTRINGS,
+)
+def enable(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Enable a resource quota.
+    """
+    return _sdk.set_status(resource_quota_id, True)
+
+
+@sdk_command(
+    _RESOURCE_QUOTA_SDK_SINGLETON_KEY,
+    PrivateResourceQuotaSDK,
+    doc_py_example=_DISABLE_EXAMPLE,
+    arg_docstrings=_DISABLE_DOCSTRINGS,
+)
+def disable(resource_quota_id: str, *, _sdk: PrivateResourceQuotaSDK):
+    """Disable a resource quota.
+    """
+    return _sdk.set_status(resource_quota_id, False)

anyscale/resource_quota/models.py

@@ -0,0 +1,303 @@
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Dict, Optional
+
+from anyscale._private.models import ModelBase
+
+
+@dataclass(frozen=True)
+class CreateResourceQuota(ModelBase):
+    """Resource quota creation model.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota
+
+create_resource_quota = CreateResourceQuota(
+    # Name of the resource quota to create
+    name="resource_quota_name",
+    # Name of the cloud that this resource quota applies to
+    cloud="cloud_name",
+    # Name of the project that this resource quota applies to (optional)
+    project="project_name",
+    # Email of the user that this resource quota applies to (optional)
+    user_email="test@anyscale.com",
+    # The quota limit for the number of CPUs (optional)
+    num_cpus=50,
+    # The quota limit for the number of instances (optional)
+    num_instances=100,
+    # The quota limit for the total number of GPUs (optional)
+    num_gpus=30,
+    # The quota limit for the number of accelerators (optional)
+    num_accelerators={"A100-80G": 10, "T4": 20},
+)
+"""
+
+    name: str = field(metadata={"docstring": "Name of the resource quota to create."})
+
+    def _validate_name(self, name: str):
+        if not isinstance(name, str):
+            raise TypeError("name must be a string.")
+
+    cloud: str = field(
+        metadata={"docstring": "Name of the cloud that this resource quota applies to."}
+    )
+
+    def _validate_cloud(self, cloud: str):
+        if not isinstance(cloud, str):
+            raise TypeError("cloud must be a string.")
+
+    project: Optional[str] = field(
+        default=None,
+        metadata={
+            "docstring": "Name of the project that this resource quota applies to (optional)."
+        },
+    )
+
+    def _validate_project(self, project: Optional[str]):
+        if project is not None and not isinstance(project, str):
+            raise TypeError("project must be a string.")
+
+    user_email: Optional[str] = field(
+        default=None,
+        metadata={
+            "docstring": "Email of the user that this resource quota applies to (optional)."
+        },
+    )
+
+    def _validate_user_email(self, user_email: Optional[str]):
+        if user_email is not None and not isinstance(user_email, str):
+            raise TypeError("user_email must be a string.")
+
+    num_cpus: Optional[int] = field(
+        default=None,
+        metadata={"docstring": "The quota limit for the number of CPUs (optional)."},
+    )
+
+    def _validate_num_cpus(self, num_cpus: Optional[int]):
+        if num_cpus is not None and not isinstance(num_cpus, int):
+            raise TypeError("num_cpus must be an integer.")
+
+    num_instances: Optional[int] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the number of instances. (optional)."
+        },
+    )
+
+    def _validate_num_instances(self, num_instances: Optional[int]):
+        if num_instances is not None and not isinstance(num_instances, int):
+            raise TypeError("num_instances must be an integer.")
+
+    num_gpus: Optional[int] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the total number of GPUs (optional)."
+        },
+    )
+
+    def _validate_num_gpus(self, num_gpus: Optional[int]):
+        if num_gpus is not None and not isinstance(num_gpus, int):
+            raise TypeError("num_gpus must be an integer.")
+
+    num_accelerators: Optional[Dict[str, int]] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the number of accelerators (optional)."
+        },
+    )
+
+    def _validate_num_accelerators(self, num_accelerators: Optional[Dict[str, int]]):
+        if num_accelerators is not None and not isinstance(num_accelerators, dict):
+            raise TypeError("num_accelerators must be a dictionary.")
+        if num_accelerators is not None:
+            for key, value in num_accelerators.items():
+                if not isinstance(key, str):
+                    raise TypeError("num_accelerators keys must be strings.")
+                if not isinstance(value, int):
+                    raise TypeError("num_accelerators values must be integers.")
+
+
+@dataclass(frozen=True)
+class Quota(ModelBase):
+    """Resource quota limit
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota, Quota
+
+create_resource_quota = CreateResourceQuota(
+    # Name of the resource quota to create
+    name="resource_quota_name",
+    # Name of the cloud that this resource quota applies to
+    cloud="cloud_name",
+    # Name of the project that this resource quota applies to (optional)
+    project="project_name",
+    # Email of the user that this resource quota applies to (optional)
+    user_email="test@anyscale.com",
+    # The quota limit for the number of CPUs (optional)
+    num_cpus=50,
+    # The quota limit for the number of instances (optional)
+    num_instances=100,
+    # The quota limit for the total number of GPUs (optional)
+    num_gpus=30,
+    # The quota limit for the number of accelerators (optional)
+    num_accelerators={"A100-80G": 10, "T4": 20},
+)
+
+resource_quota: ResourceQuota = anyscale.resource_quota.create(create_resource_quota)
+
+quota: Quota = resource_quota.quota
+"""
+    num_cpus: Optional[int] = field(
+        default=None,
+        metadata={"docstring": "The quota limit for the number of CPUs (optional)."},
+    )
+
+    def _validate_num_cpus(self, num_cpus: Optional[int]):
+        if num_cpus is not None and not isinstance(num_cpus, int):
+            raise TypeError("num_cpus must be an integer.")
+
+    num_instances: Optional[int] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the number of instances. (optional)."
+        },
+    )
+
+    def _validate_num_instances(self, num_instances: Optional[int]):
+        if num_instances is not None and not isinstance(num_instances, int):
+            raise TypeError("num_instances must be an integer.")
+
+    num_gpus: Optional[int] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the total number of GPUs (optional)."
+        },
+    )
+
+    def _validate_num_gpus(self, num_gpus: Optional[int]):
+        if num_gpus is not None and not isinstance(num_gpus, int):
+            raise TypeError("num_gpus must be an integer.")
+
+    num_accelerators: Optional[Dict[str, int]] = field(
+        default=None,
+        metadata={
+            "docstring": "The quota limit for the number of accelerators (optional)."
+        },
+    )
+
+    def _validate_num_accelerators(self, num_accelerators: Optional[Dict[str, int]]):
+        if num_accelerators is not None and not isinstance(num_accelerators, dict):
+            raise TypeError("num_accelerators must be a dictionary.")
+        if num_accelerators is not None:
+            for key, value in num_accelerators.items():
+                if not isinstance(key, str):
+                    raise TypeError("num_accelerators keys must be strings.")
+                if not isinstance(value, int):
+                    raise TypeError("num_accelerators values must be integers.")
+
+
+@dataclass(frozen=True)
+class ResourceQuota(ModelBase):
+    """Resource quota
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
+
+create_resource_quota = CreateResourceQuota(
+    # Name of the resource quota to create
+    name="resource_quota_name",
+    # Name of the cloud that this resource quota applies to
+    cloud="cloud_name",
+    # Name of the project that this resource quota applies to (optional)
+    project="project_name",
+    # Email of the user that this resource quota applies to (optional)
+    user_email="test@anyscale.com",
+    # The quota limit for the number of CPUs (optional)
+    num_cpus=50,
+    # The quota limit for the number of instances (optional)
+    num_instances=100,
+    # The quota limit for the total number of GPUs (optional)
+    num_gpus=30,
+    # The quota limit for the number of accelerators (optional)
+    num_accelerators={"A100-80G": 10, "T4": 20},
+)
+resource_quota: ResourceQuota = anyscale.resource_quota.create(create_resource_quota)
+"""
+    id: str = field(metadata={"docstring": "The ID of the resource quota."})
+
+    def _validate_id(self, id: str):  # noqa: A002
+        if not isinstance(id, str):
+            raise TypeError("id must be a string.")
+
+    name: str = field(metadata={"docstring": "Name of the resource quota."})
+
+    def _validate_name(self, name: str):
+        if not isinstance(name, str):
+            raise TypeError("name must be a string.")
+
+    quota: Quota = field(metadata={"docstring": "The quota limit."})
+
+    def _validate_quota(self, quota: Quota):
+        if not isinstance(quota, Quota):
+            raise TypeError("quota must be a Quota.")
+
+    created_at: datetime = field(
+        metadata={"docstring": "The timestamp when this resource quota was created."}
+    )
+
+    def _validate_created_at(self, created_at: datetime):
+        if not isinstance(created_at, datetime):
+            raise TypeError("created_at must be a datetime.")
+
+    cloud_id: str = field(
+        metadata={"docstring": "ID of the cloud that this resource quota applies to."}
+    )
+
+    def _validate_cloud_id(self, cloud_id: str):
+        if not isinstance(cloud_id, str):
+            raise TypeError("cloud_id must be a string.")
+
+    project_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "docstring": "ID of the project that this resource quota applies to (optional)."
+        },
+    )
+
+    def _validate_project_id(self, project_id: Optional[str]):
+        if project_id is not None and not isinstance(project_id, str):
+            raise TypeError("project_id must be a string.")
+
+    user_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "docstring": "ID of the user that this resource quota applies to (optional)."
+        },
+    )
+
+    def _validate_user_id(self, user_id: Optional[str]):
+        if user_id is not None and not isinstance(user_id, str):
+            raise TypeError("user_id must be a string.")
+
+    is_enabled: bool = field(
+        default=True, metadata={"docstring": "Whether the resource quota is enabled."}
+    )
+
+    def _validate_is_enabled(self, is_enabled: bool):
+        if not isinstance(is_enabled, bool):
+            raise TypeError("is_enabled must be a boolean.")
+
+    deleted_at: Optional[datetime] = field(
+        default=None,
+        metadata={"docstring": "The timestamp when this resource quota was deleted."},
+    )
+
+    def _validate_deleted_at(self, deleted_at: Optional[datetime]):
+        if deleted_at is not None and not isinstance(deleted_at, datetime):
+            raise TypeError("deleted_at must be a datetime.")

anyscale/scripts.py

@@ -29,6 +29,9 @@ from anyscale.commands.logs_commands import log_cli
 from anyscale.commands.machine_commands import machine_cli
 from anyscale.commands.machine_pool_commands import machine_pool_cli
 from anyscale.commands.migrate_commands import migrate_cli
+from anyscale.commands.organization_invitation_commands import (
+    organization_invitation_cli,
+)
 from anyscale.commands.project_commands import anyscale_init, project_cli
 from anyscale.commands.resource_quota_commands import resource_quota_cli
 from anyscale.commands.schedule_commands import schedule_cli
@@ -144,6 +147,7 @@ cli.add_command(service_account_cli)
 cli.add_command(resource_quota_cli)
 cli.add_command(aggregated_instance_usage_cli)
 cli.add_command(user_cli)
+cli.add_command(organization_invitation_cli)
 
 ALIASES = {
     "h": anyscale_help,