hiddenlayer-sdk 0.1.0__py3-none-any.whl

hiddenlayer/sdk/rest/models/validation_error_model_loc_inner.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+VALIDATIONERRORMODELLOCINNER_ANY_OF_SCHEMAS = ["int", "str"]
+
+class ValidationErrorModelLocInner(BaseModel):
+    """
+    ValidationErrorModelLocInner
+    """
+
+    # data type: str
+    anyof_schema_1_validator: Optional[StrictStr] = None
+    # data type: int
+    anyof_schema_2_validator: Optional[StrictInt] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[int, str]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "int", "str" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ValidationErrorModelLocInner.model_construct()
+        error_messages = []
+        # validate data type: str
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: int
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ValidationErrorModelLocInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into str
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ValidationErrorModelLocInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], int, str]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

hiddenlayer/sdk/rest/rest.py

@@ -0,0 +1,257 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from hiddenlayer.sdk.rest.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

hiddenlayer/sdk/services/aidr_predictive.py

@@ -0,0 +1,76 @@
+import base64
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+
+import numpy as np
+
+from hiddenlayer.sdk.rest.api import AidrPredictiveApi
+from hiddenlayer.sdk.rest.api_client import ApiClient
+from hiddenlayer.sdk.rest.models import (
+    SubmissionResponse,
+    SubmissionV2,
+)
+
+
+class AIDRPredictive:
+    def __init__(self, api_client: ApiClient) -> None:
+        self._aidr_predictive = AidrPredictiveApi(api_client=api_client)
+
+    def submit_vectors(
+        self,
+        *,
+        model_id: str,
+        requester_id: str,
+        input_vectors: Union[List[float], np.ndarray],
+        output: Union[List[float], np.ndarray],
+        predictions: Optional[List[float]] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        event_time: Optional[str] = None,
+    ) -> SubmissionResponse:
+        """
+        Submit feature vectors and model outputs via the HiddenLayer API.
+
+        :param model_id: Model id.
+        :param requester_id: Custom identifier for the inbound request. This should be a value that can be used to identify individual users interacting with the model.
+        :param input_vectors: Feature vectors for your model.
+        :param output: Output vectors directly from your model.
+        :param predictions: If you ran `np.argmax` or `np.argmin` or provided custom logic onto the model output.
+        :param tags: Custom tags attached to the request.
+        :param metadata: Custom metadata attached to the request.
+        :param event_time: Time when the features and outputs were created, defaults to now.
+
+        :returns: Submission Response
+        """
+
+        input_vectors = (
+            np.array(input_vectors)
+            if isinstance(input_vectors, list)
+            else input_vectors
+        )
+        output = np.array(output) if isinstance(output, list) else output
+
+        # Output vectors need to be at least 2d or AIDR will fail silently
+        output = output.reshape(-1, 1) if len(output.shape) == 1 else output
+
+        input_layer = base64.b64encode(input_vectors.tobytes()).decode()
+        output_layer = base64.b64encode(output.tobytes()).decode()
+
+        return self._aidr_predictive.submit_vectors(
+            SubmissionV2(
+                metadata=metadata if metadata else {},
+                tags=tags if tags else [],
+                sensor_id=model_id,
+                requester_id=requester_id,
+                input_layer=input_layer,
+                input_layer_dtype=str(input_vectors.dtype),
+                input_layer_shape=list(input_vectors.shape),
+                output_layer=output_layer,
+                output_layer_dtype=str(output.dtype),
+                output_layer_shape=list(output.shape),
+                predictions=predictions,
+                event_time=event_time
+                if event_time
+                else str(datetime.now().isoformat()),
+            )
+        )

hiddenlayer/sdk/services/model.py

@@ -0,0 +1,101 @@
+import json
+from typing import Optional
+
+from hiddenlayer.sdk.constants import ApiErrors
+from hiddenlayer.sdk.exceptions import (
+    HiddenlayerConflictError,
+    IncompatibleModelError,
+    ModelDoesNotExistError,
+)
+from hiddenlayer.sdk.rest.api import SensorApi
+from hiddenlayer.sdk.rest.api_client import ApiClient
+from hiddenlayer.sdk.rest.exceptions import ApiException
+from hiddenlayer.sdk.rest.models import (
+    CreateSensorRequest,
+    Model,
+    SensorSORQueryFilter,
+    SensorSORQueryRequest,
+)
+
+
+class ModelAPI:
+    def __init__(self, api_client: ApiClient) -> None:
+        self._sensor_api = SensorApi(api_client=api_client)
+
+    def create(self, *, model_name: str) -> Model:
+        """
+        Creates a model in the HiddenLayer Platform.
+
+        :params model_name: Name of the model
+
+        :returns: HiddenLayer ModelID
+        """
+        return self._sensor_api.create_sensor(
+            CreateSensorRequest(plaintext_name=model_name, adhoc=True)
+        )
+
+    def get(self, *, model_name: str, version: Optional[int] = None) -> Model:
+        """
+        Gets a HiddenLayer model object. If not version is supplied, the latest model is returned.
+
+        :param model_name: Name of the model.
+        :param version: Version of the model to get.
+
+        :returns: HiddenLayer Model object
+        """
+
+        return self._get_model_by_name(model_name=model_name, version=version)
+
+    def delete(self, *, model_name: str) -> None:
+        """
+        Delete a model.
+
+        :param model_name: Name of the model.
+        """
+
+        model = self._get_model_by_name(model_name=model_name, version=None)
+
+        try:
+            self._sensor_api.delete_model(sensor_id=model.sensor_id)
+        except ApiException as e:
+            reason = json.loads(str(e.body))["detail"]
+
+            if reason == ApiErrors.NON_ADHOC_SENSOR_DELETE:
+                raise IncompatibleModelError(
+                    "This type of model is unable to be deleted."
+                )
+            else:
+                raise HiddenlayerConflictError(reason)
+        except Exception as e:
+            raise e
+
+    def _get_model_by_name(
+        self, *, model_name: str, version: Optional[int] = None
+    ) -> Model:
+        """
+        Gets a model object by name. If version is not supplied, get the latest.
+
+        :param model_name: Name of the model.
+        :param version: Version of the model to get.
+
+        :returns: HiddenLayer Model object
+        """
+
+        models = self._sensor_api.query_sensor(
+            sensor_sor_query_request=SensorSORQueryRequest(
+                filter=SensorSORQueryFilter(plaintext_name=model_name, version=version)
+            )
+        )
+
+        if not models.results:
+            msg = f"Model {model_name} does not exist"
+
+            if version:
+                msg = f"{msg} for version {version}."
+
+            raise ModelDoesNotExistError(msg)
+
+        if not version:
+            models.results.sort(key=lambda x: x.version, reverse=True)
+
+        return models.results[0]