opengradient 0.2.7__py3-none-any.whl → 0.2.8__py3-none-any.whl

opengradient/__init__.py

@@ -1,16 +1,16 @@
 from .client import Client
-from .exceptions import OpenGradientError, FileNotFoundError, UploadError, InferenceError, ResultRetrievalError
-from .types import ModelInput, InferenceMode, Number, NumberTensor, StringTensor, ModelOutput
+from .defaults import *
+from .types import InferenceMode
 
-__version__ = "0.2.7"
+__version__ = "0.2.8"
 
 _client = None
 
-def init(private_key="cd09980ef6e280afc3900d2d6801f9e9c5d858a5deaeeab74a65643f5ff1a4c1",
-         rpc_url="http://18.218.115.248:8545",
-         contract_address="0x350E0A430b2B1563481833a99523Cfd17a530e4e",
-         email="test@test.com",
-         password="Test-123"):
+def init(private_key=DEFAULT_PRIVATE_KEY,
+         rpc_url=DEFAULT_RPC_URL,
+         contract_address=DEFAULT_INFERENCE_CONTRACT_ADDRESS,
+         email=DEFAULT_HUB_EMAIL,
+         password=DEFAULT_HUB_PASSWORD):
     global _client
     _client = Client(private_key=private_key, rpc_url=rpc_url, contract_address=contract_address, email=email, password=password)
 

opengradient/abi/inference.abi

