lightning-sdk 0.1.41__py3-none-any.whl → 0.1.42__py3-none-any.whl

lightning_sdk/plugin.py

@@ -127,7 +127,15 @@ class JobsPlugin(_Plugin):
         cloud_compute: Optional[Machine] = None,
         interruptible: bool = False,
     ) -> Job:
-        """Launches an asynchronous job."""
+        """Launches an asynchronous job.
+
+        Args:
+            command: The command to be executed.
+            name: The name of the job.
+            machine: The machine to run the job on.
+            interruptible: Whether to run the job on an interruptible machine.
+                These are cheaper but can be preempted at any time.
+        """
         if not name:
             name = _run_name("job")
 
@@ -139,7 +147,7 @@ class JobsPlugin(_Plugin):
             command=command,
             studio=self._studio,
             teamspace=self._studio.teamspace,
-            cluster=self._studio._cluster,
+            cloud_account=self._studio.cloud_account,
             interruptible=interruptible,
         )
 
@@ -161,29 +169,39 @@ class MultiMachineTrainingPlugin(_Plugin):
         machine: Machine = Machine.CPU,
         cloud_compute: Optional[Machine] = None,
         num_instances: int = 2,
-        strategy: str = "parallel",
         interruptible: bool = False,
     ) -> Job:
-        """Launches an asynchronous multi-machine-training."""
+        """Launches an asynchronous multi-machine-training.
+
+        Args:
+            command: The command to be executed.
+            name: The name of the job.
+            machine: The machine to run the job on.
+            num_instances: The number of instances to run the job on.
+            interruptible: Whether to run the job on an interruptible machine.
+                These are cheaper but can be preempted at any time.
+        """
+        from lightning_sdk.mmt import MMT
+
         if not name:
             name = _run_name("dist-run")
 
         machine = _resolve_deprecated_cloud_compute(machine, cloud_compute)
 
-        # TODO: assert num_instances >=2
-        resp = self._studio._studio_api.create_multi_machine_job(
-            entrypoint=command,
+        MMT._force_v1 = True
+
+        mmt = MMT.run(
             name=name,
-            num_instances=num_instances,
+            num_machines=num_instances,
             machine=machine,
-            strategy=strategy,
-            studio_id=self._studio._studio.id,
-            teamspace_id=self._studio._teamspace.id,
-            cluster_id=self._studio._studio.cluster_id,
+            command=command,
+            studio=self._studio,
+            teamspace=self._studio.teamspace,
             interruptible=interruptible,
         )
 
-        return Job(resp.name, self._studio.teamspace)
+        MMT._force_v1 = False
+        return mmt
 
 
 class MultiMachineDataPrepPlugin(_Plugin):
@@ -201,7 +219,16 @@ class MultiMachineDataPrepPlugin(_Plugin):
         num_instances: int = 2,
         interruptible: bool = False,
     ) -> Job:
-        """Launches an asynchronous multi-machine-processing-job."""
+        """Launches an asynchronous multi-machine-data-processing job.
+
+        Args:
+            command: The command to be executed.
+            name: The name of the job.
+            machine: The machine to run the job on.
+            num_instances: The number of instances to run the job on.
+            interruptible: Whether to run the job on an interruptible machine.
+                These are cheaper but can be preempted at any time.
+        """
         if not name:
             name = _run_name("data-prep")
 
@@ -214,7 +241,7 @@ class MultiMachineDataPrepPlugin(_Plugin):
             machine=machine,
             studio_id=self._studio._studio.id,
             teamspace_id=self._studio._teamspace.id,
-            cluster_id=self._studio._studio.cluster_id,
+            cloud_account=self._studio.cloud_account,
             interruptible=interruptible,
         )
 
@@ -261,7 +288,7 @@ class InferenceServerPlugin(_Plugin):
             endpoint=endpoint,
             studio_id=self._studio._studio.id,
             teamspace_id=self._studio._teamspace.id,
-            cluster_id=self._studio._studio.cluster_id,
+            cloud_account=self._studio.cloud_account,
             interruptible=interruptible,
         )
 

lightning_sdk/services/file_endpoint.py

@@ -11,6 +11,7 @@ from lightning_sdk.lightning_cloud.login import Auth
 from lightning_sdk.lightning_cloud.openapi import CommandArgumentCommandArgumentType
 from lightning_sdk.lightning_cloud.rest_client import LightningClient
 from lightning_sdk.services.utilities import _get_cluster, _get_project, _get_service_url
+from lightning_sdk.utils.resolve import _resolve_deprecated_cluster
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
@@ -25,16 +26,19 @@ class Client:
         self,
         name: str,
         teamspace: Optional[str],
-        cluster_id: Optional[str] = None,
+        cloud_account: Optional[str] = None,
+        cluster_id: Optional[str] = None,  # deprecated in favor of cloud_account
     ) -> None:
         """Constructor of the Client.
 
         Args:
             name: The name of the Studio File Endpoint Service.
             teamspace: The name of the teamspace you want to attach the upload data and artifacts to be.
-            cluster_id: The name of the cluster on which to upload the data.
+            cloud_account: The name of the cloud account on which to upload the data.
 
         """
