craft-ai-sdk 0.51.0__tar.gz → 0.52.0__tar.gz

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/PKG-INFO

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

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/__init__.py

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

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/core/deployments.py

@@ -1,10 +1,7 @@
-import time
-
 from ..constants import (
     DEPLOYMENT_EXECUTION_RULES,
     DEPLOYMENT_MODES,
     DEPLOYMENT_STATUS,
-    CREATION_REQUESTS_RETRY_INTERVAL,
 )
 from ..io import InputSource, OutputDestination
 from ..sdk import BaseCraftAiSdk
@@ -156,14 +153,96 @@ def create_deployment(
         following keys:
 
         * ``"name"`` (:obj:`str`): Name of the deployment.
-        * ``"endpoint_token"`` (:obj:`str`): Token of the endpoint used to
-          trigger the deployment. Note that this token is only returned if
-          ``execution_rule`` is ``"endpoint"``.
-        * ``"schedule"`` (:obj:`str`): Schedule of the deployment. Note that
-          this schedule is only returned if ``execution_rule`` is ``"periodic"``.
-        * ``"human_readable_schedule"`` (:obj:`str`): Human readable schedule
-          of the deployment. Note that this schedule is only returned if
-          ``execution_rule`` is ``"periodic"``.
+        * ``"mode"`` (:obj:`str`): The deployment mode. Can be
+          ``"elastic"`` or ``"low_latency"``.
+        * ``"pipeline"`` (:obj:`dict`): Pipeline associated to the deployment
+          represented as :obj:`dict` with the following keys:
+
+          * ``"name"`` (:obj:`str`): Name of the pipeline.
+
+        * ``"inputs_mapping"`` (:obj:`list` of :obj:`dict`): List of inputs
+          mapping represented as :obj:`dict` with the following keys:
+
+          * ``"pipeline_input_name"`` (:obj:`str`): Name of the step input.
+          * ``"data_type"`` (:obj:`str`): Data type of the step input.
+          * ``"description"`` (:obj:`str`): Description of the step input.
+          * ``"constant_value"`` (:obj:`str`): Constant value of the step input.
+            Note that this key is only returned if the step input is mapped to a
+            constant value.
+          * ``"environment_variable_name"`` (:obj:`str`): Name of the environment
+            variable. Note that this key is only returned if the step input is
+            mapped to an environment variable.
+          * ``"endpoint_input_name"`` (:obj:`str`): Name of the endpoint input.
+            Note that this key is only returned if the step input is mapped to an
+            endpoint input.
+          * ``"is_null"`` (:obj:`bool`): Whether the step input is mapped to null.
+            Note that this key is only returned if the step input is mapped to
+            null.
+          * ``"datastore_path"`` (:obj:`str`): Datastore path of the step input.
+            Note that this key is only returned if the step input is mapped to the
+            datastore.
+          * ``"is_required"`` (:obj:`bool`): Whether the step input is required.
+            Note that this key is only returned if the step input is required.
+          * ``"default_value"`` (:obj:`str`): Default value of the step input.
+            Note that this key is only returned if the step input has a default
+            value.
+
+        * ``"outputs_mapping"`` (:obj:`list` of :obj:`dict`): List of outputs
+          mapping represented as :obj:`dict` with the following keys:
+
+          * ``"pipeline_output_name"`` (:obj:`str`): Name of the step output.
+          * ``"data_type"`` (:obj:`str`): Data type of the step output.
+          * ``"description"`` (:obj:`str`): Description of the step output.
+          * ``"endpoint_output_name"`` (:obj:`str`): Name of the endpoint output.
+            Note that this key is only returned if the step output is mapped to an
+            endpoint output.
+          * ``"is_null"`` (:obj:`bool`): Whether the step output is mapped to null.
+            Note that this key is only returned if the step output is mapped to
+            null.
+          * ``"datastore_path"`` (:obj:`str`): Datastore path of the step output.
+            Note that this key is only returned if the step output is mapped to
+            the datastore.
+
+        * ``"endpoint_token"`` (:obj:`str`): Token of the endpoint. Note that this
+          key is only returned if the deployment is an endpoint.
+        * ``"schedule"`` (:obj:`str`): Schedule of the deployment. Note that this key is
+          only returned if the ``execution_rule``of the deployment is ``"periodic"``.
+        * ``"human_readable_schedule"`` (:obj:`str`): Human readable schedule of the
+          deployment. Note that this key is only returned if the ``execution_rule`` of
+          the deployment is ``"periodic"``.
+        * ``"created_at"`` (:obj:`str`): Date of creation of the deployment.
+        * ``"created_by"`` (:obj:`str`): ID of the user who created the deployment.
+        * ``"updated_at"`` (:obj:`str`): Date of last update of the deployment.
+        * ``"updated_by"`` (:obj:`str`): ID of the user who last updated the
+          deployment.
+        * ``"last_execution_id"`` (:obj:`str`): ID of the last execution of the
+          deployment.
+        * ``"is_enabled"`` (:obj:`bool`): Whether the deployment is enabled.
+        * ``"description"`` (:obj:`str`): Description of the deployment.
+        * ``"execution_rule"`` (:obj:`str`): Execution rule of the deployment.
+        * ``"status"`` (:obj:`str`): The deployment status. Can be
+          ``"creation_pending"``, ``"up"``, ``"creation_failed"``, ``"down_retrying"``
+          or ``"standby"``.
+        * ``"enable_parallel_executions"`` (:obj:`bool`):
+          Indicates whether multiple executions can run concurrently within the same
+          pod. This key is only returned if the deployment mode is ``"low_latency"``.
+          For more detailed information, see
+          :ref:`enable_parallel_executions <enable_parallel_executions>` parameter
+          of :func:`create_deployment` method.
+        * ``"max_parallel_executions_per_pod"`` (:obj:`int`): Maximum number of
+          executions that can run at the same time on a deployment's pod in
+          ``"low_latency"`` mode. This key is only returned if the deployment mode is
+          ``"low_latency"`` and if ``"enable_parallel_executions"`` is ``True``. For
+          more detailed information, see
+          :ref:`max_parallel_executions_per_pod <max_parallel_executions_per_pod>`
+          parameter of :func:`create_deployment` method.
+        * ``"pods"`` (:obj:`list` of :obj:`dict`): List of pods associated with the
+          low latency deployment. Note that this key is only returned if the
+          deployment is in low latency mode. Each pod is represented as :obj:`dict`
+          with the following keys:
+
+          * ``pod_id`` (:obj:`str`): ID of the pod.
+          * ``status`` (:obj:`str`): Status of the pod.
 
     Note:
       When ``execution_rule`` is ``"endpoint"``:
@@ -305,10 +384,7 @@ def create_deployment(
     )
 
     start_time = sdk._get_time()
-    created_deployment, response = sdk._post(url, json=data, get_response=True)
-
-    if response.status_code != 206:
-        return created_deployment
+    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
@@ -322,8 +398,9 @@ def create_deployment(
         ]
         and elapsed_time < timeout_s
     ):
