craft-ai-sdk 0.66.1rc1__tar.gz → 0.67.0__tar.gz

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: craft-ai-sdk
-Version: 0.66.1rc1
+Version: 0.67.0
 Summary: Craft AI MLOps platform SDK
 License: Apache-2.0
 Author: Craft AI

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/__init__.py

@@ -13,4 +13,4 @@ from .io import (  # noqa: F401
 )
 from .sdk import CraftAiSdk  # noqa: F401
 
-__version__ = "0.66.1rc1"
+__version__ = "0.67.0"

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/core/deployments.py

@@ -156,8 +156,9 @@ def create_deployment(
                   automatically adapt to the number of executions. During the lifetime
                   of a deployment, a pod may be re-created by the platform for
                   technical reasons (including if it tries to use more memory than
-                  available). This mode is not compatible with steps created with a
-                  ``container_config.dockerfile_path`` property in :func:`create_step`.
+                  available). This mode is not compatible with pipelines created with a
+                  ``container_config.dockerfile_path`` property in
+                  :func:`create_pipeline`.
 
         schedule (:obj:`str`, optional): Schedule of the deployment. Required and
             applicable only if ``execution_rule`` is ``"periodic"``. Must be a valid
@@ -184,19 +185,15 @@ def create_deployment(
             List of input mappings, to map pipeline inputs to different
             sources (such as constant values, endpoint inputs, or environment
             variables). See :class:`InputSource` for more details.
-            For endpoint rules, if an input of the step in the pipeline is not
-            explicitly mapped, it will be automatically mapped to an endpoint
-            input with the same name.
-            For periodic rules, all inputs of the step in the pipeline must be
-            explicitly mapped.
+            For endpoint rules, if an input of the pipeline is not explicitly mapped, it
+            will be automatically mapped to an endpoint input with the same name.
+            For periodic rules, all inputs of the pipeline must be explicitly mapped.
         outputs_mapping(:obj:`list` of instances of :class:`OutputDestination`):
             List of output mappings, to map pipeline outputs to different
             destinations. See :class:`OutputDestination` for more details.
-            For endpoint rules, if an output of the step in the pipeline is not
-            explicitly mapped, it will be automatically mapped to an endpoint
-            output with the same name.
-            For periodic rules, all outputs of the step in the pipeline must be
-            explicitly mapped.
+            For endpoint rules, if an output of the pipeline is not explicitly mapped,
+            it will be automatically mapped to an endpoint output with the same name.
+            For periodic rules, all outputs of the pipeline must be explicitly mapped.
         description (:obj:`str`, optional): Description of the deployment.
         enable_parallel_executions (:obj:`bool`, optional):
             .. _enable_parallel_executions:
@@ -263,44 +260,44 @@ def create_deployment(
         * ``"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
+          * ``"pipeline_input_name"`` (:obj:`str`): Name of the pipeline input.
+          * ``"data_type"`` (:obj:`str`): Data type of the pipeline input.
+          * ``"description"`` (:obj:`str`): Description of the pipeline input.
+          * ``"constant_value"`` (:obj:`str`): Constant value of the pipeline input.
+            Note that this key is only returned if the pipeline 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
+            variable. Note that this key is only returned if the pipeline 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
+            Note that this key is only returned if the pipeline 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
+          * ``"is_null"`` (:obj:`bool`): Whether the pipeline input is mapped to null.
+            Note that this key is only returned if the pipeline 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_path"`` (:obj:`str`): Datastore path of the pipeline input.
+            Note that this key is only returned if the pipeline 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
+          * ``"is_required"`` (:obj:`bool`): Whether the pipeline input is required.
+            Note that this key is only returned if the pipeline input is required.
+          * ``"default_value"`` (:obj:`str`): Default value of the pipeline input.
+            Note that this key is only returned if the pipeline 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.
+          * ``"pipeline_output_name"`` (:obj:`str`): Name of the pipeline output.
+          * ``"data_type"`` (:obj:`str`): Data type of the pipeline output.
+          * ``"description"`` (:obj:`str`): Description of the pipeline 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
+            Note that this key is only returned if the pipeline 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
+          * ``"is_null"`` (:obj:`bool`): Whether the pipeline output is mapped to null.
+            Note that this key is only returned if the pipeline 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
+          * ``"datastore_path"`` (:obj:`str`): Datastore path of the pipeline output.
+            Note that this key is only returned if the pipeline output is mapped to
             the datastore.
 
         * ``"endpoint_token"`` (:obj:`str`): Token of the endpoint. Note that this
@@ -523,44 +520,44 @@ def get_deployment(
         * ``"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
+          * ``"pipeline_input_name"`` (:obj:`str`): Name of the pipeline input.
+          * ``"data_type"`` (:obj:`str`): Data type of the pipeline input.
+          * ``"description"`` (:obj:`str`): Description of the pipeline input.
+          * ``"constant_value"`` (:obj:`str`): Constant value of the pipeline input.
+            Note that this key is only returned if the pipeline 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
+            variable. Note that this key is only returned if the pipeline 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
+            Note that this key is only returned if the pipeline 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
+          * ``"is_null"`` (:obj:`bool`): Whether the pipeline input is mapped to null.
+            Note that this key is only returned if the pipeline 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_path"`` (:obj:`str`): Datastore path of the pipeline input.
+            Note that this key is only returned if the pipeline 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
+          * ``"is_required"`` (:obj:`bool`): Whether the pipeline input is required.
+            Note that this key is only returned if the pipeline input is required.
+          * ``"default_value"`` (:obj:`str`): Default value of the pipeline input.
+            Note that this key is only returned if the pipeline 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.
+          * ``"pipeline_output_name"`` (:obj:`str`): Name of the pipeline output.
+          * ``"data_type"`` (:obj:`str`): Data type of the pipeline output.
+          * ``"description"`` (:obj:`str`): Description of the pipeline 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
+            Note that this key is only returned if the pipeline 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
+          * ``"is_null"`` (:obj:`bool`): Whether the pipeline output is mapped to null.
+            Note that this key is only returned if the pipeline 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
+          * ``"datastore_path"`` (:obj:`str`): Datastore path of the pipeline output.
+            Note that this key is only returned if the pipeline output is mapped to
             the datastore.
         * ``"endpoint_token"`` (:obj:`str`): Token of the deployment. Note that this
           key is only returned if the ``execution_rule`` of the deployment is

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/core/pipeline_executions.py

@@ -236,21 +236,21 @@ def get_pipeline_execution(sdk: BaseCraftAiSdk, execution_id):
           execution.
         * ``"deployment_name"`` (:obj:`str`): Name of the deployment used for the
           execution.
-        * ``"steps"`` (:obj:`list` of `obj`): List of the step executions
+        * ``"steps"`` (:obj:`list` of `obj`): List of the pipeline executions
           represented as :obj:`dict` with the following keys:
 
-          * ``"name"`` (:obj:`str`): Name of the step.
-          * ``"status"`` (:obj:`str`): Status of the step.
-          * ``"start_date"`` (:obj:`str`): Date of start of the step execution.
-          * ``"end_date"`` (:obj:`str`): Date of completion of the step execution.
+          * ``"name"`` (:obj:`str`): Name of the pipeline.
+          * ``"status"`` (:obj:`str`): Status of the pipeline.
+          * ``"start_date"`` (:obj:`str`): Date of start of the pipeline execution.
+          * ``"end_date"`` (:obj:`str`): Date of completion of the pipeline execution.
           * ``"commit_id"`` (:obj:`str`): Id of the commit used to build the
-            step.
+            pipeline.
           * ``"repository_url"`` (:obj:`str`): Url of the repository used to
-            build the step.
+            build the pipeline.
           * ``"repository_branch"`` (:obj:`str`): Branch of the repository used
-            to build the step.
+            to build the pipeline.
           * ``"requirements_path"`` (:obj:`str`): Path of the requirements.txt file.
-          * ``"origin"`` (:obj:`str`): The origin of the step, can be
+          * ``"origin"`` (:obj:`str`): The origin of the pipeline, can be
             ``"git_repository"`` or ``"local"``.
         * ``"inputs"`` (:obj:`list` of :obj:`dict`): List of inputs represented
           as a dict with the following keys:
@@ -460,12 +460,12 @@ def get_pipeline_execution_logs(
         sdk,
         "Please wait while logs are being fetched. This may take a while...",
     )
-    logs_by_steps = sdk._post(url, json=data)
+    logs_by_pipelines = sdk._post(url, json=data)
 
-    if len(logs_by_steps) == 0:
+    if len(logs_by_pipelines) == 0:
         return []
 
-    return logs_by_steps[0]
+    return logs_by_pipelines[0]
 
 
 def delete_pipeline_execution(sdk: BaseCraftAiSdk, execution_id):

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/core/pipeline_metrics.py

@@ -28,7 +28,7 @@ class ListMetric(TypedDict):
 @log_func_result("Pipeline metrics definition", get_execution_id)
 def record_metric_value(sdk: BaseCraftAiSdk, name: str, value: float):
     """Create or update a pipeline metric. Note that this function can only be used
-    inside a step code.
+    inside a pipeline code.
 
     Args:
         name (:obj:`str`): Name of the metric to store.
@@ -39,9 +39,9 @@ def record_metric_value(sdk: BaseCraftAiSdk, name: str, value: float):
     """
 
     if not get_execution_id():
-        if sdk.warn_on_metric_outside_of_step:
+        if sdk.warn_on_metric_outside_of_pipeline:
             warnings.warn(
-                "You cannot send a metric outside a step code, the metric has not \
+                "You cannot send a metric outside a pipeline code, the metric has not \
 been sent",
                 stacklevel=2,
             )
@@ -55,7 +55,7 @@ been sent",
 @log_func_result("Pipeline list metric definition", get_execution_id)
 def record_list_metric_values(sdk: BaseCraftAiSdk, name: str, values: list[float]):
     """Add values to a pipeline metric list. Note that this function can only be
-    used inside a step code.
+    used inside a pipeline code.
 
     Args:
         name (:obj:`str`):
@@ -68,9 +68,9 @@ def record_list_metric_values(sdk: BaseCraftAiSdk, name: str, values: list[float
     """
 
     if not get_execution_id():
-        if sdk.warn_on_metric_outside_of_step:
+        if sdk.warn_on_metric_outside_of_pipeline:
             warnings.warn(
-                "You cannot send a metric outside a step code, the metric has not \
+                "You cannot send a metric outside a pipeline code, the metric has not \
 been sent",
                 stacklevel=2,
             )

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/core/steps.py

@@ -8,6 +8,7 @@ import requests
 from typing_extensions import NotRequired
 
 from craft_ai_sdk.shared.types import Log
+from craft_ai_sdk.shared.warnings import deprecated
 
 from ..constants import CREATION_PARAMETER_VALUE
 from ..io import Input, Output
@@ -207,6 +208,7 @@ def _remove_id_from_step(step):
 
 
 @log_func_result("Steps creation")
+@deprecated
 def create_step(
     sdk: BaseCraftAiSdk,
     step_name: str,
@@ -379,6 +381,7 @@ def create_step(
     return get_step(sdk, step_name, wait_for_completion, timeout_s)
 
 
+@deprecated
 def get_step(
     sdk: BaseCraftAiSdk,
     step_name: str,
@@ -473,6 +476,7 @@ def get_step(
     return _remove_id_from_step(step)
 
 
+@deprecated
 def list_steps(sdk: BaseCraftAiSdk) -> list[StepListItem]:
     """Get the list of all steps.
 
@@ -490,6 +494,7 @@ def list_steps(sdk: BaseCraftAiSdk) -> list[StepListItem]:
 
 
 @log_func_result("Step deletion")
+@deprecated
 def delete_step(
     sdk: BaseCraftAiSdk, step_name: str, force_dependents_deletion=False
 ) -> StepDeleted:
@@ -522,6 +527,7 @@ def _get_download_presigned_url(sdk: BaseCraftAiSdk, step_name: str) -> str:
 
 
 @log_func_result("Step download")
+@deprecated
 def download_step_local_folder(sdk: BaseCraftAiSdk, step_name: str, folder: str):
     """Download a step's local folder as a `.tgz` archive.
 
@@ -550,6 +556,7 @@ def download_step_local_folder(sdk: BaseCraftAiSdk, step_name: str, folder: str)
 
 
 @log_func_result("Step logs")
+@deprecated
 def get_step_logs(
     sdk: BaseCraftAiSdk,
     step_name: str,

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/craft_ai_sdk/sdk.py

@@ -24,7 +24,7 @@ class BaseCraftAiSdk(ABC):
     _MULTIPART_PART_SIZE: int
     _version: str
     _session: requests.Session
-    warn_on_metric_outside_of_step: bool
+    warn_on_metric_outside_of_pipeline: bool
 
     @abstractmethod
     def _get(self, url: str, params=None, **kwargs) -> Any:
@@ -57,8 +57,8 @@ class CraftAiSdk(BaseCraftAiSdk):
         base_control_api_url (:obj:`str`): Base URL to CraftAI authorization server API.
         verbose_log (bool): If True, information during method execution will be
             printed.
-        warn_on_metric_outside_of_step (bool): If True, a warning will be printed when
-            a metric is added outside of a step.
+        warn_on_metric_outside_of_pipeline (bool): If True, a warning will be printed
+            when a metric is added outside of a pipeline.
     """
 
     from .core.data_store import (
@@ -139,7 +139,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.66.1rc1"  # Would be better to share it somewhere
+    _version = "0.67.0"  # Would be better to share it somewhere
 
     def __init__(
         self,
@@ -147,7 +147,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         environment_url=None,
         control_url=None,
         verbose_log=None,
-        warn_on_metric_outside_of_step=True,
+        warn_on_metric_outside_of_pipeline=True,
     ):
         """Inits CraftAiSdk.
 
@@ -166,8 +166,8 @@ class CraftAiSdk(BaseCraftAiSdk):
                 Defaults to ``True`` if the environment variable ``SDK_VERBOSE_LOG`` is
                 set to ``true``; ``False`` if it is set to ``false``; else, defaults to
                 ``True`` in interactive mode; ``False`` otherwise.
-            warn_on_metric_outside_of_step (:obj:`bool`, optional): If ``True``, a
-                warning will be raised when a metric is added outside of a step.
+            warn_on_metric_outside_of_pipeline (:obj:`bool`, optional): If ``True``, a
+                warning will be raised when a metric is added outside of a pipeline.
                 Defaults to ``True``.
 
         Raises:
@@ -222,8 +222,8 @@ class CraftAiSdk(BaseCraftAiSdk):
             )
         self.verbose_log = verbose_log
 
-        # Set warn_on_metric_outside_of_step
-        self.warn_on_metric_outside_of_step = warn_on_metric_outside_of_step
+        # Set warn_on_metric_outside_of_pipeline
+        self.warn_on_metric_outside_of_pipeline = warn_on_metric_outside_of_pipeline
 
     # _____ REQUESTS METHODS _____
 
@@ -305,13 +305,13 @@ class CraftAiSdk(BaseCraftAiSdk):
         }
 
     @property
-    def warn_on_metric_outside_of_step(self):
+    def warn_on_metric_outside_of_pipeline(self):
         """Whether a warning should be raised when a metric is added outside of a
-        step."""
-        return self._warn_on_metric_outside_of_step
+        pipeline."""
+        return self._warn_on_metric_outside_of_pipeline
 
-    @warn_on_metric_outside_of_step.setter
-    def warn_on_metric_outside_of_step(self, value):
+    @warn_on_metric_outside_of_pipeline.setter
+    def warn_on_metric_outside_of_pipeline(self, value):
         if not isinstance(value, bool):
-            raise TypeError("warn_on_metric_outside_of_step must be a boolean")
-        self._warn_on_metric_outside_of_step = value
+            raise TypeError("warn_on_metric_outside_of_pipeline must be a boolean")
+        self._warn_on_metric_outside_of_pipeline = value

{craft_ai_sdk-0.66.1rc1 → craft_ai_sdk-0.67.0}/pyproject.toml

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