+        cloud_account = _resolve_deprecated_cluster(cloud_account, cluster_id)
+
         self._auth = Auth()
 
         try:
@@ -46,7 +50,9 @@ class Client:
         self._teamspace = teamspace
         self._client = LightningClient()
         self._project = _get_project(client=self._client, project_name=teamspace)
-        self._cluster = _get_cluster(client=self._client, project_id=self._project.project_id, cluster_id=cluster_id)
+        self._cloud_account = _get_cluster(
+            client=self._client, project_id=self._project.project_id, cluster_id=cloud_account
+        )
         self._file_endpoint = self._client.endpoint_service_get_file_endpoint_by_name(
             project_id=self._project.project_id, name=self._name
         )
@@ -101,7 +107,7 @@ class Client:
             _FileUploader(
                 client=self._client,
                 teamspace_id=self._project.project_id,
-                cluster_id=self._cluster.cluster_id,
+                cloud_account=self._cloud_account.cluster_id,
                 file_path=argument.value,
                 progress_bar=True,
                 remote_path=_sanitize_uploads_remote_path(argument.value),
@@ -109,7 +115,7 @@ class Client:
 
         json = {
             "teamspace_id": self._project.project_id,
-            "cluster_id": self._cluster.cluster_id,
+            "cluster_id": self._cloud_account.cluster_id,
             "input": {},
         }
         for argument in self._arguments:

lightning_sdk/studio.py

@@ -11,7 +11,7 @@ from lightning_sdk.owner import Owner
 from lightning_sdk.status import Status
 from lightning_sdk.teamspace import Teamspace
 from lightning_sdk.user import User
-from lightning_sdk.utils.resolve import _resolve_teamspace, _setup_logger
+from lightning_sdk.utils.resolve import _resolve_deprecated_cluster, _resolve_teamspace, _setup_logger
 
 if TYPE_CHECKING:
     from lightning_sdk.plugin import Plugin
@@ -30,10 +30,9 @@ class Studio:
         teamspace: the name of the teamspace the studio is contained by
         org: the name of the organization owning the :param`teamspace` in case it is owned by an org
         user: the name of the user owning the :param`teamspace` in case it is owned directly by a user instead of an org
-        cluster: the name of the cluster, the studio should be created on.
+        cloud_account: the name of the cloud account, the studio should be created on.
             Doesn't matter when the studio already exists.
         create_ok: whether the studio will be created if it does not yet exist. Defaults to True
-
     Note:
         Since a teamspace can either be owned by an org or by a user directly,
         only one of the arguments can be provided.
@@ -49,13 +48,14 @@ class Studio:
         teamspace: Optional[Union[str, Teamspace]] = None,
         org: Optional[Union[str, Organization]] = None,
         user: Optional[Union[str, User]] = None,
-        cluster: Optional[str] = None,
+        cloud_account: Optional[str] = None,
         create_ok: bool = True,
+        cluster: Optional[str] = None,  # deprecated in favor of cloud_account
     ) -> None:
         self._studio_api = StudioApi()
 
         self._teamspace = _resolve_teamspace(teamspace=teamspace, org=org, user=user)
-        self._cluster = cluster
+        self._cloud_account = _resolve_deprecated_cluster(cloud_account, cluster)
         self._setup_done = False
 
         self._plugins = {}
@@ -70,7 +70,9 @@ class Studio:
                 self._studio = self._studio_api.get_studio(name, self._teamspace.id)
             except ValueError as e:
                 if create_ok:
-                    self._studio = self._studio_api.create_studio(name, self._teamspace.id, cluster=self._cluster)
+                    self._studio = self._studio_api.create_studio(
+                        name, self._teamspace.id, cloud_account=self._cloud_account
+                    )
                 else:
                     raise ValueError(f"Studio {name} does not exist.") from e
 
@@ -144,6 +146,11 @@ class Studio:
     @property
     def cluster(self) -> str:
         """Returns the cluster the Studio is running on."""
+        warnings.warn("Studio.cluster is deprecated. Use Studio.cloud_account instead", DeprecationWarning)
+        return self.cloud_account
+
+    @property
+    def cloud_account(self) -> str:
         return self._studio.cluster_id
 
     def start(self, machine: Union[Machine, str] = Machine.CPU, interruptible: bool = False) -> None:
@@ -242,7 +249,7 @@ class Studio:
         self._studio_api.upload_file(
             studio_id=self._studio.id,
             teamspace_id=self._teamspace.id,
-            cluster_id=self._studio.cluster_id,
+            cloud_account=self._studio.cluster_id,
             file_path=file_path,
             remote_path=os.path.normpath(remote_path),
             progress_bar=progress_bar,
@@ -258,7 +265,7 @@ class Studio:
             target_path=file_path,
             studio_id=self._studio.id,
             teamspace_id=self._teamspace.id,
-            cluster_id=self._studio.cluster_id,
+            cloud_account=self._studio.cluster_id,
         )
 
     def download_folder(self, remote_path: str, target_path: Optional[str] = None) -> None:
