xplainable-client 1.2.1.post3__tar.gz → 1.2.2__tar.gz

xplainable_client-1.2.2/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.1
+Name: xplainable-client
+Version: 1.2.2
+Summary: The client for persisting and deploying models to Xplainable cloud.
+Author-email: xplainable pty ltd <contact@xplainable.io>
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: ipywidgets==8.0.6
+Requires-Dist: numpy>=1.20.3
+Requires-Dist: pandas<=1.9.0,>=1.5.2
+Requires-Dist: pyperclip==1.8.2
+Requires-Dist: Requests==2.31.0
+Requires-Dist: scikit_learn
+Requires-Dist: setuptools
+Requires-Dist: urllib3==2.2.0
+Requires-Dist: xplainable
+
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/xplainable/xplainable/main/docs/assets/logo/xplainable-logo.png">
+<h1 align="center">xplainable</h1>
+<h3 align="center">Real-time explainable machine learning for business optimisation</h3>
+    
+**Xplainable** makes tabular machine learning transparent, fair, and actionable.
+</div>
+
+## Why Was Xplainable Created?
+In machine learning, there has long been a trade-off between accuracy and explainability. This drawback has led to the creation of explainable ML libraries such as [Shap](https://github.com/slundberg/shap) and [Lime](https://github.com/marcotcr/lime) which make estimations of model decision processes. These can be incredibly time-expensive and often present steep learning curves making them challenging to implement effectively in production environments.
+
+To solve this problem, we created `xplainable`. **xplainable** presents a suite of novel machine learning algorithms specifically designed to match the performance of popular black box models like [XGBoost](https://github.com/dmlc/xgboost) and [LightGBM](https://github.com/microsoft/LightGBM) while providing complete transparency, all in real-time.
+
+
+## Xplainable Cloud
+This Python package is free and open-source. To add more value to data teams within organisations, we also created Xplainable Cloud that brings your models to a collaborative environment.
+
+### Preprocessing with Xplainable Cloud
+Before modeling, it's essential to preprocess your data. Xplainable Cloud facilitates this process by allowing you to create and manage preprocessors in the cloud.
+
+
+```python
+import xplainable as xp
+import os
+from xplainable_client import Client
+
+#Initialising the client
+XClient = Client(api_key=os.environ['XP_API_KEY'])
+
+#Creating a Preprocessor ID
+preprocessor_id = XClient.create_preprocessor_id(
+    preprocessor_name="Preprocessor Name",
+    preprocessor_description="Preprocessor Description",
+)
+
+#Creating a Preprocessor Version
+preprocessor_version = XClient.create_preprocessor_version(
+    preprocessor_id, #preprocessor_id,
+    pipeline, # <-- Pass the pipeline
+    df # <-- Pass the raw dataframe
+)
+
+#Loading the Preprocessor Client
+pp_cloud = XClient.load_preprocessor(
+    preprocessor_id,
+    preprocessor_version["version_id"],
+    gui_object=False # Set to true to load the GUI object, keep as False for pipeline
+    )
+```
+
+### Modelling with Xplainable Cloud
+
+After preprocessing, the next step is to create and train your model. Xplainable Cloud supports model versioning and ID creation to streamline this process.
+
+```python
+
+#Creating a Model Id
+model_id = XClient.create_model_id(
+    model,
+    model_name="Model Name",
+    model_description='Model Description'
+)
+
+#Creating a Model Version
+version_id = XClient.create_model_version(
+    model,
+    model_id,
+    X_train,
+    y_train
+)
+
+```
+
+### Deployments with Xplainable Cloud
+Once your model is ready, deploying it is straightforward with Xplainable Cloud. You can deploy, activate, and manage API keys for your model deployment keys within your IDE or environment.
+
+```python 
+#Creating a Model Deployment
+deployment = XClient.deploy(
+    hostname="https://inference.xplainable.io", 
+    model_id=model_id, 
+    version_id=version_id 
+)
+
+#Activating the Deployment
+XClient.activate_deployment(deployment['deployment_id'])
+
+#Generating an API Key
+deploy_key = XClient.generate_deploy_key(
+    'API Key Name', 
+    deployment['deployment_id'], 
+    7 #-> Days until expiration
+    )
+
+#Hitting the endpoint
+response = requests.post(
+    url="https://inference.xplainable.io/v1/predict",
+    headers={'api_key': deploy_key['deploy_key']},
+    json=body
+)
+
+#Obtaining the value response
+value = response.json()
+```
+
+<div align="center">
+<br></br>
+<br></br>
+Thanks for trying xplainable!
+<br></br>
+<strong>Made with ❤️ in Australia</strong>
+<br></br>
+<hr>
+&copy; copyright xplainable pty ltd
+</div>
+
+

xplainable_client-1.2.2/README.md

@@ -0,0 +1,118 @@
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/xplainable/xplainable/main/docs/assets/logo/xplainable-logo.png">
+<h1 align="center">xplainable</h1>
+<h3 align="center">Real-time explainable machine learning for business optimisation</h3>
+    
+**Xplainable** makes tabular machine learning transparent, fair, and actionable.
+</div>
+
+## Why Was Xplainable Created?
+In machine learning, there has long been a trade-off between accuracy and explainability. This drawback has led to the creation of explainable ML libraries such as [Shap](https://github.com/slundberg/shap) and [Lime](https://github.com/marcotcr/lime) which make estimations of model decision processes. These can be incredibly time-expensive and often present steep learning curves making them challenging to implement effectively in production environments.
+
+To solve this problem, we created `xplainable`. **xplainable** presents a suite of novel machine learning algorithms specifically designed to match the performance of popular black box models like [XGBoost](https://github.com/dmlc/xgboost) and [LightGBM](https://github.com/microsoft/LightGBM) while providing complete transparency, all in real-time.
+
+
+## Xplainable Cloud
+This Python package is free and open-source. To add more value to data teams within organisations, we also created Xplainable Cloud that brings your models to a collaborative environment.
+
+### Preprocessing with Xplainable Cloud
+Before modeling, it's essential to preprocess your data. Xplainable Cloud facilitates this process by allowing you to create and manage preprocessors in the cloud.
+
+
+```python
+import xplainable as xp
+import os
+from xplainable_client import Client
+
+#Initialising the client
+XClient = Client(api_key=os.environ['XP_API_KEY'])
+
+#Creating a Preprocessor ID
+preprocessor_id = XClient.create_preprocessor_id(
+    preprocessor_name="Preprocessor Name",
+    preprocessor_description="Preprocessor Description",
+)
+
+#Creating a Preprocessor Version
+preprocessor_version = XClient.create_preprocessor_version(
+    preprocessor_id, #preprocessor_id,
+    pipeline, # <-- Pass the pipeline
+    df # <-- Pass the raw dataframe
+)
+
+#Loading the Preprocessor Client
+pp_cloud = XClient.load_preprocessor(
+    preprocessor_id,
+    preprocessor_version["version_id"],
+    gui_object=False # Set to true to load the GUI object, keep as False for pipeline
+    )
+```
+
+### Modelling with Xplainable Cloud
+
+After preprocessing, the next step is to create and train your model. Xplainable Cloud supports model versioning and ID creation to streamline this process.
+
+```python
+
+#Creating a Model Id
+model_id = XClient.create_model_id(
+    model,
+    model_name="Model Name",
+    model_description='Model Description'
+)
+
+#Creating a Model Version
+version_id = XClient.create_model_version(
+    model,
+    model_id,
+    X_train,
+    y_train
+)
+
+```
+
+### Deployments with Xplainable Cloud
+Once your model is ready, deploying it is straightforward with Xplainable Cloud. You can deploy, activate, and manage API keys for your model deployment keys within your IDE or environment.
+
+```python 
+#Creating a Model Deployment
+deployment = XClient.deploy(
+    hostname="https://inference.xplainable.io", 
+    model_id=model_id, 
+    version_id=version_id 
+)
+
+#Activating the Deployment
+XClient.activate_deployment(deployment['deployment_id'])
+
+#Generating an API Key
+deploy_key = XClient.generate_deploy_key(
+    'API Key Name', 
+    deployment['deployment_id'], 
+    7 #-> Days until expiration
+    )
+
+#Hitting the endpoint
+response = requests.post(
+    url="https://inference.xplainable.io/v1/predict",
+    headers={'api_key': deploy_key['deploy_key']},
+    json=body
+)
+
+#Obtaining the value response
+value = response.json()
+```
+
+<div align="center">
+<br></br>
+<br></br>
+Thanks for trying xplainable!
+<br></br>
+<strong>Made with ❤️ in Australia</strong>
+<br></br>
+<hr>
+&copy; copyright xplainable pty ltd
+</div>
+
+

{xplainable-client-1.2.1.post3 → xplainable_client-1.2.2}/pyproject.toml

@@ -7,7 +7,7 @@ find = {}
 
 [project]
 name = "xplainable-client"
-version = "1.2.1-3"
+version = "1.2.2"
 authors = [
   { name="xplainable pty ltd", email="contact@xplainable.io" },
 ]
@@ -26,12 +26,12 @@ classifiers = [
 
 dependencies = [
 "ipywidgets==8.0.6",
-"numpy==1.21.1",
+"numpy>=1.20.3",
 "pandas>=1.5.2,<=1.9.0",
 "pyperclip==1.8.2",
 "Requests==2.31.0",
 "scikit_learn",
 "setuptools",
 "urllib3==2.2.0",
-"xplainable==1.2.1"
+"xplainable"
 ]

xplainable_client-1.2.2/xplainable_client/client/__init__.py

@@ -0,0 +1,33 @@
+from .datasets import *
+from functools import cached_property
+
+from ._models import *
+from ._misc import *
+from requests.packages.urllib3.util.retry import Retry
+from ._session import Session
+from ._misc import Misc
+from ._models import Models
+from ._preprocessing import Preprocessing
+from ._deployments import Deployments
+from ._gpt import GPT
+from ._collections import Collections
+from ._datasets import Datasets
+from ._inference import Inference
+
+
+class Client(Misc, Models, Preprocessing, GPT, Collections):
+
+    def __init__(self, api_key=None, hostname='https://api.xplainable.io', silent_mode=False):
+        self.session = Session(api_key=api_key, hostname=hostname, silent_mode=silent_mode)
+        Misc.__init__(self, self.session)
+        Models.__init__(self, self.session)
+        Preprocessing.__init__(self, self.session)
+        Deployments.__init__(self, self.session)
+        GPT.__init__(self, self.session)
+        Collections.__init__(self, self.session)
+        Datasets.__init__(self, self.session)
+        Inference.__init__(self, self.session)
+        
+
+
+

xplainable_client-1.2.2/xplainable_client/client/_client_cog_base.py

@@ -0,0 +1,7 @@
+from ._session import Session
+
+
+class Client_Cog:
+
+    def __init__(self, session: Session):
+        self.session = session

xplainable_client-1.2.2/xplainable_client/client/_collections.py

@@ -0,0 +1,213 @@
+from ._client_cog_base import *
+from ._models import Models
+
+
+class Collections(Client_Cog):
+
+    def create_collection(self, model_id: str, name: str, description: str):
+        """ Creates a new collection.
+        Args:
+            model_id (str): The model id.
+            name (str): The name of the collection.
+            description (str): The description of the collection.
+        Returns:
+            int: The id of the collection created.
+        """
+        payload = {
+            "name": name,
+            "description": description
+        }
+        
+        response = self.session._session.put(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/create-collection",
+            json=payload
+            )
+        data = self.session.get_response_content(response)
+        return data
+    
+    
+    def get_model_collections(self, model_id: str):
+        """ Gets all collections of a model.
+        Args:
+            model_id (str): The model id.
+        Returns:
+            dict: Dictionary of collections.
+        """
+        response = self.session._session.get(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections"
+            )
+        data = self.session.get_response_content(response)
+        return data
+    
+    def get_team_collections(self):
+        """ Gets all collections of a team.
+        Returns:
+            dict: Dictionary of collections.
+        """
+        response = self.session._session.get(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/collections"
+            )
+        data = self.session.get_response_content(response)
+        return data
+    
+
+    def edit_collection_name(self, model_id: str, collections_id: str, name: str):
+        """ Edits the name of a collection.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+            name (str): The new name of the collection.
+        Returns:
+            json: A json payload.
+        """
+        payload = {
+            "name": name
+        }
+
+        response = self.session._session.patch(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collections_id}/name",
+            json=payload
+            )
+        return response
+    
+
+    def edit_collection_description(self, model_id: str, collections_id: str, description: str):
+        """ Edits the description of a collection.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+            description (str): The new description of the collection.
+        Returns:
+            json: A json payload.
+        """
+        payload = {
+            "description": description
+        }
+
+        response = self.session._session.patch(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collections_id}/description",
+            json=payload
+            )
+        return response
+    
+
+    def delete_collection(self, model_id: str, collections_id: str):
+        """ Deletes a collection.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+        Returns:
+            json: A json payload.
+        """
+        response = self.session._session.delete(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collections_id}"
+            )
+        return response
+    
+
+    def delete_model_collections(self, model_id: str):
+        """ Deletes all collections of a model.
+        Args:
+            model_id (str): The model id.
+        Returns:
+            json: A json payload.
+        """
+        response = self.session._session.delete(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections"
+            )
+        return response
+    
+    
+    def restore_collection(self, model_id: str, collection_id: str):
+        """ Restores a collection.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+        Returns:
+            json: A json payload.
+        """
+        response = self.session._session.patch(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collection_id}/restore"
+            )
+        return response
+    
+
+    def get_collection(self, model_id: str, collection_id: str):
+        """ Gets a collection.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+        Returns:
+            dict: Dictionary of collection.
+        """
+        response = self.session._session.get(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collection_id}"
+            )
+        data = self.session.get_response_content(response)
+        return data
+    
+
+    #TODO: Implement.
+    # def add_scenario(self, model_id: str, version_id: str, collection_id: str):
+    #     try:
+    #         response = self.session._session.get(
+    #             url=f'{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/versions/{version_id}'
+    #         )
+    #         return self.session.get_response_content(response)
+    #     except Exception as e:
+    #         raise ValueError(f'Model with ID {model_id}:{version_id} does not exist')
+    #     return
+
+    # add_scenario
+
+
+    def edit_scenario_notes(self, model_id: str, collection_id: str, scenario_id: str, notes: str):
+        """ Edits the notes of a scenario.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+            scenario_id (str): The scenario id.
+            notes (str): The new notes of the scenario.
+        Returns:
+            json: A json payload.
+        """
+        payload = {
+            "notes": notes
+        }
+
+        response = self.session._session.patch(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collection_id}/scenarios/{scenario_id}/notes",
+            json=payload
+            )
+        return response
+    
+
+    def delete_scenario(self, model_id: str, collection_id: str, scenario_id: str):
+        """" Deletes a scenario.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+            scenario_id (str): The scenario id.
+        Returns:
+            json: A json payload.
+        """
+
+        response = self.session._session.delete(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collection_id}/scenarios/{scenario_id}"
+            )
+        return response
+    
+
+    def restore_scenario(self, model_id: str, collection_id: str, scenario_id: str):
+        """ Restores a scenario.
+        Args:
+            model_id (str): The model id.
+            collections_id (str): The collection id.
+            scenario_id (str): The scenario id.
+        Returns:
+            json: A json payload.
+        """
+        response = self.session._session.patch(
+            url=f"{self.session.hostname}/v1/{self.session.__ext}/models/{model_id}/collections/{collection_id}/scenarios/{scenario_id}/restore"
+            )
+        return response

