snowflake-ml-python 1.13.0__py3-none-any.whl → 1.14.0__py3-none-any.whl

snowflake/ml/jobs/_utils/constants.py

@@ -25,7 +25,7 @@ RESULT_PATH_DEFAULT_VALUE = f"{OUTPUT_STAGE_SUBPATH}/mljob_result.pkl"
 DEFAULT_IMAGE_REPO = "/snowflake/images/snowflake_images"
 DEFAULT_IMAGE_CPU = "st_plat/runtime/x86/runtime_image/snowbooks"
 DEFAULT_IMAGE_GPU = "st_plat/runtime/x86/generic_gpu/runtime_image/snowbooks"
-DEFAULT_IMAGE_TAG = "1.6.2"
+DEFAULT_IMAGE_TAG = "1.8.0"
 DEFAULT_ENTRYPOINT_PATH = "func.py"
 
 # Percent of container memory to allocate for /dev/shm volume

snowflake/ml/jobs/_utils/scripts/mljob_launcher.py

@@ -234,12 +234,6 @@ def run_script(script_path: str, *script_args: Any, main_func: Optional[str] = N
     if payload_dir and payload_dir not in sys.path:
         sys.path.insert(0, payload_dir)
 
-    # Create a Snowpark session before running the script
-    # Session can be retrieved from using snowflake.snowpark.context.get_active_session()
-    config = SnowflakeLoginOptions()
-    config["client_session_keep_alive"] = "True"
-    session = Session.builder.configs(config).create()  # noqa: F841
-
     try:
 
         if main_func:
@@ -266,7 +260,6 @@ def run_script(script_path: str, *script_args: Any, main_func: Optional[str] = N
     finally:
         # Restore original sys.argv
         sys.argv = original_argv
-        session.close()
 
 
 def main(script_path: str, *script_args: Any, script_main_func: Optional[str] = None) -> ExecutionResult:
@@ -297,6 +290,12 @@ def main(script_path: str, *script_args: Any, script_main_func: Optional[str] =
     except ModuleNotFoundError:
         warnings.warn("Ray is not installed, skipping Ray initialization", ImportWarning, stacklevel=1)
 
+    # Create a Snowpark session before starting
+    # Session can be retrieved from using snowflake.snowpark.context.get_active_session()
+    config = SnowflakeLoginOptions()
+    config["client_session_keep_alive"] = "True"
+    session = Session.builder.configs(config).create()  # noqa: F841
+
     try:
         # Wait for minimum required instances if specified
         min_instances_str = os.environ.get(MIN_INSTANCES_ENV_VAR) or "1"
@@ -352,6 +351,9 @@ def main(script_path: str, *script_args: Any, script_main_func: Optional[str] =
                 f"Failed to serialize JSON result to {result_json_path}: {json_exc}", RuntimeWarning, stacklevel=1
             )
 
+        # Close the session after serializing the result
+        session.close()
+
 
 if __name__ == "__main__":
     # Parse command line arguments

snowflake/ml/jobs/job.py

@@ -83,6 +83,8 @@ class MLJob(Generic[T], SerializableSessionMixin):
     def _container_spec(self) -> dict[str, Any]:
         """Get the job's main container spec."""
         containers = self._service_spec["spec"]["containers"]
+        if len(containers) == 1:
+            return cast(dict[str, Any], containers[0])
         try:
             container_spec = next(c for c in containers if c["name"] == constants.DEFAULT_CONTAINER_NAME)
         except StopIteration:
@@ -163,7 +165,7 @@ class MLJob(Generic[T], SerializableSessionMixin):
         Returns:
             The job's execution logs.
         """
-        logs = _get_logs(self._session, self.id, limit, instance_id, verbose)
+        logs = _get_logs(self._session, self.id, limit, instance_id, self._container_spec["name"], verbose)
         assert isinstance(logs, str)  # mypy
         if as_list:
             return logs.splitlines()
@@ -281,7 +283,12 @@ def _get_service_spec(session: snowpark.Session, job_id: str) -> dict[str, Any]:
 
 @telemetry.send_api_usage_telemetry(project=_PROJECT, func_params_to_log=["job_id", "limit", "instance_id"])
 def _get_logs(
-    session: snowpark.Session, job_id: str, limit: int = -1, instance_id: Optional[int] = None, verbose: bool = True
+    session: snowpark.Session,
+    job_id: str,
+    limit: int = -1,
+    instance_id: Optional[int] = None,
+    container_name: str = constants.DEFAULT_CONTAINER_NAME,
+    verbose: bool = True,
 ) -> str:
     """
     Retrieve the job's execution logs.
@@ -291,6 +298,7 @@ def _get_logs(
         limit: The maximum number of lines to return. Negative values are treated as no limit.
         session: The Snowpark session to use. If none specified, uses active session.
         instance_id: Optional instance ID to get logs from a specific instance.
+        container_name: The container name to get logs from a specific container.
         verbose: Whether to return the full log or just the portion between START and END messages.
 
     Returns:
@@ -311,7 +319,7 @@ def _get_logs(
     params: list[Any] = [
         job_id,
         0 if instance_id is None else instance_id,
-        constants.DEFAULT_CONTAINER_NAME,
+        container_name,
     ]
     if limit > 0:
         params.append(limit)
@@ -337,7 +345,7 @@ def _get_logs(
                     job_id,
                     limit=limit,
                     instance_id=instance_id if instance_id else 0,
-                    container_name=constants.DEFAULT_CONTAINER_NAME,
+                    container_name=container_name,
                 )
                 full_log = os.linesep.join(row[0] for row in logs)
 

snowflake/ml/jobs/manager.py

@@ -232,6 +232,7 @@ def submit_file(
             enable_metrics (bool): Whether to enable metrics publishing for the job.
             query_warehouse (str): The query warehouse to use. Defaults to session warehouse.
             spec_overrides (dict): A dictionary of overrides for the service spec.
+            imports (list[Union[tuple[str, str], tuple[str]]]): A list of additional payloads used in the job.
 
     Returns:
         An object representing the submitted job.
@@ -286,6 +287,7 @@ def submit_directory(
             enable_metrics (bool): Whether to enable metrics publishing for the job.
             query_warehouse (str): The query warehouse to use. Defaults to session warehouse.
             spec_overrides (dict): A dictionary of overrides for the service spec.
+            imports (list[Union[tuple[str, str], tuple[str]]]): A list of additional payloads used in the job.
 
     Returns:
         An object representing the submitted job.
@@ -341,6 +343,7 @@ def submit_from_stage(
             enable_metrics (bool): Whether to enable metrics publishing for the job.
             query_warehouse (str): The query warehouse to use. Defaults to session warehouse.
             spec_overrides (dict): A dictionary of overrides for the service spec.
+            imports (list[Union[tuple[str, str], tuple[str]]]): A list of additional payloads used in the job.
 
     Returns:
         An object representing the submitted job.
@@ -404,6 +407,8 @@ def _submit_job(
         "num_instances",  # deprecated
         "target_instances",
         "min_instances",
+        "enable_metrics",
+        "query_warehouse",
     ],
 )
 def _submit_job(
@@ -447,6 +452,13 @@ def _submit_job(
         )
         target_instances = max(target_instances, kwargs.pop("num_instances"))
 
+    imports = None
+    if "additional_payloads" in kwargs:
+        logger.warning(
+            "'additional_payloads' is deprecated and will be removed in a future release. Use 'imports' instead."
+        )
+        imports = kwargs.pop("additional_payloads")
+
     # Use kwargs for less common optional parameters
     database = kwargs.pop("database", None)
     schema = kwargs.pop("schema", None)
@@ -457,10 +469,7 @@ def _submit_job(
     spec_overrides = kwargs.pop("spec_overrides", None)
     enable_metrics = kwargs.pop("enable_metrics", True)
     query_warehouse = kwargs.pop("query_warehouse", session.get_current_warehouse())
-    additional_payloads = kwargs.pop("additional_payloads", None)
-
-    if additional_payloads:
-        logger.warning("'additional_payloads' is in private preview since 1.9.1. Do not use it in production.")
+    imports = kwargs.pop("imports", None) or imports
 
     # Warn if there are unknown kwargs
     if kwargs:
@@ -492,7 +501,7 @@ def _submit_job(
     try:
         # Upload payload
         uploaded_payload = payload_utils.JobPayload(
-            source, entrypoint=entrypoint, pip_requirements=pip_requirements, additional_payloads=additional_payloads
+            source, entrypoint=entrypoint, pip_requirements=pip_requirements, additional_payloads=imports
         ).upload(session, stage_path)
     except snowpark.exceptions.SnowparkSQLException as e:
         if e.sql_error_code == 90106:
@@ -501,6 +510,22 @@ def _submit_job(
             )
         raise
 
+    # FIXME: Temporary patches, remove this after v1 is deprecated
+    if target_instances > 1:
+        default_spec_overrides = {
+            "spec": {
+                "endpoints": [
+                    {"name": "ray-dashboard-endpoint", "port": 12003, "protocol": "TCP"},
+                ]
+            },
+        }
+        if spec_overrides:
+            spec_overrides = spec_utils.merge_patch(
+                default_spec_overrides, spec_overrides, display_name="spec_overrides"
+            )
+        else:
+            spec_overrides = default_spec_overrides
+
     if feature_flags.FeatureFlags.USE_SUBMIT_JOB_V2.is_enabled():
         # Add default env vars (extracted from spec_utils.generate_service_spec)
         combined_env_vars = {**uploaded_payload.env_vars, **(env_vars or {})}
@@ -668,8 +693,10 @@ def _ensure_session(session: Optional[snowpark.Session]) -> snowpark.Session:
         session = session or get_active_session()
     except snowpark.exceptions.SnowparkSessionException as e:
         if "More than one active session" in e.message:
-            raise RuntimeError("Please specify the session as a parameter in API call")
+            raise RuntimeError(
+                "More than one active session is found. Please specify the session explicitly as a parameter"
+            ) from None
         if "No default Session is found" in e.message:
-            raise RuntimeError("Please create a session before API call")
+            raise RuntimeError("No active session is found. Please create a session") from None
         raise
     return session

snowflake/ml/lineage/lineage_node.py

@@ -83,7 +83,6 @@ class LineageNode(mixins.SerializableSessionMixin):
         raise NotImplementedError()
 
     @telemetry.send_api_usage_telemetry(project=_PROJECT)
-    @snowpark._internal.utils.private_preview(version="1.5.3")
     def lineage(
         self,
         direction: Literal["upstream", "downstream"] = "downstream",

snowflake/ml/model/_client/model/model_version_impl.py

@@ -788,7 +788,7 @@ class ModelVersion(lineage_node.LineageNode):
         inference_engine_args: service_ops.InferenceEngineArgs,
         gpu_requests: Optional[Union[str, int]] = None,
     ) -> Optional[service_ops.InferenceEngineArgs]:
-        """Enrich inference engine args with model path and tensor parallelism settings.
+        """Enrich inference engine args with tensor parallelism settings.
 
         Args:
             inference_engine_args: The original inference engine args
@@ -803,21 +803,6 @@ class ModelVersion(lineage_node.LineageNode):
         if inference_engine_args.inference_engine_args_override is None:
             inference_engine_args.inference_engine_args_override = []
 
-        # Get model stage path and strip off "snow://" prefix
-        model_stage_path = self._model_ops.get_model_version_stage_path(
-            database_name=None,
-            schema_name=None,
-            model_name=self._model_name,
-            version_name=self._version_name,
-        )
-
-        # Strip "snow://" prefix
-        if model_stage_path.startswith("snow://"):
-            model_stage_path = model_stage_path.replace("snow://", "", 1)
-
-        # Always overwrite the model key by appending
-        inference_engine_args.inference_engine_args_override.append(f"--model={model_stage_path}")
-
         gpu_count = None
 
         # Set tensor-parallelism if gpu_requests is specified

snowflake/ml/model/_client/ops/model_ops.py

@@ -47,7 +47,8 @@ class ServiceInfo(TypedDict):
 class ModelOperator:
     INFERENCE_SERVICE_ENDPOINT_NAME = "inference"
     INGRESS_ENDPOINT_URL_SUFFIX = "snowflakecomputing.app"
-    PRIVATELINK_INGRESS_ENDPOINT_URL_SUBSTRING = "privatelink.snowflakecomputing"
+    # app-service-privatelink might not contain "snowflakecomputing" in the url - using the minimum required substring
+    PRIVATELINK_INGRESS_ENDPOINT_URL_SUBSTRING = "privatelink.snowflake"
 
     def __init__(
         self,
@@ -631,7 +632,13 @@ class ModelOperator:
 
     def _extract_and_validate_privatelink_url(self, res_row: "row.Row") -> Optional[str]:
         """Extract and validate privatelink ingress URL from endpoint row."""
-        url_value = res_row[self._service_client.MODEL_INFERENCE_SERVICE_ENDPOINT_PRIVATELINK_INGRESS_URL_COL_NAME]
+        # Check if the privatelink_ingress_url column exists
+        col_name = self._service_client.MODEL_INFERENCE_SERVICE_ENDPOINT_PRIVATELINK_INGRESS_URL_COL_NAME
+        if col_name not in res_row:
+            # Column doesn't exist in query result for non-Business Critical accounts
+            return None
+
+        url_value = res_row[col_name]
         if url_value is None:
             return None
         url_str = str(url_value)

snowflake/ml/model/_client/ops/service_ops.py

@@ -323,17 +323,20 @@ class ServiceOperator:
             statement_params=statement_params,
         )
 
-        # stream service logs in a thread
-        model_build_service_name = sql_identifier.SqlIdentifier(
-            self._get_service_id_from_deployment_step(query_id, DeploymentStep.MODEL_BUILD)
-        )
-        model_build_service = ServiceLogInfo(
-            database_name=service_database_name,
-            schema_name=service_schema_name,
-            service_name=model_build_service_name,
-            deployment_step=DeploymentStep.MODEL_BUILD,
-            log_color=service_logger.LogColor.GREEN,
-        )
+        model_build_service: Optional[ServiceLogInfo] = None
+        if is_enable_image_build:
+            # stream service logs in a thread
+            model_build_service_name = sql_identifier.SqlIdentifier(
+                self._get_service_id_from_deployment_step(query_id, DeploymentStep.MODEL_BUILD)
+            )
+            model_build_service = ServiceLogInfo(
+                database_name=service_database_name,
+                schema_name=service_schema_name,
+                service_name=model_build_service_name,
+                deployment_step=DeploymentStep.MODEL_BUILD,
+                log_color=service_logger.LogColor.GREEN,
+            )
+
         model_inference_service = ServiceLogInfo(
             database_name=service_database_name,
             schema_name=service_schema_name,
@@ -375,7 +378,7 @@ class ServiceOperator:
                 progress_status.increment()
 
                 # Poll for model build to start if not using existing service
-                if not model_inference_service_exists:
+                if not model_inference_service_exists and model_build_service:
                     self._wait_for_service_status(
                         model_build_service_name,
                         service_sql.ServiceStatus.RUNNING,
@@ -390,7 +393,7 @@ class ServiceOperator:
                 progress_status.increment()
 
                 # Poll for model build completion
-                if not model_inference_service_exists:
+                if not model_inference_service_exists and model_build_service:
                     self._wait_for_service_status(
                         model_build_service_name,
                         service_sql.ServiceStatus.DONE,
@@ -454,7 +457,7 @@ class ServiceOperator:
         self,
         async_job: snowpark.AsyncJob,
         model_logger_service: Optional[ServiceLogInfo],
-        model_build_service: ServiceLogInfo,
+        model_build_service: Optional[ServiceLogInfo],
         model_inference_service: ServiceLogInfo,
         model_inference_service_exists: bool,
         force_rebuild: bool,
@@ -483,7 +486,7 @@ class ServiceOperator:
         self,
         force_rebuild: bool,
         service_log_meta: ServiceLogMetadata,
-        model_build_service: ServiceLogInfo,
+        model_build_service: Optional[ServiceLogInfo],
         model_inference_service: ServiceLogInfo,
         operation_id: str,
         statement_params: Optional[dict[str, Any]] = None,
@@ -599,13 +602,24 @@ class ServiceOperator:
             # check if model logger service is done
             # and transition the service log metadata to the model image build service
             if service.deployment_step == DeploymentStep.MODEL_LOGGING:
-                service_log_meta.transition_service_log_metadata(
-                    model_build_service,
-                    f"Model Logger service {service.display_service_name} complete.",
-                    is_model_build_service_done=False,
-                    is_model_logger_service_done=service_log_meta.is_model_logger_service_done,
-                    operation_id=operation_id,
-                )
+                if model_build_service:
+                    # building the inference image, transition to the model build service
+                    service_log_meta.transition_service_log_metadata(
+                        model_build_service,
+                        f"Model Logger service {service.display_service_name} complete.",
+                        is_model_build_service_done=False,
+                        is_model_logger_service_done=service_log_meta.is_model_logger_service_done,
+                        operation_id=operation_id,
+                    )
+                else:
+                    # no model build service, transition to the model inference service
+                    service_log_meta.transition_service_log_metadata(
+                        model_inference_service,
+                        f"Model Logger service {service.display_service_name} complete.",
+                        is_model_build_service_done=True,
+                        is_model_logger_service_done=service_log_meta.is_model_logger_service_done,
+                        operation_id=operation_id,
+                    )
             # check if model build service is done
             # and transition the service log metadata to the model inference service
             elif service.deployment_step == DeploymentStep.MODEL_BUILD:
@@ -616,6 +630,8 @@ class ServiceOperator:
                     is_model_logger_service_done=service_log_meta.is_model_logger_service_done,
                     operation_id=operation_id,
                 )
+            elif service.deployment_step == DeploymentStep.MODEL_INFERENCE:
+                module_logger.info(f"Inference service {service.display_service_name} is deployed.")
             else:
                 module_logger.warning(f"Service {service.display_service_name} is done, but not transitioning.")
 
@@ -623,7 +639,7 @@ class ServiceOperator:
         self,
         async_job: snowpark.AsyncJob,
         model_logger_service: Optional[ServiceLogInfo],
-        model_build_service: ServiceLogInfo,
+        model_build_service: Optional[ServiceLogInfo],
         model_inference_service: ServiceLogInfo,
         model_inference_service_exists: bool,
         force_rebuild: bool,
@@ -632,14 +648,23 @@ class ServiceOperator:
     ) -> None:
         """Stream service logs while the async job is running."""
 
-        model_build_service_logger = service_logger.get_logger(  # BuildJobName
-            model_build_service.display_service_name,
-            model_build_service.log_color,
-            operation_id=operation_id,
-        )
-        if model_logger_service:
-            model_logger_service_logger = service_logger.get_logger(  # ModelLoggerName
-                model_logger_service.display_service_name,
+        if model_build_service:
+            model_build_service_logger = service_logger.get_logger(
+                model_build_service.display_service_name,  # BuildJobName
+                model_build_service.log_color,
+                operation_id=operation_id,
+            )
+            service_log_meta = ServiceLogMetadata(
+                service_logger=model_build_service_logger,
+                service=model_build_service,
+                service_status=None,
+                is_model_build_service_done=False,
+                is_model_logger_service_done=True,
+                log_offset=0,
+            )
+        elif model_logger_service:
+            model_logger_service_logger = service_logger.get_logger(
+                model_logger_service.display_service_name,  # ModelLoggerName
                 model_logger_service.log_color,
                 operation_id=operation_id,
             )
@@ -653,12 +678,17 @@ class ServiceOperator:
                 log_offset=0,
             )
         else:
+            model_inference_service_logger = service_logger.get_logger(
+                model_inference_service.display_service_name,  # ModelInferenceName
+                model_inference_service.log_color,
+                operation_id=operation_id,
+            )
             service_log_meta = ServiceLogMetadata(
-                service_logger=model_build_service_logger,
-                service=model_build_service,
+                service_logger=model_inference_service_logger,
+                service=model_inference_service,
                 service_status=None,
                 is_model_build_service_done=False,
-                is_model_logger_service_done=True,
+                is_model_logger_service_done=False,
                 log_offset=0,
             )
 

snowflake/ml/model/_client/sql/service.py

@@ -256,9 +256,6 @@ class ServiceSQLClient(_base._BaseSQLClient):
             )
             .has_column(ServiceSQLClient.MODEL_INFERENCE_SERVICE_ENDPOINT_NAME_COL_NAME, allow_empty=True)
             .has_column(ServiceSQLClient.MODEL_INFERENCE_SERVICE_ENDPOINT_INGRESS_URL_COL_NAME, allow_empty=True)
-            .has_column(
-                ServiceSQLClient.MODEL_INFERENCE_SERVICE_ENDPOINT_PRIVATELINK_INGRESS_URL_COL_NAME, allow_empty=True
-            )
         )
 
         return res.validate()

snowflake/ml/monitoring/_client/model_monitor_sql_client.py

@@ -30,8 +30,8 @@ class MonitorOperation(Enum):
 _OPERATION_SUPPORTED_PROPS: dict[MonitorOperation, frozenset[str]] = {
     MonitorOperation.SUSPEND: frozenset(),
     MonitorOperation.RESUME: frozenset(),
-    MonitorOperation.ADD: frozenset({"SEGMENT_COLUMN"}),
-    MonitorOperation.DROP: frozenset({"SEGMENT_COLUMN"}),
+    MonitorOperation.ADD: frozenset({"SEGMENT_COLUMN", "CUSTOM_METRIC_COLUMN"}),
+    MonitorOperation.DROP: frozenset({"SEGMENT_COLUMN", "CUSTOM_METRIC_COLUMN"}),
 }
 
 
@@ -91,6 +91,7 @@ class ModelMonitorSQLClient:
         baseline_schema: Optional[sql_identifier.SqlIdentifier] = None,
         baseline: Optional[sql_identifier.SqlIdentifier] = None,
         segment_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
+        custom_metric_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
         statement_params: Optional[dict[str, Any]] = None,
     ) -> None:
         baseline_sql = ""
@@ -101,6 +102,10 @@ class ModelMonitorSQLClient:
         if segment_columns:
             segment_columns_sql = f"SEGMENT_COLUMNS={_build_sql_list_from_columns(segment_columns)}"
 
+        custom_metric_columns_sql = ""
+        if custom_metric_columns:
+            custom_metric_columns_sql = f"CUSTOM_METRIC_COLUMNS={_build_sql_list_from_columns(custom_metric_columns)}"
+
         query_result_checker.SqlResultValidator(
             self._sql_client._session,
             f"""
@@ -120,6 +125,7 @@ class ModelMonitorSQLClient:
                     REFRESH_INTERVAL='{refresh_interval}'
                     AGGREGATION_WINDOW='{aggregation_window}'
                     {segment_columns_sql}
+                    {custom_metric_columns_sql}
                     {baseline_sql}""",
             statement_params=statement_params,
         ).has_column("status").has_dimensions(1, 1).validate()
@@ -210,6 +216,7 @@ class ModelMonitorSQLClient:
         actual_class_columns: list[sql_identifier.SqlIdentifier],
         id_columns: list[sql_identifier.SqlIdentifier],
         segment_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
+        custom_metric_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
     ) -> None:
         """Ensures all columns exist in the source table.
 
@@ -222,12 +229,14 @@ class ModelMonitorSQLClient:
             actual_class_columns: List of actual class column names.
             id_columns: List of id column names.
             segment_columns: List of segment column names.
+            custom_metric_columns: List of custom metric column names.
 
         Raises:
             ValueError: If any of the columns do not exist in the source.
         """
 
         segment_columns = [] if segment_columns is None else segment_columns
+        custom_metric_columns = [] if custom_metric_columns is None else custom_metric_columns
 
         if timestamp_column not in source_column_schema:
             raise ValueError(f"Timestamp column {timestamp_column} does not exist in source.")
@@ -248,6 +257,9 @@ class ModelMonitorSQLClient:
         if not all([column_name in source_column_schema for column_name in segment_columns]):
             raise ValueError(f"Segment column(s): {segment_columns} do not exist in source.")
 
+        if not all([column_name in source_column_schema for column_name in custom_metric_columns]):
+            raise ValueError(f"Custom Metric column(s): {custom_metric_columns} do not exist in source.")
+
     def validate_source(
         self,
         *,
@@ -261,6 +273,7 @@ class ModelMonitorSQLClient:
         actual_class_columns: list[sql_identifier.SqlIdentifier],
         id_columns: list[sql_identifier.SqlIdentifier],
         segment_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
+        custom_metric_columns: Optional[list[sql_identifier.SqlIdentifier]] = None,
     ) -> None:
 
         source_database = source_database or self._database_name
@@ -281,6 +294,7 @@ class ModelMonitorSQLClient:
             actual_class_columns=actual_class_columns,
             id_columns=id_columns,
             segment_columns=segment_columns,
+            custom_metric_columns=custom_metric_columns,
         )
 
     def _alter_monitor(
@@ -299,7 +313,7 @@ class ModelMonitorSQLClient:
 
             if target_property not in supported_target_properties:
                 raise ValueError(
-                    f"Only {', '.join(supported_target_properties)} supported as target property "
+                    f"Only {', '.join(sorted(supported_target_properties))} supported as target property "
                     f"for {operation.name} operation"
                 )
 
@@ -366,3 +380,33 @@ class ModelMonitorSQLClient:
             target_value=segment_column,
             statement_params=statement_params,
         )
+
+    def add_custom_metric_column(
+        self,
+        monitor_name: sql_identifier.SqlIdentifier,
+        custom_metric_column: sql_identifier.SqlIdentifier,
+        statement_params: Optional[dict[str, Any]] = None,
+    ) -> None:
+        """Add a custom metric column to the Model Monitor"""
+        self._alter_monitor(
+            operation=MonitorOperation.ADD,
+            monitor_name=monitor_name,
+            target_property="CUSTOM_METRIC_COLUMN",
+            target_value=custom_metric_column,
+            statement_params=statement_params,
+        )
+
+    def drop_custom_metric_column(
+        self,
+        monitor_name: sql_identifier.SqlIdentifier,
+        custom_metric_column: sql_identifier.SqlIdentifier,
+        statement_params: Optional[dict[str, Any]] = None,
+    ) -> None:
+        """Drop a custom metric column from the Model Monitor"""
+        self._alter_monitor(
+            operation=MonitorOperation.DROP,
+            monitor_name=monitor_name,
+            target_property="CUSTOM_METRIC_COLUMN",
+            target_value=custom_metric_column,
+            statement_params=statement_params,
+        )

snowflake/ml/monitoring/_manager/model_monitor_manager.py

@@ -109,6 +109,7 @@ class ModelMonitorManager:
         actual_score_columns = self._build_column_list_from_input(source_config.actual_score_columns)
         actual_class_columns = self._build_column_list_from_input(source_config.actual_class_columns)
         segment_columns = self._build_column_list_from_input(source_config.segment_columns)
+        custom_metric_columns = self._build_column_list_from_input(source_config.custom_metric_columns)
 
         id_columns = [sql_identifier.SqlIdentifier(column_name) for column_name in source_config.id_columns]
         ts_column = sql_identifier.SqlIdentifier(source_config.timestamp_column)
@@ -125,6 +126,7 @@ class ModelMonitorManager:
             actual_class_columns=actual_class_columns,
             id_columns=id_columns,
             segment_columns=segment_columns,
+            custom_metric_columns=custom_metric_columns,
         )
 
         self._model_monitor_client.create_model_monitor(
@@ -147,6 +149,7 @@ class ModelMonitorManager:
             actual_score_columns=actual_score_columns,
             actual_class_columns=actual_class_columns,
             segment_columns=segment_columns,
+            custom_metric_columns=custom_metric_columns,
             refresh_interval=model_monitor_config.refresh_interval,
             aggregation_window=model_monitor_config.aggregation_window,
             baseline_database=baseline_database_name_id,

snowflake/ml/monitoring/entities/model_monitor_config.py

@@ -36,6 +36,9 @@ class ModelMonitorSourceConfig:
     segment_columns: Optional[list[str]] = None
     """List of columns in the source containing segment information for grouped monitoring."""
 
+    custom_metric_columns: Optional[list[str]] = None
+    """List of columns in the source containing custom metrics."""
+
 
 @dataclass
 class ModelMonitorConfig:

snowflake/ml/monitoring/model_monitor.py

@@ -72,3 +72,33 @@ class ModelMonitor:
         )
         segment_column_id = sql_identifier.SqlIdentifier(segment_column)
         self._model_monitor_client.drop_segment_column(self.name, segment_column_id, statement_params=statement_params)
+
+    @telemetry.send_api_usage_telemetry(
+        project=telemetry.TelemetryProject.MLOPS.value,
+        subproject=telemetry.TelemetrySubProject.MONITORING.value,
+    )
+    def add_custom_metric_column(self, custom_metric_column: str) -> None:
+        """Add a custom metric column to the Model Monitor"""
+        statement_params = telemetry.get_statement_params(
+            telemetry.TelemetryProject.MLOPS.value,
+            telemetry.TelemetrySubProject.MONITORING.value,
+        )
+        custom_metric_column_identifier = sql_identifier.SqlIdentifier(custom_metric_column)
+        self._model_monitor_client.add_custom_metric_column(
+            self.name, custom_metric_column_identifier, statement_params=statement_params
+        )
+
+    @telemetry.send_api_usage_telemetry(
+        project=telemetry.TelemetryProject.MLOPS.value,
+        subproject=telemetry.TelemetrySubProject.MONITORING.value,
+    )
+    def drop_custom_metric_column(self, custom_metric_column: str) -> None:
+        """Drop a custom metric column from the Model Monitor"""
+        statement_params = telemetry.get_statement_params(
+            telemetry.TelemetryProject.MLOPS.value,
+            telemetry.TelemetrySubProject.MONITORING.value,
+        )
+        custom_metric_column_identifier = sql_identifier.SqlIdentifier(custom_metric_column)
+        self._model_monitor_client.drop_custom_metric_column(
+            self.name, custom_metric_column_identifier, statement_params=statement_params
+        )

snowflake/ml/version.py

@@ -1,2 +1,2 @@
 # This is parsed by regex in conda recipe meta file. Make sure not to break it.
-VERSION = "1.13.0"
+VERSION = "1.14.0"

{snowflake_ml_python-1.13.0.dist-info → snowflake_ml_python-1.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowflake-ml-python
-Version: 1.13.0
+Version: 1.14.0
 Summary: The machine learning client library that is used for interacting with Snowflake to build machine learning solutions.
 Author-email: "Snowflake, Inc" <support@snowflake.com>
 License: 
@@ -410,6 +410,16 @@ NOTE: Version 1.7.0 is used as example here. Please choose the the latest versio
 
 # Release History
 
+## 1.14.0
+
+### Bug Fixes
+
+### Behavior Changes
+
+### New Features
+
+* ML Job: The `additional_payloads` argument is now **deprecated** in favor of `imports`.
+
 ## 1.13.0
 
 ### Bug Fixes

{snowflake_ml_python-1.13.0.dist-info → snowflake_ml_python-1.14.0.dist-info}/RECORD

@@ -10,7 +10,7 @@ snowflake/cortex/_sse_client.py,sha256=sLYgqAfTOPADCnaWH2RWAJi8KbU_7gSRsTUDcDD5T
 snowflake/cortex/_summarize.py,sha256=7GH8zqfIdOiHA5w4b6EvJEKEWhaTrL4YA6iDGbn7BNM,1307
 snowflake/cortex/_translate.py,sha256=9ZGjvAnJFisbzJ_bXnt4pyug5UzhHJRXW8AhGQEersM,1652
 snowflake/cortex/_util.py,sha256=krNTpbkFLXwdFqy1bd0xi7ZmOzOHRnIfHdQCPiLZJxk,3288
-snowflake/ml/version.py,sha256=AGFrDevyvV6eDph0eyz5QYMtk3gQG8WYL19gYzcfRUk,99
+snowflake/ml/version.py,sha256=wzImQ4oymKajm6ceymlVQpiY0JE0h0m59Li3mBS-xlE,99
 snowflake/ml/_internal/env.py,sha256=EY_2KVe8oR3LgKWdaeRb5rRU-NDNXJppPDsFJmMZUUY,265
 snowflake/ml/_internal/env_utils.py,sha256=x6ID94g6FYoMX3afp0zoUHzBvuvPyiE2F6RDpxx5Cq0,30967
 snowflake/ml/_internal/file_utils.py,sha256=7sA6loOeSfmGP4yx16P4usT9ZtRqG3ycnXu7_Tk7dOs,14206
@@ -110,10 +110,10 @@ snowflake/ml/fileset/snowfs.py,sha256=uF5QluYtiJ-HezGIhF55dONi3t0E6N7ByaVAIAlM3n
 snowflake/ml/fileset/stage_fs.py,sha256=V4pysouSKKDPLzuW3u_extxfvjkQa5OlwIRES9Srpzo,20151
 snowflake/ml/jobs/__init__.py,sha256=v-v9-SA1Vy-M98B31-NlqJgpI6uEg9jEEghJLub1RUY,468
 snowflake/ml/jobs/decorators.py,sha256=mQgdWvvCwD7q79cSFKZHKegXGh2j1u8WM64UD3lCKr4,3428
-snowflake/ml/jobs/job.py,sha256=h88Tj0aQDRywDXk5KbAEVp9q7jZfcGT1xagrkR1tNEM,21981
-snowflake/ml/jobs/manager.py,sha256=Ij1ZTKc2JaCUkOVYLR5N9hBgCj0PcT3fdpIow15QvI8,26132
+snowflake/ml/jobs/job.py,sha256=VFBogPXXTWa0p-Jl10lSUFyKeqGQOtbzJIgrWTPA0rQ,22222
+snowflake/ml/jobs/manager.py,sha256=1tOpEE66gQv36BmmYnUIQ2yjS1r-uAHxIQht6ilucO8,27276
 snowflake/ml/jobs/_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snowflake/ml/jobs/_utils/constants.py,sha256=FRsmwGLYLbESf3c65mLEA34DuGajhBRC8BkHJw9BiMU,3838
+snowflake/ml/jobs/_utils/constants.py,sha256=JB8i85VbI0nIYP_c2nyAADQcmEF8BscVHHKBGhruofY,3838
 snowflake/ml/jobs/_utils/feature_flags.py,sha256=cH_NyeOncL3_tzbk0WvL1siNyodxBgn1ziPk2yBW6wY,404
 snowflake/ml/jobs/_utils/function_payload_utils.py,sha256=4LBaStMdhRxcqwRkwFje-WwiEKRWnBfkaOYouF3N3Kg,1308
 snowflake/ml/jobs/_utils/interop_utils.py,sha256=7mODMTjKCLXkJloACG6_9b2wvmRgjXF0Jx3wpWYyJeA,21413
@@ -125,11 +125,11 @@ snowflake/ml/jobs/_utils/stage_utils.py,sha256=38-LsokaGx0NzlnP8CMRioClRz-3x6xhP
 snowflake/ml/jobs/_utils/types.py,sha256=AGLu0kPTNRUki26rah_KBwWp0bBJEtUP3zcfxkj5kB0,2326
 snowflake/ml/jobs/_utils/scripts/constants.py,sha256=YyIWZqQPYOTtgCY6SfyJjk2A98I5RQVmrOuLtET5Pqg,173
 snowflake/ml/jobs/_utils/scripts/get_instance_ip.py,sha256=N2wJYMPlwg-hidwgHhDhiBWOE6TskqCfWLMRRNnZBQs,5776
-snowflake/ml/jobs/_utils/scripts/mljob_launcher.py,sha256=29_zaKjvcLkwqBqYHObtQIT933UsdJGvb82EGwyvk48,15704
+snowflake/ml/jobs/_utils/scripts/mljob_launcher.py,sha256=DPRupPuFqJ9TBbMCuomCf3jRqBJ_QQ1nCplg28HYt04,15752
 snowflake/ml/jobs/_utils/scripts/signal_workers.py,sha256=AR1Pylkm4-FGh10WXfrCtcxaV0rI7IQ2ZiO0Li7zZ3U,7433
 snowflake/ml/jobs/_utils/scripts/worker_shutdown_listener.py,sha256=SeJ8v5XDriwHAjIGpcQkwVP-f-lO9QIdVjVD7Fkgafs,7893
 snowflake/ml/lineage/__init__.py,sha256=8p1YGynC-qOxAZ8jZX2z84Reg5bv1NoJMoJmNJCrzI4,65
-snowflake/ml/lineage/lineage_node.py,sha256=vmikk4qaZuVFhQqW-VM6DuW4tDvmQlNbACvIVZEamcU,5830
+snowflake/ml/lineage/lineage_node.py,sha256=SA0rbbI67rMr1qTMs4bAVkvqVtuKNI4lIaO5w0S-IXE,5767
 snowflake/ml/model/__init__.py,sha256=S9Q77g_uxiSVkPd8fbMsP7h3y3lp0sj6UJQYH9OdeO4,467
 snowflake/ml/model/custom_model.py,sha256=fDhMObqlyzD_qQG1Bq6HHkBN1w3Qzg9e81JWPiqRfc4,12249
 snowflake/ml/model/event_handler.py,sha256=pojleQVM9TPNeDvliTvon2Sfxqbf2WWxrOebo1SaEHo,7211
@@ -141,16 +141,16 @@ snowflake/ml/model/task.py,sha256=Zp5JaLB-YfX5p_HSaw81P3J7UnycQq5EMa87A35VOaQ,28
 snowflake/ml/model/type_hints.py,sha256=G0kp85-ksnYoAUHRdXxLFQBLq3XURuqYOpu_YeKEaNA,9847
 snowflake/ml/model/_client/model/batch_inference_specs.py,sha256=kzS7YfrBxZ8QTsWE4vx7jMyOjTopPOmGZSqc1t6cCqc,611
 snowflake/ml/model/_client/model/model_impl.py,sha256=Yabrbir5vPMOnsVmQJ23YN7vqhi756Jcm6pfO8Aq92o,17469
-snowflake/ml/model/_client/model/model_version_impl.py,sha256=azf94-xWOIvpa-1F6pvkbe7ErOLmBY2f16nONq80mgw,55002
+snowflake/ml/model/_client/model/model_version_impl.py,sha256=VxIekIwBCyo4tfZJ0M2DzYzDPHgRTffsMHjJD8giqUw,54380
 snowflake/ml/model/_client/ops/metadata_ops.py,sha256=qpK6PL3OyfuhyOmpvLCpHLy6vCxbZbp1HlEvakFGwv4,4884
-snowflake/ml/model/_client/ops/model_ops.py,sha256=dcyV0PgAUynVWBfhPhzRmKe7S0R484-xng5ajJOtHaI,50048
-snowflake/ml/model/_client/ops/service_ops.py,sha256=pMKBJDza1AAhzBPELcNU6iIjOLhY_6kxrMWYmiB9Kvc,41887
+snowflake/ml/model/_client/ops/model_ops.py,sha256=XGQB62Nc4ld86I7wJzuJGkmbrI38wIBm4egsZptdrM8,50394
+snowflake/ml/model/_client/ops/service_ops.py,sha256=qJRXYswDruVuH8e2DjQY8l6hq-x4DipA-uPfZzTDfT0,43655
 snowflake/ml/model/_client/service/model_deployment_spec.py,sha256=LxdhU1m4YGc1MNyApQ0IyUetcH4IXOmwYOY9X3wjznY,19499
 snowflake/ml/model/_client/service/model_deployment_spec_schema.py,sha256=QpDso2bjx2eCRKIG4-ppc3z46B7hgYMZehOTRoR9IJs,2425
 snowflake/ml/model/_client/sql/_base.py,sha256=Qrm8M92g3MHb-QnSLUlbd8iVKCRxLhG_zr5M2qmXwJ8,1473
 snowflake/ml/model/_client/sql/model.py,sha256=nstZ8zR7MkXVEfhqLt7PWMik6dZr06nzq7VsF5NVNow,5840
 snowflake/ml/model/_client/sql/model_version.py,sha256=QwzFlDH5laTqK2qF7SJQSbt28DgspWj3R11l-yD1Da0,23496
-snowflake/ml/model/_client/sql/service.py,sha256=LheEjXaXOKBPl1M9xwcV6EakMZX2pcyjljWPj_8NE5k,10614
+snowflake/ml/model/_client/sql/service.py,sha256=npggGj24DnguaBEuJ7vzy-gmY5OrygyAcyhHW47icAM,10458
 snowflake/ml/model/_client/sql/stage.py,sha256=2gxYNtmEXricwxeACVUr63OUDCy_iQvCi-kRT4qQtBA,887
 snowflake/ml/model/_client/sql/tag.py,sha256=9sI0VoldKmsfToWSjMQddozPPGCxYUI6n0gPBiqd6x8,4333
 snowflake/ml/model/_model_composer/model_composer.py,sha256=Xqi-sxmkBoZl383LQAXhMQkq9KsAS0A3ythC5bN3EOU,8292
@@ -424,13 +424,13 @@ snowflake/ml/modeling/xgboost/xgb_regressor.py,sha256=-k0ZHkTZkVybwNTbnRkR4O0Mgl
 snowflake/ml/modeling/xgboost/xgbrf_classifier.py,sha256=e7WgTxM3xHVxkOIhgUWnDrvFt1lZIGPJel4LhIGk46I,64253
 snowflake/ml/modeling/xgboost/xgbrf_regressor.py,sha256=tnCllaN_BEgRybZcxyvI3vZYzsEpCIIM7oGEPgF6y60,63778
 snowflake/ml/monitoring/explain_visualize.py,sha256=Vj4x7ClGvXY42HQzFcvVr1CbO_vVfZv6eZn_jV9N9gk,16145
-snowflake/ml/monitoring/model_monitor.py,sha256=1NOub1Cm9mtyawTj0H6pA1KtmEZ_yKVpn76PMdXWh0Y,3216
+snowflake/ml/monitoring/model_monitor.py,sha256=m-1eeQIhAYAvFQ-8mjMQ-PTzCpnN9XEcWpdHdQuEEus,4707
 snowflake/ml/monitoring/shap.py,sha256=Dp9nYquPEZjxMTW62YYA9g9qUdmCEFxcSk7ejvOP7PE,3597
-snowflake/ml/monitoring/_client/model_monitor_sql_client.py,sha256=DzEEpIshNaPnBZl2EL81J7Eltpv7mitCtVGOVKBFrBM,15913
+snowflake/ml/monitoring/_client/model_monitor_sql_client.py,sha256=6IVU1aQdiRu0GRhpZfNatJdzd5YgUNFlJ3Ti-mBxzN8,18027
 snowflake/ml/monitoring/_client/queries/record_count.ssql,sha256=Bd1uNMwhPKqPyrDd5ug8iY493t9KamJjrlo82OAfmjY,335
 snowflake/ml/monitoring/_client/queries/rmse.ssql,sha256=OEJiSStRz9-qKoZaFvmubtY_n0xMUjyVU2uiQHCp7KU,822
-snowflake/ml/monitoring/_manager/model_monitor_manager.py,sha256=ZENYZwAQXJEEyamX841qVViJBD0UwS-bdVQnEz7lBKg,10484
-snowflake/ml/monitoring/entities/model_monitor_config.py,sha256=navyOSsDvbJ6RIuFge8ECsD9FxWcRKxd4bopMiHybS0,1931
+snowflake/ml/monitoring/_manager/model_monitor_manager.py,sha256=Aouj5ojRk28Na7TnCDPke13MEezHdVXC7WG1CBq4LoQ,10702
+snowflake/ml/monitoring/entities/model_monitor_config.py,sha256=tKjYuzBmnpomIogmXcLyJlHfoCBgguulav8TOdzu0lQ,2053
 snowflake/ml/registry/__init__.py,sha256=XdPQK9ejYkSJVrSQ7HD3jKQO0hKq2mC4bPCB6qrtH3U,76
 snowflake/ml/registry/registry.py,sha256=Ro7flVHv3FnEU9Ly3zWRnDAqWiwRSOA2uw_MSKmCBTI,32936
 snowflake/ml/registry/_manager/model_manager.py,sha256=QsEpIbg3FPEbDOQXb_oo41hBjojrdVibdrNPCyJ0Cb0,17650
@@ -440,8 +440,8 @@ snowflake/ml/utils/connection_params.py,sha256=JuadbzKlgDZLZ5vJ9cnyAiSitvZT9jGSf
 snowflake/ml/utils/html_utils.py,sha256=L4pzpvFd20SIk4rie2kTAtcQjbxBHfjKmxonMAT2OoA,7665
 snowflake/ml/utils/sparse.py,sha256=zLBNh-ynhGpKH5TFtopk0YLkHGvv0yq1q-sV59YQKgg,3819
 snowflake/ml/utils/sql_client.py,sha256=pSe2od6Pkh-8NwG3D-xqN76_uNf-ohOtVbT55HeQg1Y,668
-snowflake_ml_python-1.13.0.dist-info/licenses/LICENSE.txt,sha256=PdEp56Av5m3_kl21iFkVTX_EbHJKFGEdmYeIO1pL_Yk,11365
-snowflake_ml_python-1.13.0.dist-info/METADATA,sha256=2qYBLI9oOcJD_9nibGr83ZmW8fBFPqqLrbvjaPfrhDM,94503
-snowflake_ml_python-1.13.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-snowflake_ml_python-1.13.0.dist-info/top_level.txt,sha256=TY0gFSHKDdZy3THb0FGomyikWQasEGldIR1O0HGOHVw,10
-snowflake_ml_python-1.13.0.dist-info/RECORD,,
+snowflake_ml_python-1.14.0.dist-info/licenses/LICENSE.txt,sha256=PdEp56Av5m3_kl21iFkVTX_EbHJKFGEdmYeIO1pL_Yk,11365
+snowflake_ml_python-1.14.0.dist-info/METADATA,sha256=mw74_T9nT9XU_DWlTd6ihFIG41CjQByxElsNo96Xbww,94660
+snowflake_ml_python-1.14.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+snowflake_ml_python-1.14.0.dist-info/top_level.txt,sha256=TY0gFSHKDdZy3THb0FGomyikWQasEGldIR1O0HGOHVw,10
+snowflake_ml_python-1.14.0.dist-info/RECORD,,