@@ -271,7 +278,7 @@ class Studio:
             target_path=target_path,
             studio_id=self._studio.id,
             teamspace_id=self._teamspace.id,
-            cluster_id=self._studio.cluster_id,
+            cloud_account=self._studio.cluster_id,
         )
 
     @property

lightning_sdk/teamspace.py

@@ -1,3 +1,4 @@
+import warnings
 from pathlib import Path
 from typing import TYPE_CHECKING, List, Optional, Union
 
@@ -97,23 +98,33 @@ class Teamspace:
         from lightning_sdk.studio import Studio
 
         studios = []
-        clusters = self._teamspace_api.list_clusters(teamspace_id=self.id)
+        clusters = self._teamspace_api.list_cloud_accounts(teamspace_id=self.id)
         for cl in clusters:
-            _studios = self._teamspace_api.list_studios(teamspace_id=self.id, cluster_id=cl.cluster_id)
+            _studios = self._teamspace_api.list_studios(teamspace_id=self.id, cloud_account=cl.cluster_id)
             for s in _studios:
                 studios.append(Studio(name=s.name, teamspace=self, cluster=cl.cluster_name, create_ok=False))
 
         return studios
 
     @property
-    def default_cluster(self) -> str:
+    def default_cloud_account(self) -> str:
         return self._teamspace.project_settings.preferred_cluster
 
+    @property
+    def cloud_accounts(self) -> List[str]:
+        """All cloud accounts associated with that teamspace."""
+        clusters = self._teamspace_api.list_cloud_accounts(teamspace_id=self.id)
+        return [cl.cluster_name for cl in clusters]
+
     @property
     def clusters(self) -> List[str]:
         """All clusters associated with that teamspace."""
-        clusters = self._teamspace_api.list_clusters(teamspace_id=self.id)
-        return [cl.cluster_name for cl in clusters]
+        warnings.warn(
+            "The 'clusters' attribute is deprecated and will be removed in the future. "
+            "Please use the 'cloud_accounts' attribute instead.",
+            DeprecationWarning,
+        )
+        return self.cloud_accounts
 
     def __eq__(self, other: "Teamspace") -> bool:
         """Checks whether the provided other object is equal to this one."""
@@ -179,7 +190,9 @@ class Teamspace:
         if not path.exists():
             raise FileNotFoundError(str(path))
 
-        cloud_account = self._teamspace_api._determine_cluster_id(self.id) if cloud_account is None else cloud_account
+        cloud_account = (
+            self._teamspace_api._determine_cloud_account(self.id) if cloud_account is None else cloud_account
+        )
         filepaths = [path] if path.is_file() else [p for p in path.rglob("*") if p.is_file()]
 
         if not filepaths:
@@ -199,14 +212,14 @@ class Teamspace:
             metadata={"filenames": filenames},
             private=True,
             teamspace_id=self.id,
-            cluster_id=cloud_account,
+            cloud_account=cloud_account,
         )
         self._teamspace_api.upload_model_files(
             model_id=model.model_id,
             version=model.version,
             root_path=root_path,
             filepaths=filepaths,
-            cluster_id=cloud_account,
+            cloud_account=cloud_account,
             teamspace_id=self.id,
             progress_bar=progress_bar,
         )

lightning_sdk/utils/resolve.py

@@ -46,6 +46,24 @@ def _resolve_deprecated_cloud_compute(machine: Machine, cloud_compute: Optional[
     return machine
 
 
+def _resolve_deprecated_cluster(cloud_account: Optional[str], cluster: Optional[str]) -> Optional[str]:
+    if cluster is not None:
+        if cloud_account is not None:
+            raise ValueError(
+                "Cannot use both 'cluster' and 'cloud_account' at the same time."
+                "Please don't set the 'cluster' as it will be deprecated!"
+            )
+
+        warnings.warn(
+            "The 'cluster' argument will be deprecated in the future! "
+            "Please consider using the 'cloud_account' argument instead!",
+            DeprecationWarning,
+        )
+        return cluster
+
+    return cloud_account
+
+
 def _resolve_org_name(name: Optional[str]) -> Optional[str]:
     if name is None:
         name = os.environ.get("LIGHTNING_ORG", "") or None

{lightning_sdk-0.1.41.dist-info → lightning_sdk-0.1.42.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lightning_sdk
-Version: 0.1.41
+Version: 0.1.42
 Summary: SDK to develop using Lightning AI Studios
 Author-email: Lightning-AI <justus@lightning.ai>
 License: MIT License
@@ -45,6 +45,8 @@ Requires-Dist: tqdm
 Requires-Dist: fire
 Requires-Dist: simple-term-menu
 Requires-Dist: lightning-utilities
+Provides-Extra: serve
+Requires-Dist: litserve>=0.2.5; extra == "serve"
 
 # Lightning SDK