wizata-dsapi 1.3.13__tar.gz → 1.3.14__tar.gz

{wizata_dsapi-1.3.13/wizata_dsapi.egg-info → wizata_dsapi-1.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 1.3.13
+Version: 1.3.14
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-1.3.13 → wizata_dsapi-1.3.14}/wizata_dsapi/mlmodel.py

@@ -1,5 +1,8 @@
 import json
 import uuid
+
+from typing_extensions import deprecated
+
 from .api_dto import ApiDto
 from enum import Enum
 
@@ -228,6 +231,97 @@ class MLModelConfig(ApiDto):
             raise TypeError(f'unsupported target_feat type {self.target_feat.__class__.__name__}')
 
 
+class ModelList:
+    """
+    used to conveniently manipulate a list of models.
+    """
+
+    def __init__(self):
+        self.models = []
+
+class ModelInfo:
+    """
+    define a pointer to a machine learning model.
+    """
+
+    def __init__(self,
+                 key: str,
+                 twin_hardware_id: str = None,
+                 property_name: str = None,
+                 alias: str = None,
+                 file_format: str = 'pkl',
+                 source: str = 'wizata'
+                 ):
+        self.key = key
+        self.twin_hardware_id = twin_hardware_id
+        self.property_name = property_name
+        self.alias = alias
+        self.file_format = file_format
+        self.source = source
+        self.files = []
+
+    def identifier(self, include_alias: bool = False) -> str:
+        """
+        returns the complete string identifier for this model.
+        :param include_alias: include the alias pointer or leave it to target the default version.
+        :return: complete identifier of a model.
+        """
+        if self.key is None:
+            raise KeyError('please specific a model key')
+        identifier = self.key
+
+        if self.twin_hardware_id is not None:
+            identifier += f".{self.twin_hardware_id}"
+
+        if self.property_name is not None:
+            identifier += f".{self.property_name}"
+
+        if include_alias and self.alias is not None:
+                identifier += f"@{self.alias}"
+
+        return identifier
+
+    def to_json(self):
+        """
+        convert this entity in a dict that can be json serializable
+        :return: dict
+        """
+        obj = {
+            "key": self.key,
+            "file_format": self.file_format,
+            "source": self.source
+       }
+        if self.twin_hardware_id is not None:
+            obj["twin_hardware_id"] = str(self.twin_hardware_id)
+        if self.property_name is not None:
+            obj["property_name"] = self.property_name
+        if self.alias is not None:
+            obj["alias"] = self.alias
+        if self.file_format is not None:
+            obj["file_format"] = self.file_format
+        if self.source is not None:
+            obj["source"] = self.source
+        return obj
+
+    def from_json(self, obj):
+        """
+        load this entity from a dict
+        """
+        if "key" in obj.keys():
+            self.key = obj["key"]
+        if "twin_hardware_id" in obj.keys():
+            self.twin_hardware_id = obj["twin_hardware_id"]
+        if "property_name" in obj.keys():
+            self.property_name = obj["property_name"]
+        if "alias" in obj.keys():
+            self.alias = obj["alias"]
+        if "file_format" in obj.keys():
+            self.key = obj["file_format"]
+        if "source" in obj.keys():
+            self.source = obj["source"]
+
+
+@deprecated
 class MLModel(ApiDto):
     """
     used to define a stored machine learning model within Wizata.

wizata_dsapi-1.3.14/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "1.3.14"

{wizata_dsapi-1.3.13 → wizata_dsapi-1.3.14/wizata_dsapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 1.3.13
+Version: 1.3.14
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-1.3.13/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "1.3.13"