craft-ai-sdk 0.52.1__tar.gz → 0.53.0__tar.gz

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-ai-sdk
-Version: 0.52.1
+Version: 0.53.0
 Summary: Craft AI MLOps platform SDK
 Home-page: https://www.craft.ai/
 License: Apache-2.0

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/craft_ai_sdk/__init__.py

@@ -14,4 +14,4 @@ from .io import (  # noqa: F401
 )
 
 
-__version__ = "0.52.1"
+__version__ = "0.53.0"

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/craft_ai_sdk/core/deployments.py

@@ -29,7 +29,8 @@ def create_deployment(
     max_parallel_executions_per_pod=None,
     ram_request=None,
     gpu_request=None,
-    timeout_s=3 * 60,
+    wait_for_completion=True,
+    timeout_s=None,
 ):
     """Create a deployment associated with a given pipeline.
 
@@ -145,8 +146,11 @@ def create_deployment(
             for "low_latency" deployments mode.
         gpu_request (:obj:`int`, optional): The number of GPUs requested for the
             deployment. This is only available for "low_latency" deployments mode.
+        wait_for_completion (:obj:`bool`, optional): Whether to wait for the deployment
+            to be ready. Defaults to ``True``.
         timeout_s (:obj:`int`): Maximum time (in seconds) to wait for the deployment to
-            be ready. 3min (180s) by default, and at least 2min (120s).
+            be ready. Set to None to wait indefinitely. Defaults to None.
+            Only applicable if ``wait_for_completion`` is ``True``.
 
     Returns:
         :obj:`dict[str, str]`: Created deployment represented as a dict with the
@@ -312,6 +316,9 @@ def create_deployment(
 
     """
 
+    if timeout_s is not None and timeout_s <= 0:
+        raise ValueError("'timeout_s' must be greater than 0 or None.")
+
     if mode not in set(DEPLOYMENT_MODES):
         raise ValueError("Invalid 'mode', must be in ['elastic', 'low_latency'].")
 
@@ -320,9 +327,6 @@ def create_deployment(
             "Invalid 'execution_rule', must be in ['endpoint', 'periodic']."
         )
 
