Merge hsml client

Author: aversey

python/hopsworks/client/__init__.py

@@ -17,11 +17,25 @@
 from typing import Literal, Optional, Union
 
 from hopsworks.client import external, hopsworks
+from hopsworks.client.istio import base as istio_base
+from hopsworks.client.istio import external as istio_external
+from hopsworks.client.istio import internal as istio_internal
+from hopsworks.constants import HOSTS
 
 
 _client = None
 _python_version = None
 
+_client_type = None
+_saas_connection = None
+
+_istio_client = None
+
+_kserve_installed = None
+_serving_resource_limits = None
+_serving_num_instances_limits = None
+_knative_domain = None
+
 
 def init(
     client_type: Union[Literal["hopsworks"], Literal["external"]],
@@ -37,6 +51,12 @@ def init(
     api_key_file: Optional[str] = None,
     api_key_value: Optional[str] = None,
 ) -> None:
+    global _client_type
+    _client_type = client_type
+
+    global _saas_connection
+    _saas_connection = host == HOSTS.APP_HOST
+
     global _client
     if not _client:
         if client_type == "hopsworks":
@@ -64,6 +84,77 @@ def get_instance() -> Union[hopsworks.Client, external.Client]:
     raise Exception("Couldn't find client. Try reconnecting to Hopsworks.")
 
 
+def set_istio_client(host, port, project=None, api_key_value=None):
+    global _client_type, _istio_client
+
+    if not _istio_client:
+        if _client_type == "internal":
+            _istio_client = istio_internal.Client(host, port)
+        elif _client_type == "external":
+            _istio_client = istio_external.Client(host, port, project, api_key_value)
+
+
+def get_istio_instance() -> istio_base.Client:
+    global _istio_client
+    return _istio_client
+
+
+def get_client_type() -> str:
+    global _client_type
+    return _client_type
+
+
+def is_saas_connection() -> bool:
+    global _saas_connection
+    return _saas_connection
+
+
+def set_kserve_installed(kserve_installed):
+    global _kserve_installed
+    _kserve_installed = kserve_installed
+
+
+def is_kserve_installed() -> bool:
+    global _kserve_installed
+    return _kserve_installed
+
+
+def set_serving_resource_limits(max_resources):
+    global _serving_resource_limits
+    _serving_resource_limits = max_resources
+
+
+def get_serving_resource_limits():
+    global _serving_resource_limits
+    return _serving_resource_limits
+
+
+def set_serving_num_instances_limits(num_instances_range):
+    global _serving_num_instances_limits
+    _serving_num_instances_limits = num_instances_range
+
+
+def get_serving_num_instances_limits():
+    global _serving_num_instances_limits
+    return _serving_num_instances_limits
+
+
+def is_scale_to_zero_required():
+    # scale-to-zero is required for KServe deployments if the Hopsworks variable `kube_serving_min_num_instances`
+    # is set to 0. Other possible values are -1 (unlimited num instances) or >1 num instances.
+    return get_serving_num_instances_limits()[0] == 0
+
+
+def get_knative_domain():
+    global _knative_domain
+    return _knative_domain
+
+
+def set_knative_domain(knative_domain):
+    global _knative_domain
+    _knative_domain = knative_domain
+
+
 def get_python_version():
     global _python_version
     return _python_version
@@ -79,3 +170,8 @@ def stop():
     if _client:
         _client._close()
     _client = None
+
+    global _istio_client
+    if _istio_client:
+        _istio_client._close()
+    _istio_client = None

python/hopsworks/client/auth.py

@@ -16,7 +16,10 @@
 
 from __future__ import annotations
 
+import os
+
 import requests
+from hopsworks.client import exceptions
 
 
 class BearerAuth(requests.auth.AuthBase):
@@ -50,3 +53,25 @@ def __init__(self, token: str) -> None:
     def __call__(self, r: requests.Request) -> requests.Request:
         r.headers["X-API-KEY"] = self._token
         return r
+
+
+def get_api_key(api_key_value, api_key_file):
+    if api_key_value is not None:
+        return api_key_value
+    elif api_key_file is not None:
+        file = None
+        if os.path.exists(api_key_file):
+            try:
+                file = open(api_key_file, mode="r")
+                return file.read()
+            finally:
+                file.close()
+        else:
+            raise IOError(
+                "Could not find api key file on path: {}".format(api_key_file)
+            )
+    else:
+        raise exceptions.ExternalClientError(
+            "Either api_key_file or api_key_value must be set when connecting to"
+            " hopsworks from an external environment."
+        )

python/hopsworks/client/exceptions.py

@@ -99,6 +99,27 @@ class FeatureStoreException(Exception):
     """Generic feature store exception"""
 
 
+class ModelRegistryException(Exception):
+    """Generic model registry exception"""
+
+
+class ModelServingException(Exception):
+    """Generic model serving exception"""
+
+    ERROR_CODE_SERVING_NOT_FOUND = 240000
+    ERROR_CODE_ILLEGAL_ARGUMENT = 240001
+    ERROR_CODE_DUPLICATED_ENTRY = 240011
+
+    ERROR_CODE_DEPLOYMENT_NOT_RUNNING = 250001
+
+
+class InternalClientError(TypeError):
+    """Raised when internal client cannot be initialized due to missing arguments."""
+
+    def __init__(self, message):
+        super().__init__(message)
+
+
 class ExternalClientError(TypeError):
     """Raised when external client cannot be initialized due to missing arguments."""
 

python/hopsworks/client/external.py

@@ -110,7 +110,9 @@ def __init__(
         self._cert_key = None
         self._cert_folder_base = os.path.join(cert_folder, host)
 
-        if engine == "python":
+        if not project:
+            return
+        elif engine == "python":
             credentials = self._materialize_certs(cert_folder, host, project)
 
             self._write_pem_file(credentials["caChain"], self._get_ca_chain_path())
@@ -258,6 +260,10 @@ def _validate_spark_configuration(self, _spark_session):
     def _close(self):
         """Closes a client and deletes certificates."""
         # TODO: check if the certificate cleanup may break users using hsfs python ingestion
+        if not self._project_name:
+            self._connected = False
+            return
+
         _logger.info("Closing external client and cleaning up certificates.")
         if self._cert_folder_base is None:
             _logger.debug("No certificates to clean up.")

python/hopsworks/client/istio/base.py

@@ -17,8 +17,8 @@
 import os
 from abc import abstractmethod
 
-from hsml.client import base
-from hsml.client.istio.grpc.inference_client import GRPCInferenceServerClient
+from hopsworks.client import base
+from hopsworks.client.istio.grpc.inference_client import GRPCInferenceServerClient
 
 
 class Client(base.Client):

python/hopsworks/client/istio/external.py

@@ -15,8 +15,8 @@
 #
 
 import requests
-from hsml.client import auth
-from hsml.client.istio import base as istio
+from hopsworks.client import auth
+from hopsworks.client.istio import base as istio
 
 
 class Client(istio.Client):

python/hopsworks/client/istio/grpc/inference_client.py

@@ -14,10 +14,10 @@
 #   limitations under the License.
 
 import grpc
-from hsml.client.istio.grpc.proto.grpc_predict_v2_pb2_grpc import (
+from hopsworks.client.istio.grpc.proto.grpc_predict_v2_pb2_grpc import (
     GRPCInferenceServiceStub,
 )
-from hsml.client.istio.utils.infer_type import InferRequest, InferResponse
+from hopsworks.client.istio.utils.infer_type import InferRequest, InferResponse
 
 
 class GRPCInferenceServerClient:

python/hopsworks/client/istio/grpc/proto/grpc_predict_v2_pb2_grpc.py

@@ -15,8 +15,8 @@
 # Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
 """Client and server classes corresponding to protobuf-defined services."""
 
-import hsml.client.istio.grpc.inference_client as inference_client
-import hsml.client.istio.grpc.proto.grpc_predict_v2_pb2 as grpc__predict__v2__pb2
+import hopsworks.client.istio.grpc.inference_client as inference_client
+import hopsworks.client.istio.grpc.proto.grpc_predict_v2_pb2 as grpc__predict__v2__pb2
 
 
 class GRPCInferenceServiceStub(object):

python/hopsworks/client/istio/internal.py

@@ -20,8 +20,8 @@
 from pathlib import Path
 
 import requests
-from hsml.client import auth, exceptions
-from hsml.client.istio import base as istio
+from hopsworks.client import auth, exceptions
+from hopsworks.client.istio import base as istio
 
 
 try:

python/hopsworks/client/istio/utils/infer_type.py

@@ -21,13 +21,13 @@
 import numpy
 import numpy as np
 import pandas as pd
-from hsml.client.istio.grpc.errors import InvalidInput
-from hsml.client.istio.grpc.proto.grpc_predict_v2_pb2 import (
+from hopsworks.client.istio.grpc.errors import InvalidInput
+from hopsworks.client.istio.grpc.proto.grpc_predict_v2_pb2 import (
     InferTensorContents,
     ModelInferRequest,
     ModelInferResponse,
 )
-from hsml.client.istio.utils.numpy_codec import from_np_dtype, to_np_dtype
+from hopsworks.client.istio.utils.numpy_codec import from_np_dtype, to_np_dtype
 
 
 GRPC_CONTENT_DATATYPE_MAPPINGS = {

python/hopsworks/connection.py

@@ -400,7 +400,8 @@ def connect(self):
                 self._host, variable_api.VariableApi().get_version("hopsworks")
             )
             self._model_api = model_api.ModelApi()
-            self._model_serving_api.load_default_configuration()  # istio client, default resources,...
+            if self._project:
+                self._model_serving_api.load_default_configuration()  # istio client, default resources,...
         except (TypeError, ConnectionError):
             self._connected = False
             raise
@@ -431,7 +432,8 @@ def close(self):
         from hsfs import engine as hsfs_engine
         from hsml import client as hsml_client
 
-        OpenSearchClientSingleton().close()
+        if self._project:
+            OpenSearchClientSingleton().close()
 
         try:
             hsfs_client.stop()

python/hsfs/client/__init__.py

@@ -19,12 +19,25 @@
     base,
     exceptions,
     external,
+    get_client_type,
     get_instance,
+    get_istio_instance,
+    get_knative_domain,
     get_python_version,
+    get_serving_num_instances_limits,
+    get_serving_resource_limits,
     hopsworks,
     init,
+    is_kserve_installed,
+    is_saas_connection,
+    is_scale_to_zero_required,
     online_store_rest_client,
+    set_istio_client,
+    set_knative_domain,
+    set_kserve_installed,
     set_python_version,
+    set_serving_num_instances_limits,
+    set_serving_resource_limits,
     stop,
 )
 
@@ -34,11 +47,24 @@
     base,
     exceptions,
     external,
+    get_client_type,
     get_instance,
+    get_istio_instance,
+    get_knative_domain,
     get_python_version,
+    get_serving_num_instances_limits,
+    get_serving_resource_limits,
     hopsworks,
     init,
+    is_kserve_installed,
+    is_saas_connection,
+    is_scale_to_zero_required,
     online_store_rest_client,
+    set_istio_client,
+    set_knative_domain,
+    set_kserve_installed,
     set_python_version,
+    set_serving_num_instances_limits,
+    set_serving_resource_limits,
     stop,
 ]

python/hsfs/client/auth.py

@@ -14,7 +14,17 @@
 #   limitations under the License.
 #
 
-from hopsworks.client.auth import ApiKeyAuth, BearerAuth, OnlineStoreKeyAuth
+from hopsworks.client.auth import (
+    ApiKeyAuth,
+    BearerAuth,
+    OnlineStoreKeyAuth,
+    get_api_key,
+)
 
 
-__all__ = [ApiKeyAuth, BearerAuth, OnlineStoreKeyAuth]
+__all__ = [
+    ApiKeyAuth,
+    BearerAuth,
+    OnlineStoreKeyAuth,
+    get_api_key,
+]