wizata-dsapi 1.3.20__py3-none-any.whl → 1.3.23__py3-none-any.whl

wizata_dsapi/api_config.py

@@ -2,7 +2,7 @@
 from .plot import Plot
 from .datapoint import DataPoint
 from .datastore import DataStore
-from .mlmodel import MLModel
+from .mlmodel import ModelInfo, ModelList
 from .request import Request
 from .execution import Execution, ExecutionStatus
 from .experiment import Experiment
@@ -76,12 +76,6 @@ _registry = {
             "cloud_dsapi": ['lists', 'get_by_id', 'create', 'update', 'delete', 'search'],
             "cloud_context": ['get_by_id', 'create', 'update', 'delete', 'search']
         },
-    "mlmodels":
-        {
-            "class": MLModel,
-            "cloud_dsapi": ['lists', 'get_by_id', 'get_by_key', 'delete'],
-            "cloud_context": []
-        },
     "pipelines":
         {
             "class": Pipeline,

wizata_dsapi/dsapi_json_encoder.py

@@ -3,7 +3,6 @@ import uuid
 import pandas
 import time
 
-from .mlmodel import MLModel
 from .script import Script
 from .plot import Plot
 from .wizard_function import WizardStep, WizardFunction
@@ -15,20 +14,6 @@ class DSAPIEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, uuid.UUID):
             return str(obj)