-    if timeout_s < 120:
-        raise ValueError("The timeout must be at least 2 minutes (120 seconds).")
-
     url = (
         f"{sdk.base_environment_api_url}/endpoints"
         if execution_rule == "endpoint"
@@ -383,50 +387,28 @@ def create_deployment(
         "Please wait while deployment is being created. This may take a while...",
     )
 
-    start_time = sdk._get_time()
     sdk._post(url, json=data, get_response=True, allow_redirects=False)
 
-    # The deployment is not ready. Keep checking its status until it is ready
-    elapsed_time = sdk._get_time() - start_time
-    deployment_status = DEPLOYMENT_STATUS.CREATION_PENDING
-
-    while (
-        deployment_status
-        not in [
-            DEPLOYMENT_STATUS.UP,
-            DEPLOYMENT_STATUS.CREATION_FAILED,
-        ]
-        and elapsed_time < timeout_s
-    ):
-        created_deployment = get_deployment(
-            sdk, deployment_name, wait_for_completion=True
-        )
-
-        if created_deployment is None:
-            raise SdkException(
-                f'The creation of deployment "{deployment_name}" has failed. '
-                "Please try creating the step again. If this error keeps happening, "
-                "please contact the support team.",
-                name="UnexpectedError",
-            )
-
-        deployment_status = created_deployment.get("status", None)
-        elapsed_time = sdk._get_time() - start_time
-
-    if deployment_status != DEPLOYMENT_STATUS.UP:
-        raise SdkException(
-            'The deployment was not ready in time. It is still being created but \
-this function stopped trying. Please check its status with "get_deployment".',
-            name="TimeoutException",
-        )
-    return created_deployment
+    return get_deployment(
+        sdk,
+        deployment_name,
+        wait_for_completion=wait_for_completion,
+        timeout_s=timeout_s,
+    )
 
 
-def get_deployment(sdk: BaseCraftAiSdk, deployment_name, **kwargs):
+def get_deployment(
+    sdk: BaseCraftAiSdk, deployment_name, wait_for_completion=False, timeout_s=None
+):
     """Get information of a deployment.
 
     Args:
         deployment_name (:obj:`str`): Name of the deployment.
+        wait_for_completion (:obj:`bool`, optional): Whether to wait for the deployment
+            to be ready. Defaults to ``False``.
+        timeout_s (:obj:`int`, optional): Maximum time (in seconds) to wait for the
+            deployment to be ready. Set to None to wait indefinitely. Defaults to None.
+            Only applicable if ``wait_for_completion`` is ``True``.
 
     Returns:
         :obj:`dict`: Deployment information represented as :obj:`dict` with the
@@ -524,10 +506,41 @@ def get_deployment(sdk: BaseCraftAiSdk, deployment_name, **kwargs):
           * ``pod_id`` (:obj:`str`): ID of the pod.
           * ``status`` (:obj:`str`): Status of the pod.
     """
-    wait_for_completion = kwargs.get("wait_for_completion", False)
-    url = f"{sdk.base_environment_api_url}/deployments/{deployment_name}\
-{'' if not wait_for_completion else '?wait_for_completion=true'}"
-    deployment = sdk._get(url, allow_redirects=False)
+
+    if timeout_s is not None and timeout_s <= 0:
+        raise ValueError("'timeout_s' must be greater than 0 or None.")
+
+    deployment = None
+
+    base_url = f"{sdk.base_environment_api_url}/deployments/{deployment_name}"
+
+    if wait_for_completion:
+        start_time = sdk._get_time()
+        elapsed_time = 0
+        deployment_status = DEPLOYMENT_STATUS.CREATION_PENDING
+        while deployment_status not in [
+            DEPLOYMENT_STATUS.UP,
+            DEPLOYMENT_STATUS.CREATION_FAILED,
+        ] and (timeout_s is None or elapsed_time < timeout_s):
+            deployment = sdk._get(
+                f"{base_url}?wait_for_completion=true", allow_redirects=False
+            )
+
+            deployment_status = deployment.get("status", None)
+            elapsed_time = sdk._get_time() - start_time
+
+        if deployment_status not in [
+            DEPLOYMENT_STATUS.UP,
+            DEPLOYMENT_STATUS.CREATION_FAILED,
+        ]:
+            raise SdkException(
+                'The deployment was not ready in time. It is still being created but \
+this function stopped trying. Please check its status with "get_deployment" with \
+wait_for_completion parameter set to false.',
+                name="TimeoutException",
+            )
+    else:
+        deployment = sdk._get(base_url)
     if deployment is not None:
         latest_execution = sdk._get(
             f"\

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/craft_ai_sdk/core/steps.py

@@ -31,8 +31,8 @@ def _compress_folder_to_memory(local_folder, include):
 
 
 def _validate_create_step_parameters(inputs, outputs, timeout_s):
-    if timeout_s < 120:
-        raise ValueError("The timeout must be at least 2 minutes (120 seconds).")
+    if timeout_s is not None and timeout_s <= 0:
+        raise ValueError("The timeout must be greater than 0 or None.")
 
     if inputs is not None:
         if any([not isinstance(input_, Input) for input_ in inputs]):
@@ -123,7 +123,9 @@ def _remove_id_from_step(step):
 def _wait_create_until_ready(sdk, name, get_func, timeout_s, start_time, get_log_func):
     elapsed_time = sdk._get_time() - start_time
     status = "creation_pending"
-    while status == "creation_pending" and elapsed_time < timeout_s:
+    while status == "creation_pending" and (
+        timeout_s is None or elapsed_time < timeout_s
+    ):
         time.sleep(CREATION_REQUESTS_RETRY_INTERVAL)
         created_obj = get_func(sdk, name)
         if created_obj is None:
@@ -162,7 +164,8 @@ def create_step(
     container_config=None,
     inputs=None,
     outputs=None,
-    timeout_s=3 * 60,
+    wait_for_completion=True,
+    timeout_s=None,
 ):
     """Create pipeline step from a function located on a remote repository or locally.
 
@@ -232,8 +235,11 @@ def create_step(
             :obj:`dict` with the name of the output as keys and the value of the
             output as values. Each output should be specified as an instance
             of :class:`Output` via this parameter `outputs`.
+        wait_for_completion (:obj:`bool`, optional): Whether to wait for the step
+            to be created. Defaults to ``True``.
         timeout_s (:obj:`int`): Maximum time (in seconds) to wait for the step to
-            be created. 3min (180s) by default, and at least 2min (120s).
+            be created. Set to None to wait indefinitely. Defaults to None.
+            Only applicable if ``wait_for_completion`` is ``True``.
 
     Returns:
         :obj:`dict`: Created step represented as a :obj:`dict` with the following
@@ -313,33 +319,21 @@ def create_step(
         "Please wait while step is being created. This may take a while...",
     )
 
-    start_time = sdk._get_time()
-    created_step, response = sdk._post(
-        url, data=multipartify(data), files=files, get_response=True
-    )
+    sdk._post(url, data=multipartify(data), files=files, allow_redirects=False)
 
-    if response.status_code != 206:
-        parameters = created_step.get("parameters", {})
-        message = _add_inputs_outputs_in_message(
-            f'Step "{step_name}" created',
-            parameters.get("inputs", []),
-            parameters.get("outputs", []),
-        )
-        log_action(sdk, message)
-        return _remove_id_from_step(created_step)
+    return get_step(sdk, step_name, wait_for_completion, timeout_s)
 
-    # The step is still building. Keep checking its status until it is ready
-    created_step = _wait_create_until_ready(
-        sdk, step_name, get_step, timeout_s, start_time, get_step_logs
-    )
-    return _remove_id_from_step(created_step)
 
-
-def get_step(sdk: BaseCraftAiSdk, step_name):
+def get_step(sdk: BaseCraftAiSdk, step_name, wait_for_completion=False, timeout_s=None):
     """Get a single step if it exists.
 
     Args:
         step_name (:obj:`str`): The name of the step to get.
+        wait_for_completion (:obj:`bool`, optional): Whether to wait for the step
+            to be created. Defaults to ``False``.
+        timeout_s (:obj:`int`): Maximum time (in seconds) to wait for the step to
+            be created. Set to None to wait indefinitely. Defaults to None.
+            Only applicable if ``wait_for_completion`` is ``True``.
 
     Returns:
         :obj:`dict`: ``None`` if the step does not exist; otherwise
@@ -397,19 +391,26 @@ def get_step(sdk: BaseCraftAiSdk, step_name):
           * ``"origin"`` (:obj:`str`): The origin of the step, can be
             ``"git_repository"`` or ``"local"``.
     """
-    url = f"{sdk.base_environment_api_url}/steps/{step_name}"
-    try:
-        step = sdk._get(url)
-    except SdkException as error:
-        if error.status_code == 404:
-            log_action(
-                sdk,
-                "If you are waiting for the step to be created, its creation "
-                "has failed. Please try creating the step again. "
-                "If this error keeps happening, please contact the support team.",
-            )
-            return None
-        raise error
+    if timeout_s is not None and timeout_s <= 0:
+        raise ValueError("The timeout must be greater than to 0 or None.")
+
+    step = None
+
+    base_url = f"{sdk.base_environment_api_url}/steps/{step_name}"
+
+    if wait_for_completion:
+        step = _wait_create_until_ready(
+            sdk,
+            step_name,
+            lambda sdk, _: sdk._get(
+                f"{base_url}?wait_for_completion=true", allow_redirects=False
+            ),
+            timeout_s,
+            sdk._get_time(),
+            get_step_logs,
+        )
+    else:
+        step = sdk._get(base_url)
     return _remove_id_from_step(step)
 
 

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/craft_ai_sdk/sdk.py

@@ -130,7 +130,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         os.environ.get("CRAFT_AI__MULTIPART_PART_SIZE__B", str(38 * 256 * 1024))
     )
     _access_token_margin = timedelta(seconds=30)
-    _version = "0.52.1"  # Would be better to share it somewhere
+    _version = "0.53.0"  # Would be better to share it somewhere
 
     def __init__(
         self,

{craft_ai_sdk-0.52.1 → craft_ai_sdk-0.53.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "craft-ai-sdk"
-version = "0.52.1"
+version = "0.53.0"
 description = "Craft AI MLOps platform SDK"
 license = "Apache-2.0"
 authors = ["Craft AI <contact@craft.ai>"]