opengradient 0.4.7__py3-none-any.whl → 0.4.8__py3-none-any.whl

opengradient/__init__.py

@@ -17,6 +17,8 @@ from .types import (
     LlmInferenceMode,
     TextGenerationOutput,
     ModelOutput,
+    ModelRepository,
+    FileUploadResult,
 )
 
 from . import llm, alphasense
@@ -61,7 +63,7 @@ def init(email: str, password: str, private_key: str, rpc_url=DEFAULT_RPC_URL, c
     return _client
 
 
-def upload(model_path, model_name, version):
+def upload(model_path, model_name, version) -> FileUploadResult:
     """Upload a model file to OpenGradient.
 
     Args:
@@ -70,7 +72,7 @@ def upload(model_path, model_name, version):
         version: Version string for this model upload
 
     Returns:
-        dict: Upload response containing file metadata
+        FileUploadResult: Upload response containing file metadata
 
     Raises:
         RuntimeError: If SDK is not initialized
@@ -80,7 +82,7 @@ def upload(model_path, model_name, version):
     return _client.upload(model_path, model_name, version)
 
 
-def create_model(model_name: str, model_desc: str, model_path: Optional[str] = None):
+def create_model(model_name: str, model_desc: str, model_path: Optional[str] = None) -> ModelRepository:
     """Create a new model repository.
 
     Args:
@@ -89,7 +91,7 @@ def create_model(model_name: str, model_desc: str, model_path: Optional[str] = N
         model_path: Optional path to model file to upload immediately
 
     Returns:
-        dict: Creation response with model metadata and optional upload results
+        ModelRepository: Creation response with model metadata and optional upload results
 
     Raises:
         RuntimeError: If SDK is not initialized
@@ -319,7 +321,7 @@ def run_workflow(contract_address: str) -> ModelOutput:
     return _client.run_workflow(contract_address)
 
 
-def read_workflow_history(contract_address: str, num_results: int) -> List[Dict]:
+def read_workflow_history(contract_address: str, num_results: int) -> List[ModelOutput]:
     """
     Gets historical inference results from a workflow contract.
 

opengradient/client.py

@@ -13,7 +13,6 @@ from web3 import Web3
 from web3.exceptions import ContractLogicError
 from web3.logs import DISCARD
 
-from . import utils
 from .exceptions import OpenGradientError
 from .proto import infer_pb2, infer_pb2_grpc
 from .types import (
@@ -26,8 +25,11 @@ from .types import (
     TextGenerationOutput,
     SchedulerParams,
     InferenceResult,
+    ModelRepository,
+    FileUploadResult,
 )
 from .defaults import DEFAULT_IMAGE_GEN_HOST, DEFAULT_IMAGE_GEN_PORT, DEFAULT_SCHEDULER_ADDRESS
+from .utils import convert_array_to_model_output, convert_to_model_input, convert_to_model_output
 
 _FIREBASE_CONFIG = {
     "apiKey": "AIzaSyDUVckVtfl-hiteBzPopy1pDD8Uvfncs7w",
@@ -53,7 +55,7 @@ class Client:
     _blockchain: Web3
     _wallet_account: LocalAccount
 
-    _hub_user: Dict
+    _hub_user: Optional[Dict]
     _inference_abi: Dict
 
     def __init__(self, private_key: str, rpc_url: str, contract_address: str, email: Optional[str], password: Optional[str]):
@@ -88,7 +90,7 @@ class Client:
             logging.error(f"Authentication failed: {str(e)}")
             raise
 
-    def create_model(self, model_name: str, model_desc: str, version: str = "1.00") -> dict:
+    def create_model(self, model_name: str, model_desc: str, version: str = "1.00") -> ModelRepository:
         """
         Create a new model with the given model_name and model_desc, and a specified version.
 
@@ -111,39 +113,22 @@ class Client:
         payload = {"name": model_name, "description": model_desc}
 
         try:
-            logging.debug(f"Create Model URL: {url}")
-            logging.debug(f"Headers: {headers}")
-            logging.debug(f"Payload: {payload}")
-
             response = requests.post(url, json=payload, headers=headers)
             response.raise_for_status()
+        except requests.HTTPError as e:
+            error_details = f"HTTP {e.response.status_code}: {e.response.text}"
+            raise OpenGradientError(f"Model creation failed: {error_details}") from e
 
-            json_response = response.json()
-            model_name = json_response.get("name")
-            if not model_name:
-                raise Exception(f"Model creation response missing 'name'. Full response: {json_response}")
-            logging.info(f"Model creation successful. Model name: {model_name}")
+        json_response = response.json()
+        model_name = json_response.get("name")
+        if not model_name:
+            raise Exception(f"Model creation response missing 'name'. Full response: {json_response}")
 
-            # Create the specified version for the newly created model
-            try:
-                version_response = self.create_version(model_name, version)
-                logging.info(f"Version creation successful. Version string: {version_response['versionString']}")
-            except Exception as ve:
-                logging.error(f"Version creation failed, but model was created. Error: {str(ve)}")
-                return {"name": model_name, "versionString": None, "version_error": str(ve)}
+        # Create the specified version for the newly created model
+        version_response = self.create_version(model_name, version)
 
-            return {"name": model_name, "versionString": version_response["versionString"]}
+        return ModelRepository(model_name, version_response["versionString"])
 
-        except requests.RequestException as e:
-            logging.error(f"Model creation failed: {str(e)}")
-            if hasattr(e, "response") and e.response is not None:
-                logging.error(f"Response status code: {e.response.status_code}")
-                logging.error(f"Response headers: {e.response.headers}")
-                logging.error(f"Response content: {e.response.text}")
-            raise Exception(f"Model creation failed: {str(e)}")
-        except Exception as e:
-            logging.error(f"Unexpected error during model creation: {str(e)}")
-            raise
 
     def create_version(self, model_name: str, notes: str = "", is_major: bool = False) -> dict:
         """
@@ -204,7 +189,7 @@ class Client:
             logging.error(f"Unexpected error during version creation: {str(e)}")
             raise
 
-    def upload(self, model_path: str, model_name: str, version: str) -> dict:
+    def upload(self, model_path: str, model_name: str, version: str) -> FileUploadResult:
         """
         Upload a model file to the server.
 
@@ -259,12 +244,9 @@ class Client:
                 if response.status_code == 201:
                     if response.content and response.content != b"null":
                         json_response = response.json()
-                        logging.info(f"JSON response: {json_response}")  # Log the parsed JSON response
-                        logging.info(f"Upload successful. CID: {json_response.get('ipfsCid', 'N/A')}")
-                        result = {"model_cid": json_response.get("ipfsCid"), "size": json_response.get("size")}
+                        return FileUploadResult(json_response.get("ipfsCid"), json_response.get("size"))
                     else:
-                        logging.warning("Empty or null response content received. Assuming upload was successful.")
-                        result = {"model_cid": None, "size": None}
+                        raise RuntimeError("Empty or null response content received. Assuming upload was successful.")
                 elif response.status_code == 500:
                     error_message = "Internal server error occurred. Please try again later or contact support."
                     logging.error(error_message)
@@ -274,8 +256,6 @@ class Client:
                     logging.error(f"Upload failed with status code {response.status_code}: {error_message}")
                     raise OpenGradientError(f"Upload failed: {error_message}", status_code=response.status_code)
 
-                return result
-
         except requests.RequestException as e:
             logging.error(f"Request exception during upload: {str(e)}")
             if hasattr(e, "response") and e.response is not None:
@@ -313,7 +293,7 @@ class Client:
             contract = self._blockchain.eth.contract(address=self._inference_hub_contract_address, abi=self._inference_abi)
 
             inference_mode_uint8 = inference_mode.value
-            converted_model_input = utils.convert_to_model_input(model_input)
+            converted_model_input = convert_to_model_input(model_input)
 
             run_function = contract.functions.run(model_cid, inference_mode_uint8, converted_model_input)
 
@@ -342,7 +322,7 @@ class Client:
                 raise OpenGradientError("InferenceResult event not found in transaction logs")
 
             # TODO: This should return a ModelOutput class object
-            model_output = utils.convert_to_model_output(parsed_logs[0]["args"])
+            model_output = convert_to_model_output(parsed_logs[0]["args"])
 
             return InferenceResult(tx_hash.hex(), model_output)
 
@@ -751,7 +731,7 @@ class Client:
     #         if channel:
     #             channel.close()
 
-    def _get_abi(self, abi_name) -> List[Dict]:
+    def _get_abi(self, abi_name) -> str:
         """
         Returns the ABI for the requested contract.
         """
@@ -759,7 +739,7 @@ class Client:
         with open(abi_path, "r") as f:
             return json.load(f)
 
-    def _get_bin(self, bin_name) -> List[Dict]:
+    def _get_bin(self, bin_name) -> str:
         """
         Returns the bin for the requested contract.
         """
@@ -781,17 +761,20 @@ class Client:
         """
         Deploy a new workflow contract with the specified parameters.
 
-        This function deploys a new workflow contract and optionally registers it with
-        the scheduler for automated execution. If scheduler_params is not provided,
-        the workflow will be deployed without automated execution scheduling.
+        This function deploys a new workflow contract on OpenGradient that connects
+        an AI model with its required input data. When executed, the workflow will fetch
+        the specified model, evaluate the input query to get data, and perform inference.
+
+        The workflow can be set to execute manually or automatically via a scheduler.
 
         Args:
-            model_cid (str): IPFS CID of the model to be executed
-            input_query (HistoricalInputQuery): Query parameters for data input
+            model_cid (str): CID of the model to be executed from the Model Hub
+            input_query (HistoricalInputQuery): Input definition for the model inference,
+                will be evaluated at runtime for each inference
             input_tensor_name (str): Name of the input tensor expected by the model
             scheduler_params (Optional[SchedulerParams]): Scheduler configuration for automated execution:
                 - frequency: Execution frequency in seconds
-                - duration_hours: How long to run in hours
+                - duration_hours: How long the schedule should live for
 
         Returns:
             str: Deployed contract address. If scheduler_params was provided, the workflow
@@ -910,7 +893,7 @@ class Client:
         # Get the result
         result = contract.functions.getInferenceResult().call()
 
-        return utils.convert_array_to_model_output(result)
+        return convert_array_to_model_output(result)
 
     def run_workflow(self, contract_address: str) -> ModelOutput:
         """
@@ -955,9 +938,9 @@ class Client:
         # Get the inference result from the contract
         result = contract.functions.getInferenceResult().call()
 
-        return utils.convert_array_to_model_output(result)
+        return convert_array_to_model_output(result)
 
-    def read_workflow_history(self, contract_address: str, num_results: int) -> List[Dict]:
+    def read_workflow_history(self, contract_address: str, num_results: int) -> List[ModelOutput]:
         """
         Gets historical inference results from a workflow contract.
 
@@ -969,18 +952,14 @@ class Client:
             num_results (int): Number of historical results to retrieve
 
         Returns:
-            List[Dict]: List of historical inference results, each containing:
-                - prediction values
-                - timestamps
-                - any additional metadata stored with the result
-
+            List[ModelOutput]: List of historical inference results
         """
         contract = self._blockchain.eth.contract(
             address=Web3.to_checksum_address(contract_address), abi=self._get_abi("PriceHistoryInference.abi")
         )
 
         results = contract.functions.getLastInferenceResults(num_results).call()
-        return [utils.convert_array_to_model_output(result) for result in results]
+        return [convert_array_to_model_output(result) for result in results]
 
 
 def run_with_retry(txn_function, max_retries=DEFAULT_MAX_RETRY, retry_delay=DEFAULT_RETRY_DELAY_SEC):

opengradient/types.py

@@ -184,3 +184,15 @@ class SchedulerParams:
         if data is None:
             return None
         return SchedulerParams(frequency=data.get("frequency", 600), duration_hours=data.get("duration_hours", 2))
+
+
+@dataclass
+class ModelRepository:
+    name: str
+    initialVersion: str
+
+
+@dataclass
+class FileUploadResult:
+    modelCid: str
+    size: int

{opengradient-0.4.7.dist-info → opengradient-0.4.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: opengradient
-Version: 0.4.7
+Version: 0.4.8
 Summary: Python SDK for OpenGradient decentralized model management & inference services
 Author-email: OpenGradient <oliver@opengradient.ai>
 License: MIT License

{opengradient-0.4.7.dist-info → opengradient-0.4.8.dist-info}/RECORD

@@ -1,10 +1,10 @@
-opengradient/__init__.py,sha256=CBZiyZhnuqbhWylFTi6KVAADBTt2X09aUH00vxpw7kk,12066
+opengradient/__init__.py,sha256=l-bAgytvG4EnSE6q5OUIkyiaE4ROes9vy3xDN1PgWJg,12178
 opengradient/account.py,sha256=5wrYpws_1lozjOFjLCTHtxgoxK-LmObDAaVy9eDcJY4,1145
 opengradient/cli.py,sha256=12fezJJvuceUaPSllsMqrBFoSpd2sTJjMpZ1_Dhzskg,25426
-opengradient/client.py,sha256=IGykQOcn2kQBhtcATqa8ka19K5ZK8dYxzdkRqYIMx10,44925
+opengradient/client.py,sha256=q6Md6uleBl8h2Vkz1tjYrovFrg7_Lm0CWDMhymZmPzE,43773
 opengradient/defaults.py,sha256=Dqc64Qv7RdLv7ZBjXzvxRRqBDc1HhyVbbdImpmzyrzU,490
 opengradient/exceptions.py,sha256=88tfegboGtlehQcwhxsl6ZzhLJWZWlkf_bkHTiCtXpo,3391
-opengradient/types.py,sha256=wbLjrwurGG_74Dn9OZwkR-Kv985X5psSD8kgpiBwf3Q,4614
+opengradient/types.py,sha256=hAOsNJPoeZQtXM_qPnOTyk0ukTRKVAIMuJDr0Z8Z9t0,4757
 opengradient/utils.py,sha256=NMXg_mi5cHVeV01O4fFQJCcbwgGuGFbdYNrAG9K2Um0,8337
 opengradient/abi/PriceHistoryInference.abi,sha256=ZB3fZdx1kaFlp2wt1vTbTZZG1k8HPvmNtkG5Q8Bnajw,5098
 opengradient/abi/WorkflowScheduler.abi,sha256=yEGs76qO4S1z980KL5hBdfyXiJ6k-kERcB1O_o73AEU,416
@@ -21,9 +21,9 @@ opengradient/proto/__init__.py,sha256=AhaSmrqV0TXGzCKaoPV8-XUvqs2fGAJBM2aOmDpkNb
 opengradient/proto/infer.proto,sha256=13eaEMcppxkBF8yChptsX9HooWFwJKze7oLZNl-LEb8,1217
 opengradient/proto/infer_pb2.py,sha256=sGWDDVumYhXoCJTG9rLyvKu4XyaEjPE_b038kbNlj7w,3484
 opengradient/proto/infer_pb2_grpc.py,sha256=q42_eZ7OZCMTXdWocYA4Ka3B0c3B74dOhfqdaIOO5AU,6700
-opengradient-0.4.7.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
-opengradient-0.4.7.dist-info/METADATA,sha256=GC5oaUwycu1UodnPUEvBVvCI9cqBWJdLFo4W0oY83jo,5214
-opengradient-0.4.7.dist-info/WHEEL,sha256=nn6H5-ilmfVryoAQl3ZQ2l8SH5imPWFpm1A5FgEuFV4,91
-opengradient-0.4.7.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
-opengradient-0.4.7.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
-opengradient-0.4.7.dist-info/RECORD,,
+opengradient-0.4.8.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
+opengradient-0.4.8.dist-info/METADATA,sha256=teo3WbkHF5H2u0sy2aK2VAh1_HV0OLjwLmhNvf1DWFM,5214
+opengradient-0.4.8.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+opengradient-0.4.8.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
+opengradient-0.4.8.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
+opengradient-0.4.8.dist-info/RECORD,,

{opengradient-0.4.7.dist-info → opengradient-0.4.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.1)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any