@@ -1 +1 @@
-[{"anonymous":false,"inputs":[{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct Number[]","name":"values","type":"tuple[]"}],"internalType":"struct NumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct StringTensor[]","name":"strings","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"indexed":false,"internalType":"struct ModelOutput","name":"output","type":"tuple"}],"name":"InferenceResult","type":"event"},{"inputs":[{"internalType":"string","name":"modelId","type":"string"},{"internalType":"enum IInference.ModelInferenceMode","name":"inferenceMode","type":"uint8"},{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct Number[]","name":"values","type":"tuple[]"}],"internalType":"struct NumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct StringTensor[]","name":"strings","type":"tuple[]"}],"internalType":"struct ModelInput","name":"modelInput","type":"tuple"}],"name":"run","outputs":[{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct Number[]","name":"values","type":"tuple[]"}],"internalType":"struct NumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct StringTensor[]","name":"strings","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"internalType":"struct ModelOutput","name":"","type":"tuple"}],"stateMutability":"nonpayable","type":"function"}]
+[{"anonymous":false,"inputs":[{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct TensorLib.Number[]","name":"values","type":"tuple[]"},{"internalType":"uint32[]","name":"shape","type":"uint32[]"}],"internalType":"struct TensorLib.MultiDimensionalNumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct TensorLib.StringTensor[]","name":"strings","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"indexed":false,"internalType":"struct ModelOutput","name":"output","type":"tuple"}],"name":"InferenceResult","type":"event"},{"inputs":[{"internalType":"string","name":"modelId","type":"string"},{"internalType":"enum ModelInferenceMode","name":"inferenceMode","type":"uint8"},{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct TensorLib.Number[]","name":"values","type":"tuple[]"},{"internalType":"uint32[]","name":"shape","type":"uint32[]"}],"internalType":"struct TensorLib.MultiDimensionalNumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct TensorLib.StringTensor[]","name":"strings","type":"tuple[]"}],"internalType":"struct ModelInput","name":"modelInput","type":"tuple"}],"name":"run","outputs":[{"components":[{"components":[{"internalType":"string","name":"name","type":"string"},{"components":[{"internalType":"int128","name":"value","type":"int128"},{"internalType":"int128","name":"decimals","type":"int128"}],"internalType":"struct TensorLib.Number[]","name":"values","type":"tuple[]"},{"internalType":"uint32[]","name":"shape","type":"uint32[]"}],"internalType":"struct TensorLib.MultiDimensionalNumberTensor[]","name":"numbers","type":"tuple[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string[]","name":"values","type":"string[]"}],"internalType":"struct TensorLib.StringTensor[]","name":"strings","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"internalType":"struct ModelOutput","name":"","type":"tuple"}],"stateMutability":"nonpayable","type":"function"}]

opengradient/cli.py

@@ -5,10 +5,11 @@ import json
 import ast
 from pathlib import Path
 from .client import Client
-from opengradient.types import InferenceMode, ModelInput
+from .defaults import *
+from .types import InferenceMode, ModelInput
 
 # Environment variable names
-API_KEY_ENV = 'OPENGRADIENT_API_KEY'
+PRIVATE_KEY_ENV = 'OPENGRADIENT_PRIVATE_KEY'
 RPC_URL_ENV = 'OPENGRADIENT_RPC_URL'
 CONTRACT_ADDRESS_ENV = 'OPENGRADIENT_CONTRACT_ADDRESS'
 EMAIL_ENV = 'OPENGRADIENT_EMAIL'
@@ -39,48 +40,48 @@ Dict = DictParamType()
 
 # Support inference modes
 InferenceModes = {
-    "VANILLA": opengradient.InferenceMode.VANILLA,
-    "ZKML": opengradient.InferenceMode.ZKML,
-    "TEE": opengradient.InferenceMode.TEE,
+    "VANILLA": InferenceMode.VANILLA,
+    "ZKML": InferenceMode.ZKML,
+    "TEE": InferenceMode.TEE,
 }
 
 # TODO (Kyle): Once we're farther into development, we should remove the defaults for these options
 @click.group()
-@click.option('--api_key', 
-              envvar=API_KEY_ENV, 
+@click.option('--private_key', 
+              envvar=PRIVATE_KEY_ENV, 
               help='Your OpenGradient private key', 
-              default="cd09980ef6e280afc3900d2d6801f9e9c5d858a5deaeeab74a65643f5ff1a4c1")
+              default=DEFAULT_PRIVATE_KEY)
 @click.option('--rpc_url', 
               envvar=RPC_URL_ENV, 
               help='OpenGradient RPC URL address', 
-              default="http://18.218.115.248:8545")
+              default=DEFAULT_RPC_URL)
 @click.option('--contract_address', 
               envvar=CONTRACT_ADDRESS_ENV, 
               help='OpenGradient inference contract address', 
-              default="0x350E0A430b2B1563481833a99523Cfd17a530e4e")
+              default=DEFAULT_INFERENCE_CONTRACT_ADDRESS)
 @click.option('--email', 
               envvar=EMAIL_ENV,
               help='Your OpenGradient Hub email address -- not required for inference', 
-              default="test@test.com")
+              default=DEFAULT_HUB_EMAIL)
 @click.option('--password', 
               envvar=PASSWORD_ENV, 
               help='Your OpenGradient Hub password -- not required for inference', 
-              default="Test-123")
+              default=DEFAULT_HUB_PASSWORD)
 @click.pass_context
-def cli(ctx, api_key, rpc_url, contract_address, email, password):
+def cli(ctx, private_key, rpc_url, contract_address, email, password):
     """CLI for OpenGradient SDK"""
-    if not api_key:
-        click.echo("Please provide an API key via flag or setting environment variable OPENGRADIENT_API_KEY")
+    if not private_key:
+        click.echo("Please provide a private key via flag or setting environment variable OPENGRADIENT_PRIVATE_KEY")
     if not rpc_url:
         click.echo("Please provide a RPC URL via flag or setting environment variable OPENGRADIENT_RPC_URL")
     if not contract_address:
         click.echo("Please provide a contract address via flag or setting environment variable OPENGRADIENT_CONTRACT_ADDRESS")
-    if not api_key or not rpc_url or not contract_address:
+    if not private_key or not rpc_url or not contract_address:
         ctx.exit(1)
         return
 
     try:
-        ctx.obj = Client(private_key=api_key, 
+        ctx.obj = Client(private_key=private_key, 
                          rpc_url=rpc_url,
                          contract_address=contract_address,
                          email=email,
@@ -98,7 +99,7 @@ def client_settings(ctx):
         ctx.exit(1)
         
     click.echo("Settings for OpenGradient client:")
-    click.echo(f"\tAPI key ({API_KEY_ENV}): {client.private_key}")
+    click.echo(f"\tPrivate key ({PRIVATE_KEY_ENV}): {client.private_key}")
     click.echo(f"\tRPC URL ({RPC_URL_ENV}): {client.rpc_url}")
     click.echo(f"\tContract address ({CONTRACT_ADDRESS_ENV}): {client.contract_address}")
     if client.user:

opengradient/client.py

@@ -43,6 +43,12 @@ class Client:
         self.firebase_app = firebase.initialize_app(self.FIREBASE_CONFIG)
         self.auth = self.firebase_app.auth()
         self.user = None
+        
+        logging.debug("Initialized client with parameters:\n"
+                      "private key: %s\n"
+                      "RPC URL: %s\n"
+                      "Contract Address: %s\n",
+                      private_key, rpc_url, contract_address)
 
         abi_path = os.path.join(os.path.dirname(__file__), 'abi', 'inference.abi')
         with open(abi_path, 'r') as abi_file:

opengradient/defaults.py

@@ -0,0 +1,7 @@
+
+# Default variables
+DEFAULT_PRIVATE_KEY="cd09980ef6e280afc3900d2d6801f9e9c5d858a5deaeeab74a65643f5ff1a4c1"
+DEFAULT_RPC_URL="http://18.218.115.248:8545"
+DEFAULT_INFERENCE_CONTRACT_ADDRESS="0x75D0266DAb643417e9FFD828A1A31C1E039a966c"
+DEFAULT_HUB_EMAIL="test@test.com"
+DEFAULT_HUB_PASSWORD="Test-123"

opengradient/utils.py

@@ -40,11 +40,10 @@ def convert_to_model_input(inputs: Dict[str, np.ndarray]) -> Tuple[List[Tuple[st
     """
     Expect SDK input to be a dict with the format
         key: tensor name
-        value: np.array
+        value: np.array / list
 
-        Note: np.array types must be float or string. Ints currently not supported.
-
-    Return a tuple of (number tensors, string tensors) depending on the input type
+    Return a tuple of (number tensors, string tensors) depending on the input type. Each number and string tensor converted
+    to a numpy array and flattened and the shape saved.
     """
     logging.debug("Converting the following input dictionary to ModelInput: %s", inputs)
     number_tensors = []
@@ -59,19 +58,37 @@ def convert_to_model_input(inputs: Dict[str, np.ndarray]) -> Tuple[List[Tuple[st
             logging.debug(f"\tConverting single entry {tensor_data} to a list")
             tensor_data = np.array([tensor_data])
 
+        # Check if type is np array
+        if not isinstance(tensor_data, np.ndarray):
+            raise TypeError("Inference input must be list, numpy array, or type (str, int, float): %s" % type(tensor_data))
+
+        # Flatten list and retain shape
+        shape = tensor_data.shape
+        flat_data = tensor_data.flatten()
+        logging.debug("Shape and flattened data: %s, %s", shape, flat_data)
+
         # Parse into number and string tensors
         if issubclass(tensor_data.dtype.type, np.floating):
-            input = (tensor_name, [convert_to_fixed_point(i) for i in tensor_data])
+            # Convert to fixed-point tuples
+            data_type = np.dtype([('value', int), ('decimal', int)])
+            converted_tensor_data = np.array([convert_to_fixed_point(i) for i in flat_data], dtype=data_type)
+            
+            input = (tensor_name, converted_tensor_data.tolist(), shape)
             logging.debug("\tFloating tensor input: %s", input)
 
             number_tensors.append(input)
         elif issubclass(tensor_data.dtype.type, np.integer):
-            input = (tensor_name, [convert_to_fixed_point(int(i)) for i in tensor_data])
+            # Convert to fixed-point tuples
+            data_type = np.dtype([('value', int), ('decimal', int)])
+            converted_tensor_data = np.array([convert_to_fixed_point(int(i)) for i in flat_data], dtype=data_type)
+
+            input = (tensor_name, converted_tensor_data.tolist(), shape)
             logging.debug("\tInteger tensor input: %s", input)
 
             number_tensors.append(input)
         elif issubclass(tensor_data.dtype.type, np.str_):
-            input = (tensor_name, [s for s in tensor_data])
+            # TODO (Kyle): Add shape into here as well
+            input = (tensor_name, [s for s in flat_data])
             logging.debug("\tString tensor input: %s", input)
 
             string_tensors.append(input)
@@ -85,6 +102,15 @@ def convert_to_model_input(inputs: Dict[str, np.ndarray]) -> Tuple[List[Tuple[st
     return number_tensors, string_tensors
 
 def convert_to_model_output(event_data: AttributeDict) -> Dict[str, np.ndarray]:
+    """
+    Converts inference output into a user-readable output. 
+    Expects the inference node to return a dict with the format:
+        key: output_name (str)
+        value: (output_array (list), shape (list)) (tuple)
+
+    We need to reshape each output array using the shape parameter in order to get the array
+    back into its original shape.
+    """
     logging.debug(f"Parsing event data: {event_data}")
         
     output_dict = {}
@@ -98,6 +124,7 @@ def convert_to_model_output(event_data: AttributeDict) -> Dict[str, np.ndarray]:
             logging.debug(f"Processing number tensor: {tensor}")
             if isinstance(tensor, AttributeDict):
                 name = tensor.get('name')
+                shape = tensor.get('shape')
                 values = []
                 # Convert from fixed point back into np.float32
                 for v in tensor.get('values', []):
@@ -105,7 +132,7 @@ def convert_to_model_output(event_data: AttributeDict) -> Dict[str, np.ndarray]:
                         values.append(convert_to_float32(value=int(v.get('value')), decimals=int(v.get('decimals'))))
                     else:
                         logging.warning(f"Unexpected number type: {type(v)}")
-                output_dict[name] = np.array(values)
+                output_dict[name] = np.array(values).reshape(shape)
             else:
                 logging.warning(f"Unexpected tensor type: {type(tensor)}")
 
@@ -114,8 +141,9 @@ def convert_to_model_output(event_data: AttributeDict) -> Dict[str, np.ndarray]:
             logging.debug(f"Processing string tensor: {tensor}")
             if isinstance(tensor, AttributeDict):
                 name = tensor.get('name')
+                shape = tensor.get('shape')
                 values = tensor.get('values', [])
-                output_dict[name] = values
+                output_dict[name] = np.array(values).reshape(shape)
             else:
                     logging.warning(f"Unexpected tensor type: {type(tensor)}")
     else:

{opengradient-0.2.7.dist-info → opengradient-0.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opengradient
-Version: 0.2.7
+Version: 0.2.8
 Summary: A Python SDK for OpenGradient inference services
 Author-email: OpenGradient <oliver@opengradient.ai>
 License: MIT License
@@ -140,42 +140,70 @@ Requires-Dist: yarl==1.13.1
 Python SDK for OpenGradient inference services.
 
 ## Installation
-```
+```python
 pip install opengradient
 ```
 
 ## Quick Start
-```
+```python
 import opengradient as og
 og.init(private_key="x", rpc_url="y", contract_address="z")
 ```
 
 ### Sign in with Email
-```
+```python
 og.login(email="you@opengradient.ai", password="xyz")
 ```
 
 ### Create a Model
-```
+```python
 og.create_model(model_name="test-network-model", model_desc="testing upload to sdk")
 ```
 
 ### Create a Version of a Model
-```
+```python
 og.create_version(model_name="test-network-model", notes="test notes")
 ```
 
 ### Upload Files to a Model
-```
+```python
 og.upload(model_path="local_path_to_your_model.onnx", model_name="test-network-model", version="0.01")
 ```
 
 ### Run Inference
-```
+```python
 inference_mode = og.InferenceMode.VANILLA
 inference_cid = og.infer(model_cid, model_inputs, inference_mode)
 ```
 
-```
+```python
 og.infer(model_id, inference_mode, model_input)
 ```
+
+## Using the CLI
+
+#### Creating a Model
+```bash
+opengradient create_model "<model_name>" "<description>" 
+```
+- creating a model automatically initializes version `v0.01`
+
+#### Creating a Version
+```bash
+opengradient create_model "<model_name>" "<description>" 
+```
+
+#### Upload a File
+```bash
+opengradient upload "path/to/model.onnx" "<model_name>" "<version>" 
+```
+
+####  CLI infer using string 
+```bash
+opengradient infer QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ VANILLA '{"num_input1":[1.0, 2.0, 3.0], "num_input2":10, "str_input1":["hello", "ONNX"], "str_input2":" world"}'
+```
+
+#### CLI infer using file path input
+```bash
+opengradient infer QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ VANILLA --input_file input.json
+```

opengradient-0.2.8.dist-info/RECORD

@@ -0,0 +1,14 @@
+opengradient/__init__.py,sha256=gMNHFVZRrzniZ7RrhUm02bJGFQ5U9RR7o7G2klgPQ8g,1576
+opengradient/cli.py,sha256=bM_mROx9xbhtJ2P1uBrdsRSlphkC93zuD5q6mC6E9WA,7430
+opengradient/client.py,sha256=9yhMLlqfRcIOk16P-9OOV2QR9UOfpkZYtaFExJQYxKw,18313
+opengradient/defaults.py,sha256=FDVOXlceTTU1G13KDf1Gg34UYhOU9VUBemqBVu99G5Y,298
+opengradient/exceptions.py,sha256=v4VmUGTvvtjhCZAhR24Ga42z3q-DzR1Y5zSqP_yn2Xk,3366
+opengradient/types.py,sha256=EoJN-DkQrJ2WTUv8OenlrlWJWFY2jPGTl-T8C_OVjp8,1849
+opengradient/utils.py,sha256=F1Nj-GMNFQFxCtbGgWQq1RP4TSurbpQxJV3yKeEo1b0,6482
+opengradient/abi/inference.abi,sha256=u8FsW0s1YeRjUb9eLS1k_qh_5f_cwOdr0bii-tAdxh0,2683
+opengradient-0.2.8.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
+opengradient-0.2.8.dist-info/METADATA,sha256=99VuVVLSZlCT9tCx697XV75uwaZUBY39WxfETdpB5YQ,6871
+opengradient-0.2.8.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+opengradient-0.2.8.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
+opengradient-0.2.8.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
+opengradient-0.2.8.dist-info/RECORD,,

opengradient-0.2.7.dist-info/RECORD

@@ -1,13 +0,0 @@
-opengradient/__init__.py,sha256=BRxrOg8w_gPDiYpBbDAeEy-XFidmGNU-GvWozFw3vbo,1783
-opengradient/cli.py,sha256=EVb_JNvfaXWEalKKtfRknyw7tXko5qqKkHPwTR-W3cQ,7468
-opengradient/client.py,sha256=XJ5AGB518Mwmfdk1xeHyR51B2KvGvFHEoRjWLsr1x7M,18052
-opengradient/exceptions.py,sha256=v4VmUGTvvtjhCZAhR24Ga42z3q-DzR1Y5zSqP_yn2Xk,3366
-opengradient/types.py,sha256=EoJN-DkQrJ2WTUv8OenlrlWJWFY2jPGTl-T8C_OVjp8,1849
-opengradient/utils.py,sha256=95i5RVn-32MRsn00M21io8QHLtmEAoRbgueMhDh0TVk,5079
-opengradient/abi/inference.abi,sha256=HH2SmCJ_D4O0I-CFsln0vFHd2PU-A-fxgCnUtHg0ZQg,2373
-opengradient-0.2.7.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
-opengradient-0.2.7.dist-info/METADATA,sha256=AXjww8-Sq9V1hil5VFOYGdOV9A7Yd60ytTGOtu2u1QQ,6085
-opengradient-0.2.7.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-opengradient-0.2.7.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
-opengradient-0.2.7.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
-opengradient-0.2.7.dist-info/RECORD,,