wizata-dsapi 1.3.13__py3-none-any.whl → 1.3.14__py3-none-any.whl

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/version.py

@@ -1 +1 @@
-__version__ = "1.3.13"
+__version__ = "1.3.14"

{wizata_dsapi-1.3.13.dist-info → wizata_dsapi-1.3.14.dist-info}/METADATA

@@ -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.dist-info → wizata_dsapi-1.3.14.dist-info}/RECORD

@@ -16,7 +16,7 @@ wizata_dsapi/experiment.py,sha256=QYQ1CJ-MTWsXq08xYbm5sAp95dRxbPOmGDgaAOoBMDQ,46
 wizata_dsapi/group_system.py,sha256=6rUKe0_J3YWACysyBlzuw_TEpKNXgLOMxhpWsNxOzwY,1708
 wizata_dsapi/ilogger.py,sha256=iYnID-Z-qrYhie26C43404aIuU4_tHSKXbDeQIdo82Q,807
 wizata_dsapi/insight.py,sha256=ABFZ04DqYxxzqAEfU1tzlTZqqrigM-zN-8Lbetko3g0,6468
-wizata_dsapi/mlmodel.py,sha256=VwjiG6nmljA2MOlAL04jxMBgR3FmNa6NIQWNGDlTmEQ,15108
+wizata_dsapi/mlmodel.py,sha256=iZHmmRzGj4Y5VNRflH6Kg6p4vhjdXeeBjmJherdpGM0,17966
 wizata_dsapi/model_toolkit.py,sha256=a76ckSuetSKDjEkOl7o49g9oaItdw9iOaPt0JcstmhU,1551
 wizata_dsapi/paged_query_result.py,sha256=0Iyt2Kd4tvrfthhT-tk9EmSERsbJTaPNON2euHcBn6k,1150
 wizata_dsapi/pipeline.py,sha256=WDJeOxPZJiYW1qwTNZUm3jom2epIxqrSoiUwcrTF9EE,31300
@@ -31,7 +31,7 @@ wizata_dsapi/template.py,sha256=wtCRKKk3PchH4RrNgNYlEF_9C6bzZwKIeLyEvgv6Fdo,1370
 wizata_dsapi/trigger.py,sha256=w3BZYP-L3SUwvaT0oCTanh_Ewn57peZvlt7vxzHv9J8,5129
 wizata_dsapi/twin.py,sha256=S0DUzQf1smZXZTdXpXZPtkZYCfKIhw53EecCnsl9i4Q,11017
 wizata_dsapi/twinregistration.py,sha256=Mi6-YuwroiEXc0c1hgrOaphh4hNVoHupxOnXedVtJtE,13377
-wizata_dsapi/version.py,sha256=NmFHSfJMssSLEZ5kJ2rElH-VzEUA8mv-lp3KSlUbCDw,23
+wizata_dsapi/version.py,sha256=GHcahUqpyc0hVhmDLwlPLuNF5Fjh1z_TnSAcEI6KL7s,23
 wizata_dsapi/wizard_function.py,sha256=RbM7W7Gf-6Rhp_1dU9DBYkHaciknGAGvuAndhAS_vyo,942
 wizata_dsapi/wizard_request.py,sha256=v6BaqKLKvTWmUSo0_gda9FabAQz5x_-GOH1Av50GzFo,3762
 wizata_dsapi/wizata_dsapi_client.py,sha256=kos_8j47CBXiy6y6b_H2yDUe3aWh76diEmWjCisYKkY,78662
@@ -42,8 +42,8 @@ wizata_dsapi/plots/__init__.py,sha256=qgnSFqrjOPur-807M8uh5awIfjM1ZHXUXcAqHc-r2l
 wizata_dsapi/plots/common.py,sha256=jdPsJqLHBwSKc6dX83BSGPqSRxzIVNHSYO5yI_8sjGk,6568
 wizata_dsapi/scripts/__init__.py,sha256=hAxiETSQf0qOHde1si1tEAJU48seqEgHrchCzS2-LvQ,80
 wizata_dsapi/scripts/common.py,sha256=efwq-Rd0lvYljIs3gSFz9izogBD7asOU2cTK-IvHTkM,4244
-wizata_dsapi-1.3.13.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-wizata_dsapi-1.3.13.dist-info/METADATA,sha256=V9NFWlrTlkgSgLjT9lRE9dACPAj7zlChaMxrTpM5px0,5651
-wizata_dsapi-1.3.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wizata_dsapi-1.3.13.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
-wizata_dsapi-1.3.13.dist-info/RECORD,,
+wizata_dsapi-1.3.14.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+wizata_dsapi-1.3.14.dist-info/METADATA,sha256=0xIJprHlcwiceuJEBTiZ_rrlfWsMEFiXrNBBHMjfEUs,5651
+wizata_dsapi-1.3.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wizata_dsapi-1.3.14.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
+wizata_dsapi-1.3.14.dist-info/RECORD,,