wizata-dsapi 1.3.42__py3-none-any.whl → 1.3.44__py3-none-any.whl

wizata_dsapi/api_config.py

@@ -76,6 +76,12 @@ _registry = {
             "cloud_dsapi": ['lists', 'get_by_id', 'create', 'update', 'delete', 'search'],
             "cloud_context": ['get_by_id', 'create', 'update', 'delete', 'search']
         },
+    "models":
+        {
+            "class": ModelInfo,
+            "cloud_dsapi": ['download_model', 'download_file' , 'upload_model'  , 'upload_file'],
+            "cloud_context": ['download_model' , 'download_file' , 'upload_model'  , 'upload_file']
+        },
     "pipelines":
         {
             "class": Pipeline,

wizata_dsapi/api_interface.py

@@ -2,6 +2,7 @@ import uuid
 from .solution_component import SolutionComponent
 from .paged_query_result import PagedQueryResult
 from .pipeline import AlertType
+from .mlmodel import ModelInfo, ModelFile
 from datetime import datetime
 import pandas
 
@@ -276,3 +277,58 @@ class ApiInterface:
         :param list cc: for email only - cc recipients list.
         """
         pass
+
+    def download_model(self, identifier: str) -> ModelInfo:
+        """
+        download a model image directly from the repository, auto-select alias if necessary.
+        :param identifier: exact identifier including alias of the model or no alias to auto-select active version.
+        :return: ModelInfo with trained_model loaded, extra file must be downloaded separately.
+        """
+        pass
+
+    def download_file(self,
+                      model: ModelInfo = None,
+                      file: ModelFile = None,
+                      identifier: str = None,
+                      path: str = None):
+        """
+        download a model extra file from the repository.
+        :param model: model (ModelInfo), alternatively can use identifier
+        :param file: file (ModelFile), alternatively can use path
+        :param identifier: identifier including alias of the model.
+        :param path: path name of the file including the extension.
+        :return: bytes content.
+        """
+        pass
+
+    def upload_file(self,
+                    content,
+                    model: ModelInfo = None,
+                    file: ModelFile = None,
+                    identifier: str = None,
+                    path: str = None
+                    ):
+        """
+        upload a model extra file to the repository.
+        please use upload_model for a trained_model
+        :param content: the bytes content of the file.
+        :param model: model (ModelInfo), alternatively can use identifier
+        :param file: file (ModelFile), alternatively can use path
+        :param identifier: identifier including alias of the model.
+        :param path: path name of the file including the extension.
+        :return: bytes content.
+        """
+        pass
+
+    def upload_model(self,
+                     model_info: ModelInfo,
+                     bytes_content=None):
+        """
+        upload a model within the model repository.
+            - by default use model_info.trained_model and convert it to a pickle
+            - for already torch or pickle please pass the bytes_content
+            - model_info.file_format must be set properly to 'pkl' or 'pt'
+        :param model_info: model info, with at least key (+twin, +property, +alias) and trained_model.
+        :param bytes_content: bytes[] of your torch or pickle model.
+        """
+        pass

wizata_dsapi/context.py

@@ -1,7 +1,11 @@
 import uuid
 import pandas
+import numpy as np
+import io
+import json
+import pickle
 
-from .mlmodel import ModelInfo
+from .mlmodel import ModelInfo, ModelFile
 from .plot import Plot
 from .ilogger import ILogger
 from .api_interface import ApiInterface
@@ -188,22 +192,40 @@ class Context(ILogger):
         if self.__new_plot is not None:
             return self.__new_plot.figure
 
-    def set_model(self, trained_model, input_columns, output_columns=None, has_anomalies=False, scaler=None):
+    def set_model(self,
+                  trained_model,
+                  **kwargs):
         """
         set model to be added to the context.
         :param trained_model: Trained Model to be stored as a pickled object.
-        :param list input_columns: List of str defining input columns to call the model (df.columns)
-        :param list output_columns: List of output columns - Optional as can be detected automatically during validation.
-        :param bool has_anomalies: False by default, define if the model set anomalies
-        :param scaler: Scaler to be stored if necessary.
-        :return: ML Model object prepared.
+        :param scaler: Scaler extra file to be stored.
+        :return: ModelInfo object
         """
         model_info = ModelInfo(key="undefined")
         model_info.trained_model = trained_model
+
+        scaler = kwargs.pop("scaler", None)
         model_info.scaler = scaler
-        model_info.input_columns = input_columns
-        model_info.output_columns = output_columns
-        model_info.has_anomalies = has_anomalies
+
+        for key, value in kwargs.items():
+
+            if isinstance(value, (pandas.Index, pandas.Series, np.ndarray)):
+                content = json.dumps(value.tolist()).encode('utf-8')
+                filename = f"{key}.json"
+            elif isinstance(value, (dict, list)):
+                content = json.dumps(value).encode('utf-8')
+                filename = f"{key}.json"
+            else:
+                content = pickle.dumps(value)
+                filename = f"{key}.pkl"
+
+            model_info.add_file(
+                file=ModelFile(
+                    content=io.BytesIO(content),
+                    path=filename
+                )
+            )
+
         self.__new_model = model_info
         return model_info
 

wizata_dsapi/mlmodel.py

@@ -122,7 +122,7 @@ class ModelInfo:
     """
 
     def __init__(self,
-                 key: str,
+                 key: str = None,
                  twin_hardware_id: str = None,
                  property_value: str = None,
                  alias: str = None,

wizata_dsapi/version.py

@@ -1 +1 @@
-__version__ = "1.3.42"
+__version__ = "1.3.44"

wizata_dsapi/wizata_dsapi_client.py

@@ -13,6 +13,7 @@ import plotly
 import msal
 import os
 import types
+
 import wizata_dsapi
 import urllib.parse
 import base64
@@ -26,7 +27,7 @@ from .api_dto import ApiDto, VarType, ApiDtoInterface
 from .business_label import BusinessLabel
 from .plot import Plot
 from .request import Request
-from .mlmodel import ModelInfo, ModelList
+from .mlmodel import ModelInfo, ModelList, ModelFile
 from .experiment import Experiment
 from .script import Script
 from .execution import Execution, ExecutionStatus
@@ -1936,6 +1937,100 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         image = PipelineImage.loads(pipeline_image_id=pipeline_image_id, g_bytes=response_bytes)
         return image
 
+    def download_model(self, identifier: str) -> ModelInfo:
+        """
+        download a model image directly from the repository, auto-select alias if necessary.
+        :param identifier: exact identifier including alias of the model or no alias to auto-select active version.
+        :return: ModelInfo with trained_model loaded, extra file must be downloaded separately.
+        """
+        response = requests.get(self.__url() + f"models/{identifier}/",
+                                headers=self.__header())
+        if response.status_code == 200:
+            model_info = ModelInfo()
+            model_info.from_json(response.json())
+            self.load_model(model_info)
+            return model_info
+        else:
+            self.__raise_error(response)
+
+
+    def download_file(self,
+                      model: ModelInfo = None,
+                      file: ModelFile = None,
+                      identifier: str = None,
+                      path: str = None):
+        """
+        download a model extra file from the repository.
+        :param model: model (ModelInfo), alternatively can use identifier
+        :param file: file (ModelFile), alternatively can use path
+        :param identifier: identifier including alias of the model.
+        :param path: path name of the file including the extension.
+        :return: bytes content.
+        """
+
+        if model is None and identifier is None:
+            raise TypeError('model or identifier must be provided')
+
+        if file is None and path is None:
+            raise TypeError('file or path must be provided')
+
+        if identifier is None:
+            identifier = model.identifier(include_alias=True)
+
+        if path is None:
+            path = file.path
+
+        response = requests.get(self.__url() + f"models/{identifier}/files/{path}/",
+                                headers=self.__header())
+        if response.status_code == 200:
+            return response.content
+        else:
+            self.__raise_error(response)
+
+
+    def upload_file(self,
+                    content,
+                    model: ModelInfo = None,
+                    file: ModelFile = None,
+                    identifier: str = None,
+                    path: str = None
+                    ):
+        """
+        upload a model extra file to the repository.
+        please use upload_model for a trained_model
+        :param content: the bytes content of the file.
+        :param model: model (ModelInfo), alternatively can use identifier
+        :param file: file (ModelFile), alternatively can use path
+        :param identifier: identifier including alias of the model.
+        :param path: path name of the file including the extension.
+        :return: bytes content.
+        """
+        if path == "trained_model.pkl" or path == "trained_model.pt" or path == "_metadata.json":
+            raise RuntimeError("upload_file cannot be used to upload reserved metadata or the primary trained model")
+
+        if model is None and identifier is None:
+            raise TypeError('model or identifier must be provided')
+
+        if file is None and path is None:
+            raise TypeError('file or path must be provided')
+
+        if identifier is None:
+            identifier = model.identifier(include_alias=True)
+
+        if path is None:
+            path = file.path
+
+        headers = self.__header()
+        headers["Content-Type"] = "application/octet-stream"
+        response = requests.post(self.__url() + f"models/{identifier}/files/{path}",
+                                 headers=headers,
+                                 data=content,
+                                 timeout=60)
+        if response.status_code != 200 and response.status_code != 201:
+            return
+        else:
+            self.__raise_error(response)
+
     def load_model(self, model):
         """
         load a model pickle or torch from the repository ready to be used.

{wizata_dsapi-1.3.42.dist-info → wizata_dsapi-1.3.44.dist-info}/METADATA

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

{wizata_dsapi-1.3.42.dist-info → wizata_dsapi-1.3.44.dist-info}/RECORD

@@ -1,10 +1,10 @@
 wizata_dsapi/__init__.py,sha256=aVeizk2zzmAX0TLNG9o7vcmG8KB73XiXw1_qozrJN2w,2072
-wizata_dsapi/api_config.py,sha256=6Pnnv62X_QrTUXaa1MtFZeQaqMUJC-9Y5BW7B4gef10,5139
+wizata_dsapi/api_config.py,sha256=lrjUOKnGBYgjSqvXdTf4gEcf-luTSV6DPdo3AbmIExU,5404
 wizata_dsapi/api_dto.py,sha256=zyzj6-Kcxi59vVAvThfsuq7RLUE2O_FZ3TJ5LpKYPbE,2310
-wizata_dsapi/api_interface.py,sha256=DURk-0ey16T8sV5e2Y2G_YybPEusJvZuY0oD5L7AnXo,10903
+wizata_dsapi/api_interface.py,sha256=ju3Wz1e2uOS1_SrSihc0AECkWLRNNGHMhpMhV2L6tjo,13315
 wizata_dsapi/bucket.py,sha256=Zz9olv-pymikAutGitSuGWrAPiawOTW86JDDHG4ugTc,1150
 wizata_dsapi/business_label.py,sha256=u0TVfUNfoR9qSv8lzpf6rNjlg3G9xTiz6itefcKfeak,4151
-wizata_dsapi/context.py,sha256=NNc9YYkfuchy2nFouVccaoKi6VAxhgLAH-eaRWxNsaQ,11643
+wizata_dsapi/context.py,sha256=U546V_Lf5JXuQMm3_A9bFTJ0xV3hpND2PYVT5sJ7SIA,11928
 wizata_dsapi/dataframe_toolkit.py,sha256=7D8JrhsFSGXeO3mRAd2e2cLmdjbXRjk04IuaMG8F974,9078
 wizata_dsapi/datapoint.py,sha256=UUatqzWMwC4ucM6HdeQDWtLS4fGqEsDABCNVmxoP5Hg,14635
 wizata_dsapi/datastore.py,sha256=BSHZmCSJ679boBA1eCkaWGJCy1CUeipKKGt2jDHzdVo,2663
@@ -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=Bdx4bZdrvcR4IZyVH1_yDtU94qe4M8LOFK7I0QqdknQ,24541
+wizata_dsapi/mlmodel.py,sha256=m-mVF-o632nbs_IJ2H73KM2hfcRwnUGFmPt5oVrU8Ws,24548
 wizata_dsapi/model_toolkit.py,sha256=UNyw5CFSgZeXydQFsiDIRTjoMeqIsdyIIuiwumLW5bA,1574
 wizata_dsapi/paged_query_result.py,sha256=0Iyt2Kd4tvrfthhT-tk9EmSERsbJTaPNON2euHcBn6k,1150
 wizata_dsapi/pipeline.py,sha256=CtB6-HwJ2OtqUIbwAVTcawLmvYfudgIwGiPZARwTobM,31778
@@ -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=oDD-gNOpF2G3g0V7E6KiCHvmVS1vd65OXRkXno_Seug,23
+wizata_dsapi/version.py,sha256=yfbEU3o2fygwnHirL_qJkT1waQWT3nPKCejVacR9wrU,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=FbEmlKDDQPCqe1rDfpAvXBWfkVXcnbtKeI592D39ucw,80570
+wizata_dsapi/wizata_dsapi_client.py,sha256=KycD4Rv2yoqCx7kugTUfw_4Z064TYTUvEfyKjzkQOjc,84395
 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.42.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-wizata_dsapi-1.3.42.dist-info/METADATA,sha256=BSG1K5kI-ImyB0u_ScxiCvw_PhNQ7Ex-hmDFiwKaMZ8,5651
-wizata_dsapi-1.3.42.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wizata_dsapi-1.3.42.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
-wizata_dsapi-1.3.42.dist-info/RECORD,,
+wizata_dsapi-1.3.44.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+wizata_dsapi-1.3.44.dist-info/METADATA,sha256=i_n4AhQNWvPwDhReZHuOrcZJQRbjVDA8UNWmarv2JNU,5651
+wizata_dsapi-1.3.44.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wizata_dsapi-1.3.44.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
+wizata_dsapi-1.3.44.dist-info/RECORD,,