xplainable_client-1.2.2/xplainable_client/client/_datasets.py

@@ -0,0 +1,51 @@
+from ._client_cog_base import *
+
+import requests
+import pandas as pd
+
+
+class Datasets(Client_Cog):
+
+    # upload_dataset
+
+    def list_datasets(self):
+
+        response = requests.get('https://api.xplainable.io/v1/public-datasets')
+        
+        if response.status_code != 200:
+            raise ValueError(f'Unable to list datasets. Check your connection and try again.')
+        
+        return response.json()
+
+    def _get_url_path(self, name):
+        _base = 'xplainablepublic'
+        _type = 'blob.core.windows.net'
+        _loc = 'asset-repository/datasets'
+
+        return f'https://{_base}.{_type}/{_loc}/{name}/data.csv'
+
+    def load_dataset(self, name):
+
+        datasets = self.list_datasets()
+
+        if name not in datasets:
+            raise ValueError(f'{name} is not available. Run xp.list_datasets() to see available datasets.')
+        
+        try:
+            url = self._get_url_path(name)
+            df = pd.read_csv(url)
+
+            return df
+        
+        except Exception as e:
+            raise ValueError(f'Unable to load dataset {name}. Check your connection and try again.')
+        
+    # update_dataset
+
+    # detele_dataset
+
+    # list_dataset_children
+
+    # preview_dataset
+
+    # list_pub_datasets