Endpoint artifacts rename to deployment artifacts (#2134)

* `endpoint_artifact`>`deployment_artifact`

* migration

* migration

* updated template

* Auto-update of E2E template

* update test definition

* branching

* Auto-update of E2E template

* Auto-update of NLP template

* Apply suggestions from code review

Co-authored-by: Stefan Nica <[email protected]>

---------

Co-authored-by: GitHub Actions <[email protected]>
Co-authored-by: Stefan Nica <[email protected]>

Author: 3 people

.github/workflows/update-templates-to-examples.yml

@@ -57,8 +57,8 @@ jobs:
           python-version: ${{ inputs.python-version }}
           stack-name: local
           ref-zenml: ${{ github.ref }}
-          ref-template: '2023.12.06' # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
-
+          ref-template: '2023.12.12' # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
+          
       - name: Clean-up
         run: |
           rm -rf ./local_checkout

docs/book/user-guide/advanced-guide/artifact-management/artifact-versioning.md

@@ -139,7 +139,7 @@ how artifacts are linked to models:
 - `model_name`: The name of the model to link the artifact to.
 - `model_version`: The version of the model to link the artifact to.
 - `is_model_artifact`: Whether the artifact is a model artifact.
-- `is_endpoint_artifact`: Whether the artifact is an endpoint artifact.
+- `is_deployment_artifact`: Whether the artifact is a deployment artifact.
 
 <!-- For scarf -->
 <figure><img alt="ZenML Scarf" referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" /></figure>

examples/e2e/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2023.12.06
+_commit: 2023.12.06-4-g1e3edc6
 _src_path: gh:zenml-io/template-e2e-batch
 data_quality_checks: true
 email: ''

examples/e2e/steps/deployment/deployment_deploy.py

@@ -37,7 +37,7 @@
 def deployment_deploy() -> (
     Annotated[
         Optional[MLFlowDeploymentService],
-        ArtifactConfig(name="mlflow_deployment", is_endpoint_artifact=True),
+        ArtifactConfig(name="mlflow_deployment", is_deployment_artifact=True),
     ]
 ):
     """Predictions step.

src/zenml/artifacts/artifact_config.py

@@ -57,7 +57,7 @@ def my_step() -> Annotated[
             (42), stage (ModelStages.PRODUCTION or "production"), or
             (ModelStages.LATEST or None) for the latest version (default).
         is_model_artifact: Whether the artifact is a model artifact.
-        is_endpoint_artifact: Whether the artifact is an endpoint artifact.
+        is_deployment_artifact: Whether the artifact is a deployment artifact.
     """
 
     name: Optional[str] = None
@@ -67,7 +67,7 @@ def my_step() -> Annotated[
     model_name: Optional[str] = None
     model_version: Optional[Union[ModelStages, str, int]] = None
     is_model_artifact: bool = False
-    is_endpoint_artifact: bool = False
+    is_deployment_artifact: bool = False
 
     @root_validator
     def _root_validator(cls, values: Dict[str, Any]) -> Dict[str, Any]:

src/zenml/cli/base.py

@@ -73,7 +73,7 @@ def copier_github_url(self) -> str:
 ZENML_PROJECT_TEMPLATES = dict(
     e2e_batch=ZenMLProjectTemplateLocation(
         github_url="zenml-io/template-e2e-batch",
-        github_tag="2023.12.06",  # Make sure it is aligned with .github/workflows/update-templates-to-examples.yml
+        github_tag="2023.12.12",  # Make sure it is aligned with .github/workflows/update-templates-to-examples.yml
     ),
     starter=ZenMLProjectTemplateLocation(
         github_url="zenml-io/template-starter",

src/zenml/cli/model.py

@@ -64,7 +64,9 @@ def _model_version_to_print(
         "tags": [t.name for t in model_version.tags],
         "data_artifacts_count": len(model_version.data_artifact_ids),
         "model_artifacts_count": len(model_version.model_artifact_ids),
-        "endpoint_artifacts_count": len(model_version.endpoint_artifact_ids),
+        "deployment_artifacts_count": len(
+            model_version.deployment_artifact_ids
+        ),
         "pipeline_runs_count": len(model_version.pipeline_run_ids),
         "updated": model_version.updated.date(),
     }
@@ -519,7 +521,7 @@ def _print_artifacts_links_generic(
     model_name_or_id: str,
     model_version_name_or_number_or_id: Optional[str] = None,
     only_data_artifacts: bool = False,
-    only_endpoint_artifacts: bool = False,
+    only_deployment_artifacts: bool = False,
     only_model_artifacts: bool = False,
     **kwargs: Any,
 ) -> None:
@@ -529,7 +531,7 @@ def _print_artifacts_links_generic(
         model_name_or_id: The ID or name of the model containing version.
         model_version_name_or_number_or_id: The name, number or ID of the model version.
         only_data_artifacts: If set, only print data artifacts.
-        only_endpoint_artifacts: If set, only print endpoint artifacts.
+        only_deployment_artifacts: If set, only print deployment artifacts.
         only_model_artifacts: If set, only print model artifacts.
         **kwargs: Keyword arguments to filter models.
     """
@@ -540,15 +542,16 @@ def _print_artifacts_links_generic(
     type_ = (
         "data artifacts"
         if only_data_artifacts
-        else "endpoint artifacts"
-        if only_endpoint_artifacts
+        else "deployment artifacts"
+        if only_deployment_artifacts
         else "model artifacts"
     )
 
     if (
         (only_data_artifacts and not model_version.data_artifact_ids)
         or (
-            only_endpoint_artifacts and not model_version.endpoint_artifact_ids
+            only_deployment_artifacts
+            and not model_version.deployment_artifact_ids
         )
         or (only_model_artifacts and not model_version.model_artifact_ids)
     ):
@@ -562,7 +565,7 @@ def _print_artifacts_links_generic(
     links = Client().list_model_version_artifact_links(
         model_version_id=model_version.id,
         only_data_artifacts=only_data_artifacts,
-        only_endpoint_artifacts=only_endpoint_artifacts,
+        only_deployment_artifacts=only_deployment_artifacts,
         only_model_artifacts=only_model_artifacts,
         **kwargs,
     )
@@ -630,18 +633,18 @@ def list_model_version_model_artifacts(
 
 
 @model.command(
-    "endpoint_artifacts",
-    help="List endpoint artifacts linked to a model version.",
+    "deployment_artifacts",
+    help="List deployment artifacts linked to a model version.",
 )
 @click.argument("model_name")
 @click.option("--model_version", "-v", default=None)
 @cli_utils.list_options(ModelVersionArtifactFilter)
-def list_model_version_endpoint_artifacts(
+def list_model_version_deployment_artifacts(
     model_name: str,
     model_version: Optional[str] = None,
     **kwargs: Any,
 ) -> None:
-    """List endpoint artifacts linked to a model version in the Model Control Plane.
+    """List deployment artifacts linked to a model version in the Model Control Plane.
 
     Args:
         model_name: The ID or name of the model containing version.
@@ -652,7 +655,7 @@ def list_model_version_endpoint_artifacts(
     _print_artifacts_links_generic(
         model_name_or_id=model_name,
         model_version_name_or_number_or_id=model_version,
-        only_endpoint_artifacts=True,
+        only_deployment_artifacts=True,
         **kwargs,
     )
 

src/zenml/client.py

@@ -4816,7 +4816,7 @@ def list_model_version_artifact_links(
         artifact_name: Optional[str] = None,
         only_data_artifacts: Optional[bool] = None,
         only_model_artifacts: Optional[bool] = None,
-        only_endpoint_artifacts: Optional[bool] = None,
+        only_deployment_artifacts: Optional[bool] = None,
     ) -> Page[ModelVersionArtifactResponse]:
         """Get model version to artifact links by filter in Model Control Plane.
 
@@ -4835,7 +4835,7 @@ def list_model_version_artifact_links(
             artifact_name: Use the artifact name for filtering
             only_data_artifacts: Use to filter by data artifacts
             only_model_artifacts: Use to filter by model artifacts
-            only_endpoint_artifacts: Use to filter by endpoint artifacts
+            only_deployment_artifacts: Use to filter by deployment artifacts
 
         Returns:
             A page of all model version to artifact links.
@@ -4856,7 +4856,7 @@ def list_model_version_artifact_links(
                 artifact_name=artifact_name,
                 only_data_artifacts=only_data_artifacts,
                 only_model_artifacts=only_model_artifacts,
-                only_endpoint_artifacts=only_endpoint_artifacts,
+                only_deployment_artifacts=only_deployment_artifacts,
             )
         )
 

src/zenml/model/model_version.py

@@ -263,24 +263,24 @@ def get_data_artifact(
             version=version,
         )
 
-    def get_endpoint_artifact(
+    def get_deployment_artifact(
         self,
         name: str,
         version: Optional[str] = None,
     ) -> Optional[Union["ArtifactVersionResponse", "ExternalArtifact"]]:
-        """Get the endpoint artifact linked to this model version.
+        """Get the deployment artifact linked to this model version.
 
         Args:
-            name: The name of the endpoint artifact to retrieve.
-            version: The version of the endpoint artifact to retrieve (None for latest/non-versioned)
+            name: The name of the deployment artifact to retrieve.
+            version: The version of the deployment artifact to retrieve (None for latest/non-versioned)
 
         Returns:
             Inside pipeline context: ExternalArtifact object as a lazy loader
-            Outside of pipeline context: Specific version of the endpoint artifact or None
+            Outside of pipeline context: Specific version of the deployment artifact or None
         """
         if response := self._try_get_as_external_artifact(name, version):
             return response
-        return self._get_or_create_model_version().get_endpoint_artifact(
+        return self._get_or_create_model_version().get_deployment_artifact(
             name=name,
             version=version,
         )

src/zenml/model/utils.py

@@ -111,7 +111,7 @@ def link_artifact_config_to_model_version(
             model=model_version_response.model.id,
             model_version=model_version_response.id,
             is_model_artifact=artifact_config.is_model_artifact,
-            is_endpoint_artifact=artifact_config.is_endpoint_artifact,
+            is_deployment_artifact=artifact_config.is_deployment_artifact,
         )
         client.zen_store.create_model_version_artifact_link(request)