-        if isinstance(obj, MLModel):
-            json_obj = {
-                "id": str(obj.model_id),
-                "status": str(obj.status),
-                "generatedById": str(obj.generatedById),
-                "input_columns": list(obj.input_columns),
-                "output_columns": list(obj.output_columns),
-                "has_anomalies": str(obj.has_anomalies),
-                "labels_count": str(obj.label_counts),
-                "has_target_feat": str(obj.has_target_feat),
-                "needExactColumnNames": str(obj.needExactColumnNames),
-                "needExactColumnNumbers": str(obj.needExactColumnNumbers)
-            }
-            return json_obj
         if isinstance(obj, Script):
             json_obj = {
                 "id": str(obj.script_id),

wizata_dsapi/mlmodel.py

@@ -12,25 +12,40 @@ def get_bool(obj, name: str):
 class ModelInfo:
     """
     define a pointer to a machine learning model.
+
+    :ivar model_type str: mlflow model flavour
     """
 
     def __init__(self,
                  key: str,
                  twin_hardware_id: str = None,
-                 property_name: str = None,
+                 property_value: str = None,
                  alias: str = None,
+                 model_type: str = None,
                  file_format: str = 'pkl',
-                 source: str = 'wizata'
+                 source: str = 'wizata',
+                 property_name: str = None
                  ):
+        # information identifying a model
         self.key = key
         self.twin_hardware_id = twin_hardware_id
-        self.property_name = property_name
+        self.property_value = property_value
         self.alias = alias
         self.file_format = file_format
         self.source = source
+        self.model_type = model_type
+
+        # files attached to model when loaded
         self.trained_model = None
         self.scaler = None
 
+        # temporary properties during model generation not generally stored
+        self.property_name = property_name
+        self.input_columns = None
+        self.has_target_feat = False
+        self.label_counts = 0
+
+
     def identifier(self, include_alias: bool = False) -> str:
         """
         returns the complete string identifier for this model.
@@ -44,8 +59,8 @@ class ModelInfo:
         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 self.property_value is not None:
+            identifier += f".{self.property_value}"
 
         if include_alias and self.alias is not None:
             identifier += f"@{self.alias}"
@@ -64,14 +79,18 @@ class ModelInfo:
         }
         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.property_value is not None:
+            obj["property_value"] = self.property_value
         if self.alias is not None:
             obj["alias"] = self.alias
+        if self.model_type is not None:
+            obj["model_type"] = self.model_type
         if self.file_format is not None:
             obj["file_format"] = self.file_format
         if self.source is not None:
             obj["source"] = self.source
+        if self.property_name is not None:
+            obj["property_name"] = self.property_name
         return obj
 
     def from_json(self, obj):
@@ -82,14 +101,18 @@ class ModelInfo:
             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 "property_value" in obj.keys():
+            self.property_name = obj["property_value"]
         if "alias" in obj.keys():
             self.alias = obj["alias"]
+        if "model_type" in obj.keys():
+            self.model_type = obj["model_type"]
         if "file_format" in obj.keys():
             self.key = obj["file_format"]
         if "source" in obj.keys():
             self.source = obj["source"]
+        if "property_name" in obj.keys():
+            self.property_name = obj["property_name"]
 
 
 class ModelList:
@@ -186,19 +209,28 @@ class MLModelConfig(ApiDto):
         self.model_type = model_type
         self.model_alias = model_alias
 
-    def create_model_info(self, hardware_id: str = None) -> ModelInfo:
+    def create_model_info(self,
+                          hardware_id: str = None,
+                          property_value: str = None) -> ModelInfo:
         """
         create model info corresponding to the configuration.
         :param hardware_id: provide a hardware id for this model if by_twin.
+        :param property_value: provide a value for this model if by_property.
         :return:
         """
+        if self.by_twin and hardware_id is None:
+            raise ValueError('hardware_id is required if by_twin to create a model info')
+        if self.by_property and property_value is None:
+            raise ValueError('property_value is required if by_property to create a model info')
         model_info = ModelInfo(
             key=self.model_key,
             twin_hardware_id=hardware_id,
-            property_name=self.property_name,
+            property_value=property_value,
             source=self.source,
             alias=self.model_alias,
-            file_format=self.model_format
+            file_format=self.model_format,
+            model_type=self.model_type,
+            property_name=self.property_name
         )
         return model_info
 

wizata_dsapi/model_toolkit.py

@@ -1,28 +1,28 @@
 import pandas
-from .mlmodel import MLModel
+from .mlmodel import ModelInfo
 
 
-def predict(df: pandas.DataFrame, ml_model: MLModel, mapping_table=None):
+def predict(df: pandas.DataFrame, model_info: ModelInfo, mapping_table=None):
     """
     Execute a Machine Learning models locally.
     :param df: dataframe to use as input.
-    :param ml_model: trained machine learning model.
+    :param model_info: model information handler.
     :param mapping_table: Optional mapping table.
     :return: output dataframe with predicted values.
     """
-    if ml_model is None or ml_model.trained_model is None or ml_model.input_columns is None:
+    if model_info is None or model_info.trained_model is None or model_info.input_columns is None:
         raise ValueError("Please download your model from DS API before using it.")
     old_index = df.index
     df.index = pandas.to_datetime(df.index)
     df_result = pandas.DataFrame(index=df.index)
-    features = ml_model.input_columns
-    if ml_model.has_target_feat is True:
-        df_result['result'] = ml_model.trained_model.detect(df[features]).astype(float)
+    features = model_info.input_columns
+    if model_info.has_target_feat is True:
+        df_result['result'] = model_info.trained_model.detect(df[features]).astype(float)
     else:
-        df_result['result'] = ml_model.trained_model.predict(df[features]).astype(float)
-    if ml_model.label_counts != 0:
-        df_result[__generate_label_columns(ml_model.label_counts)] = \
-            ml_model.trained_model.predict_proba(df[features]).astype(float)
+        df_result['result'] = model_info.trained_model.predict(df[features]).astype(float)
+    if model_info.label_counts != 0:
+        df_result[__generate_label_columns(model_info.label_counts)] = \
+            model_info.trained_model.predict_proba(df[features]).astype(float)
     df_result = df_result.set_index(old_index)
     return df_result
 

wizata_dsapi/pipeline_image.py

@@ -3,7 +3,7 @@ import json
 from .api_dto import ApiDto
 from .pipeline import Pipeline
 from .script import Script
-from .mlmodel import MLModel
+from .mlmodel import ModelInfo
 from datetime import datetime
 
 import pytz

wizata_dsapi/version.py

@@ -1 +1 @@
-__version__ = "1.3.20"
+__version__ = "1.3.23"

wizata_dsapi/wizata_dsapi_client.py

@@ -23,7 +23,7 @@ from .api_dto import ApiDto, VarType
 from .business_label import BusinessLabel
 from .plot import Plot
 from .request import Request
-from .mlmodel import MLModel
+from .mlmodel import ModelInfo, ModelList
 from .experiment import Experiment
 from .script import Script
 from .execution import Execution, ExecutionStatus
@@ -590,15 +590,6 @@ class WizataDSAPIClient(ApiInterface):
                 return obj.script_id
             else:
                 raise self.__raise_error(response)
-        if isinstance(obj, MLModel):
-            response = requests.put(self.__url() + "mlmodels/",
-                                    headers=self.__header(),
-                                    data=pickle.dumps(obj))
-            if response.status_code == 200:
-                obj.model_id = uuid.UUID(response.json()['id'])
-                return obj.model_id
-            else:
-                raise self.__raise_error(response)
         if isinstance(obj, Template):
             return self.upsert_template(obj.key, obj.name)
         if isinstance(obj, Pipeline):
@@ -847,13 +838,6 @@ class WizataDSAPIClient(ApiInterface):
                 execution.script = self.get(script_name=script)
             elif isinstance(script, Script):
                 execution.script = script
-        if ml_model is not None:
-            if isinstance(ml_model, uuid.UUID) or (isinstance(ml_model, str) and is_valid_uuid(ml_model)):
-                execution.ml_model = MLModel(ml_model)
-            elif isinstance(ml_model, str):
-                execution.ml_model = self.get(model_key=ml_model)
-            elif isinstance(ml_model, MLModel):
-                execution.ml_model = ml_model
         if image is not None:
             execution.pipeline_image_id = image
         if isAnomalyDetection:
@@ -899,9 +883,6 @@ class WizataDSAPIClient(ApiInterface):
                 if "plots" in obj.keys():
                     for plot in obj["plots"]:
                         result_execution.plots.append(self.get(Plot(plot_id=plot["id"])))
-                if "models" in obj.keys():
-                    for mlmodel in obj["models"]:
-                        result_execution.models.append(self.get(MLModel(model_id=mlmodel["id"])))
                 if "resultDataframe" in obj.keys() and obj["resultDataframe"]["id"] is not None:
                     result_execution.output_ds_dataframe = self.get(DSDataFrame(df_id=obj["resultDataframe"]["id"]))
 
@@ -1104,7 +1085,7 @@ class WizataDSAPIClient(ApiInterface):
                        scaler=None,
                        has_anomalies: bool = False,
                        has_target_feat: bool = False,
-                       experiment_key = None) -> tuple[MLModel, pandas.DataFrame]:
+                       experiment_key = None) -> tuple[ModelInfo, pandas.DataFrame]:
         """
         Register a Machine Learning model to Wizata.
         Model is tested by the API against a sample dataframe.
@@ -1124,15 +1105,13 @@ class WizataDSAPIClient(ApiInterface):
         elif df is None:
             raise ValueError('A sample dataframe must be provided')
 
-        # Create a ML Model object
-        ml_model = MLModel()
+        ml_model = ModelInfo(key=model_key)
         ml_model.trained_model = train_model
         if scaler is not None:
             ml_model.scaler = scaler
         ml_model.has_anomalies = has_anomalies
         ml_model.has_target_feat = has_target_feat
         ml_model.input_columns = df.columns
-        ml_model.key = model_key
 
         if experiment_key is not None:
             ml_model.experimentId = self.get(experiment_key=experiment_key).experiment_id
@@ -1141,7 +1120,8 @@ class WizataDSAPIClient(ApiInterface):
             result_df = predict(df, ml_model)
             if result_df is not None:
                 ml_model.status = "valid"
-                self.upsert(ml_model)
+                #TODO: proper method to upload and download from registry to modify this one
+                ## self.upsert(ml_model)
                 return ml_model, result_df
             else:
                 raise RuntimeError('no dataframe was generated by your model while testing predict capabilities')

{wizata_dsapi-1.3.20.dist-info → wizata_dsapi-1.3.23.dist-info}/METADATA

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

{wizata_dsapi-1.3.20.dist-info → wizata_dsapi-1.3.23.dist-info}/RECORD

@@ -1,5 +1,5 @@
 wizata_dsapi/__init__.py,sha256=MPTx3eqYPaHzIBrnrx27xW2xCliPLHjCYn7ar5FYefY,2040
-wizata_dsapi/api_config.py,sha256=pyGPyoCrfOFl-C6DlDRdQbQWDG2Y_oB4gvzjh2wYb8w,5300
+wizata_dsapi/api_config.py,sha256=6Pnnv62X_QrTUXaa1MtFZeQaqMUJC-9Y5BW7B4gef10,5139
 wizata_dsapi/api_dto.py,sha256=-NdaTRvw5jW5xFGpIhY8U0-SdvzW2t6QD26y0UPApU0,2238
 wizata_dsapi/api_interface.py,sha256=DURk-0ey16T8sV5e2Y2G_YybPEusJvZuY0oD5L7AnXo,10903
 wizata_dsapi/bucket.py,sha256=Zz9olv-pymikAutGitSuGWrAPiawOTW86JDDHG4ugTc,1150
@@ -9,19 +9,19 @@ wizata_dsapi/dataframe_toolkit.py,sha256=7D8JrhsFSGXeO3mRAd2e2cLmdjbXRjk04IuaMG8
 wizata_dsapi/datapoint.py,sha256=UUatqzWMwC4ucM6HdeQDWtLS4fGqEsDABCNVmxoP5Hg,14635
 wizata_dsapi/datastore.py,sha256=BSHZmCSJ679boBA1eCkaWGJCy1CUeipKKGt2jDHzdVo,2663
 wizata_dsapi/ds_dataframe.py,sha256=Sk2JRUuTRJzko3HosJnbK34STpgSJUlqxLq8w_E5VM4,2089
-wizata_dsapi/dsapi_json_encoder.py,sha256=EhY1NA3-UQJ3HFYYbe7bvXb8NuhOvHVMJvXyGvX_T3k,2772
+wizata_dsapi/dsapi_json_encoder.py,sha256=_NJE2IncJCS-juOxV_IQWHq8WpaanKe2aWpGNZNUzyk,2062
 wizata_dsapi/evaluation.py,sha256=kB61SD66uRBBbKqiES7XZERn77bwhacbyufneSD4s8c,2222
 wizata_dsapi/execution.py,sha256=JuU8qZDcUZxtCvQwwvM_luwHi18GQ2jbBSxAjc2cSlM,14148
 wizata_dsapi/experiment.py,sha256=QYQ1CJ-MTWsXq08xYbm5sAp95dRxbPOmGDgaAOoBMDQ,4631
 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=vtrMjhvnjZS-PFM9hWAzXA3c862B-qR2qEJS4UtJgo0,14289
-wizata_dsapi/model_toolkit.py,sha256=a76ckSuetSKDjEkOl7o49g9oaItdw9iOaPt0JcstmhU,1551
+wizata_dsapi/mlmodel.py,sha256=rsUmkRniFQktXZAiBejdAJQIgnChvi-J_KJJjmifrSI,15681
+wizata_dsapi/model_toolkit.py,sha256=UNyw5CFSgZeXydQFsiDIRTjoMeqIsdyIIuiwumLW5bA,1574
 wizata_dsapi/paged_query_result.py,sha256=0Iyt2Kd4tvrfthhT-tk9EmSERsbJTaPNON2euHcBn6k,1150
 wizata_dsapi/pipeline.py,sha256=WDJeOxPZJiYW1qwTNZUm3jom2epIxqrSoiUwcrTF9EE,31300
 wizata_dsapi/pipeline_deployment.py,sha256=grekBaxUK0EhL9w7lDB8vNuW_wzLnHVm9Mq8Lkbkguk,1722
-wizata_dsapi/pipeline_image.py,sha256=M3FOr45dJIAEvsmXPpMD8JZ09k5-YpW9PRYEWJqptcI,5272
+wizata_dsapi/pipeline_image.py,sha256=FUxaDDAOZHG8MA2xpZDoG7m1xbtiRSB8YuLFObUSd8c,5274
 wizata_dsapi/plot.py,sha256=SPGKFWWYNcRvHcqvvnPIIIBKsd5UwhdsxLW7b2dG2rs,2360
 wizata_dsapi/request.py,sha256=W4E1BHacQdJiBLPI96yVeHz41rbfFuGrbuw1U60L_DM,27560
 wizata_dsapi/script.py,sha256=DeEciwVpuCYZetgJCoivw_bYe8ma52WuTaTQ_VkLEcg,12930
@@ -31,10 +31,10 @@ 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=xkU7aW7cKvizjP0w8nXhUrp9VWxt6sXDqExnl-nGWGw,23
+wizata_dsapi/version.py,sha256=EGztvYCGaOWq_edANXRtYB9YDbL4jWFHJI9a0CTSz5Y,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
+wizata_dsapi/wizata_dsapi_client.py,sha256=h8iSz7IGbP-Zq9rbqMdq-hTrt16laD1JeaRWPzaLaoo,77695
 wizata_dsapi/words.py,sha256=tV8CqzCqODZCV7PgBxBF5exBxeF_ya9t5DiUy-cg6Sg,1535
 wizata_dsapi/models/__init__.py,sha256=O5PHqw8lKILw4apO-MfDxPz73wK0vADD9y3xjuzX7Tw,104
 wizata_dsapi/models/common.py,sha256=1dTqE80-mFJnUwEdNlJdhJzfZ2N5Kp8Nb3LQ8uwPtLc,3808
@@ -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.20.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-wizata_dsapi-1.3.20.dist-info/METADATA,sha256=AlxEUFMhHXabL0a22dsV8VSxOStL2KwigOTGdIIcKr0,5651
-wizata_dsapi-1.3.20.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wizata_dsapi-1.3.20.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
-wizata_dsapi-1.3.20.dist-info/RECORD,,
+wizata_dsapi-1.3.23.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+wizata_dsapi-1.3.23.dist-info/METADATA,sha256=s72ozfS_1A5XMtwD2-aeYcGdsPAwaluPyME2GP7s7P8,5651
+wizata_dsapi-1.3.23.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wizata_dsapi-1.3.23.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
+wizata_dsapi-1.3.23.dist-info/RECORD,,