-        time.sleep(CREATION_REQUESTS_RETRY_INTERVAL)
-        created_deployment = get_deployment(sdk, deployment_name)
+        created_deployment = get_deployment(
+            sdk, deployment_name, wait_for_completion=True
+        )
 
         if created_deployment is None:
             raise SdkException(
@@ -345,7 +422,7 @@ this function stopped trying. Please check its status with "get_deployment".',
     return created_deployment
 
 
-def get_deployment(sdk: BaseCraftAiSdk, deployment_name):
+def get_deployment(sdk: BaseCraftAiSdk, deployment_name, **kwargs):
     """Get information of a deployment.
 
     Args:
@@ -447,9 +524,10 @@ def get_deployment(sdk: BaseCraftAiSdk, deployment_name):
           * ``pod_id`` (:obj:`str`): ID of the pod.
           * ``status`` (:obj:`str`): Status of the pod.
     """
-
-    url = f"{sdk.base_environment_api_url}/deployments/{deployment_name}"
-    deployment = sdk._get(url)
+    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 deployment is not None:
         latest_execution = sdk._get(
             f"\

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/core/endpoints.py

@@ -8,7 +8,11 @@ from ..sdk import BaseCraftAiSdk
 
 @log_func_result("Endpoint trigger")
 def trigger_endpoint(
-    sdk: BaseCraftAiSdk, endpoint_name, endpoint_token, inputs={}, wait_for_results=True
+    sdk: BaseCraftAiSdk,
+    endpoint_name,
+    endpoint_token,
+    inputs={},
+    wait_for_completion=True,
 ):
     """Trigger an endpoint.
 
@@ -21,7 +25,7 @@ def trigger_endpoint(
             For json, string, number, boolean and array inputs, the size of all values
             should be less than 0.06MB.
             Defaults to {}.
-        wait_for_results (:obj:`bool`, optional): Automatically call
+        wait_for_completion (:obj:`bool`, optional): Automatically call
             `retrieve_endpoint_results` and returns the execution result.
             Defaults to `True`.
 
@@ -32,7 +36,7 @@ def trigger_endpoint(
         * ``"execution_id"`` (:obj:`str`): ID of the execution.
         * ``"outputs"`` (:obj:`dict`): Dictionary of outputs of the pipeline with
           output names as keys and corresponding values as values. Note that this
-          key is only returned if ``wait_for_results`` is `True`.
+          key is only returned if ``wait_for_completion`` is `True`.
     """
 
     body = {}
@@ -56,7 +60,7 @@ def trigger_endpoint(
     )
     handle_http_response(post_result)
     execution_id = post_result.headers.get("Craft-Ai-Execution-Id", "")
-    if wait_for_results and 200 <= post_result.status_code < 400:
+    if wait_for_completion and 200 <= post_result.status_code < 400:
         return retrieve_endpoint_results(
             sdk, endpoint_name, execution_id, endpoint_token
         )

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/core/pipeline_executions.py

@@ -1,6 +1,7 @@
 import json
 import io
 
+
 from ..exceptions import SdkException
 from ..io import (
     INPUT_OUTPUT_TYPES,
@@ -26,6 +27,7 @@ def run_pipeline(
     inputs=None,
     inputs_mapping=None,
     outputs_mapping=None,
+    wait_for_completion=True,
 ):
     """Run a pipeline.
 
@@ -46,6 +48,9 @@ def run_pipeline(
             List of output mappings, to map pipeline outputs to different
             destinations (is_null or datastore_path). See
             :class:`OutputDestination` for more details.
+        wait_for_completion (:obj:`bool`, optional): Wait for the end of the execution
+            and returns the execution result.
+            Defaults to `True`.
 
     Returns:
         :obj:`dict`: Pipeline execution outputs represented as a :obj:`dict` with
@@ -53,7 +58,8 @@ def run_pipeline(
 
         *   ``"execution_id"`` (:obj:`str`): Name of the pipeline execution.
         *   ``"outputs"`` (:obj:`dict`): Pipeline execution outputs with output
-            names as keys and corresponding values as values.
+            names as keys and corresponding values as values. Note that this
+            key is only returned if ``wait_for_completion`` is `True`.
     """
     if inputs is None:
         inputs = {}
@@ -110,25 +116,28 @@ OutputDestination."
     # Execute pipeline
     url = f"{sdk.base_environment_api_url}/pipelines/{pipeline_name}/run"
     post_result = sdk._post(url, data=data, files=files, allow_redirects=False)
+    execution_id = post_result["execution_id"]
+
     for file in files.values():
         file.close()
     log_action(
         sdk,
-        f"The pipeline execution may take a while, \
+        f'The pipeline execution may take a while, \
 you can check its status and get information on the Executions page of the front-end.\n\
-Its execution ID is \"{post_result['execution_id']}\".",
+Its execution ID is "{execution_id}".',
     )
 
     # Wait for pipeline execution to finish
-    execution_id = post_result["execution_id"]
-    return _retrieve_pipeline_execution_outputs(sdk, execution_id)
+    if wait_for_completion:
+        return _retrieve_pipeline_execution_outputs(sdk, execution_id)
+    return {"execution_id": execution_id}
 
 
 @log_func_result("Pipeline execution results retrieval")
 def _retrieve_pipeline_execution_outputs(sdk: BaseCraftAiSdk, execution_id):
     url = (
         f"{sdk.base_environment_api_url}"
-        f"/executions/{execution_id}/outputs?wait_for_results=true"
+        f"/executions/{execution_id}/outputs?wait_for_completion=true"
     )
 
     do_get = use_authentication(

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/core/pipelines.py

@@ -197,12 +197,19 @@ def create_pipeline(
         return _create_pipeline_with_step(sdk, pipeline_name, function_path)
 
     # or with create_pipeline(:pipeline_name:, step_name=:step_name:).
-    if args_are_none and function_path is None and kwargs.keys() == {"step_name"}:
+    if "step_name" in kwargs:
+        if not args_are_none or function_path is not None or len(kwargs) > 1:
+            raise ValueError(
+                "create_pipeline() got unexpected arguments. When specifying the"
+                "'step_name' keyword argument, no other argument than 'pipeline_name'"
+                "should be provided."
+            )
+
         return _create_pipeline_with_step(sdk, pipeline_name, kwargs["step_name"])
 
     if len(kwargs) != 0:
         raise ValueError(
-            f"create_pipeline() got an unexpected keyword argument {kwargs.keys()[0]}"
+            f"create_pipeline() got unexpected keyword arguments: {kwargs}"
         )
 
     # Otherwise, the pipeline is created with a "hidden" step
@@ -244,7 +251,7 @@ def create_pipeline(
 
     # The pipeline is still building. Keep checking its status until it is ready
     return _wait_create_until_ready(
-        sdk, pipeline_name, get_pipeline, timeout_s, start_time
+        sdk, pipeline_name, get_pipeline, timeout_s, start_time, get_pipeline_logs
     )
 
 

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/craft_ai_sdk/core/steps.py

@@ -120,10 +120,10 @@ def _remove_id_from_step(step):
     return step
 
 
-def _wait_create_until_ready(sdk, name, get_func, timeout_s, start_time):
+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 != "ready" and elapsed_time < timeout_s:
+    while status == "creation_pending" and elapsed_time < timeout_s:
         time.sleep(CREATION_REQUESTS_RETRY_INTERVAL)
         created_obj = get_func(sdk, name)
         if created_obj is None:
@@ -136,6 +136,12 @@ def _wait_create_until_ready(sdk, name, get_func, timeout_s, start_time):
         status = created_obj.get("creation_info", {}).get("status", None)
         elapsed_time = sdk._get_time() - start_time
 
+    if status == "creation_failed":
+        raise SdkException(
+            f'The creation of "{name}" has failed. You can check the logs with '
+            f'the "{get_log_func.__name__}" function.',
+            name="CreationFailed",
+        )
     if status != "ready":
         raise SdkException(
             f'The creation of "{name}" was not ready in time. It is still being '
@@ -324,7 +330,7 @@ def create_step(
 
     # 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
+        sdk, step_name, get_step, timeout_s, start_time, get_step_logs
     )
     return _remove_id_from_step(created_step)
 

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.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.51.0"  # Would be better to share it somewhere
+    _version = "0.52.0"  # Would be better to share it somewhere
 
     def __init__(
         self,

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/pyproject.toml

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

{craft_ai_sdk-0.51.0 → craft_ai_sdk-0.52.0}/setup.py

@@ -24,7 +24,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'craft-ai-sdk',
-    'version': '0.51.0',
+    'version': '0.52.0',
     'description': 'Craft AI MLOps platform SDK',
     'long_description': '# Craft AI Python SDK\n\nThis Python SDK lets you interact with Craft AI MLOps Platform.\n\n## Installation\nThis project relies on **Python 3.8+**. Once a supported version of Python is installed, you can install `craft-ai-sdk` from PyPI with:\n\n```console\npip install craft-ai-sdk\n```\n\n## Basic usage\nYou can configure the SDK by instantiating the `CraftAiSdk` class in this way:\n\n```python\nfrom craft_ai_sdk import CraftAiSdk\n\nCRAFT_AI_SDK_TOKEN =  # your access key obtained from your settings page\nCRAFT_AI_ENVIRONMENT_URL =  # url to your environment\n\nsdk = CraftAiSdk(sdk_token=CRAFT_AI_SDK_TOKEN, environment_url=CRAFT_AI_ENVIRONMENT_URL)\n```\n\nIf using the SDK in interactive mode, some additional feedbacks will be printed. You can force disable or enable those logs by either\n* Setting the `verbose_log` SDK parameter\n* Or setting the `SDK_VERBOSE_LOG` env var\n',
     'author': 'Craft AI',