opengradient 0.1.8__py3-none-any.whl → 0.2.0__py3-none-any.whl

opengradient/__init__.py

@@ -2,7 +2,7 @@ from .client import Client
 from .exceptions import OpenGradientError, FileNotFoundError, UploadError, InferenceError, ResultRetrievalError
 from .types import ModelInput, InferenceMode, Number, NumberTensor, StringTensor, ModelOutput
 
-__version__ = "0.1.8"
+__version__ = "0.2.0"
 
 _client = None
 

opengradient/cli.py

@@ -0,0 +1,184 @@
+import click
+import os
+import opengradient
+import json
+import ast
+from pathlib import Path
+from .client import Client
+from opengradient.types import InferenceMode, ModelInput
+
+# Environment variable names
+API_KEY_ENV = 'OPENGRADIENT_API_KEY'
+RPC_URL_ENV = 'OPENGRADIENT_RPC_URL'
+CONTRACT_ADDRESS_ENV = 'OPENGRADIENT_CONTRACT_ADDRESS'
+EMAIL_ENV = 'OPENGRADIENT_EMAIL'
+PASSWORD_ENV = 'OPENGRADIENT_PASSWORD'
+
+# Convert string to dictionary click parameter typing
+class DictParamType(click.ParamType):
+    name = "dictionary"
+
+    def convert(self, value, param, ctx):
+        if isinstance(value, dict):
+            return value
+        try:
+            # First, try to parse as JSON
+            return json.loads(value)
+        except json.JSONDecodeError:
+            # If JSON parsing fails, try to evaluate as a Python literal
+            try:
+                # ast.literal_eval is safer than eval as it only parses Python literals
+                result = ast.literal_eval(value)
+                if not isinstance(result, dict):
+                    self.fail(f"'{value}' is not a valid dictionary", param, ctx)
+                return result
+            except (ValueError, SyntaxError):
+                self.fail(f"'{value}' is not a valid dictionary", param, ctx)
+
+Dict = DictParamType()
+
+# Support inference modes
+InferenceModes = {
+    "VANILLA": opengradient.InferenceMode.VANILLA,
+    "ZKML": opengradient.InferenceMode.PRIVATE,
+    "TEE": opengradient.InferenceMode.VERIFIED,
+}
+
+# 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, 
+              help='Your OpenGradient private key', 
+              default="cd09980ef6e280afc3900d2d6801f9e9c5d858a5deaeeab74a65643f5ff1a4c1")
+@click.option('--rpc_url', 
+              envvar=RPC_URL_ENV, 
+              help='OpenGradient RPC URL address', 
+              default="http://18.218.115.248:8545")
+@click.option('--contract_address', 
+              envvar=CONTRACT_ADDRESS_ENV, 
+              help='OpenGradient contract address', 
+              default="0x350E0A430b2B1563481833a99523Cfd17a530e4e")
+@click.option('--email', 
+              envvar=EMAIL_ENV,
+              help='Your OpenGradient hub email address -- not required for inference', 
+              default="test@test.com")
+@click.option('--password', 
+              envvar=PASSWORD_ENV, 
+              help='Your OpenGradient hub password -- not required for inference', 
+              default="Test-123")
+@click.pass_context
+def cli(ctx, api_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 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:
+        ctx.exit(1)
+        return
+
+    try:
+        ctx.obj = Client(private_key=api_key, 
+                         rpc_url=rpc_url,
+                         contract_address=contract_address,
+                         email=email,
+                         password=password)
+    except Exception as e:
+        click.echo(f"Failed to create OpenGradient client: {str(e)}")
+
+@cli.command()
+@click.pass_obj
+def client_settings(client):
+    """Display OpenGradient client settings"""
+    click.echo("Settings for OpenGradient client:")
+    click.echo(f"\tAPI key ({API_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:
+        click.echo(f"\tEmail ({EMAIL_ENV}): {client.user["email"]}")
+    else:
+        click.echo(f"\tEmail: not set")
+
+@cli.command()
+@click.argument('model_path', type=Path)
+@click.argument('model_id', type=str)
+@click.argument('version_id', type=str)
+@click.pass_obj
+def upload(client, model_path, model_id, version_id):
+    """Upload a model"""
+    try:
+        result = client.upload(model_path, model_id, version_id)
+        click.echo(f"Model uploaded successfully: {result}")
+    except Exception as e:
+        click.echo(f"Error uploading model: {str(e)}")
+
+@cli.command()
+@click.argument('model_name', type=str)
+@click.argument('model_desc', type=str)
+@click.pass_obj
+def create_model(client, model_name, model_desc):
+    """Create a new model"""
+    try:
+        result = client.create_model(model_name, model_desc)
+        click.echo(f"Model created successfully: {result}")
+    except Exception as e:
+        click.echo(f"Error creating model: {str(e)}")
+
+@cli.command()
+@click.argument('model_id', type=str)
+@click.option('--notes', type=str, default=None, help='Version notes')
+@click.option('--is-major', default=False, is_flag=True, help='Is this a major version')
+@click.pass_obj
+def create_version(client, model_id, notes, is_major):
+    """Create a new version of a model"""
+    try:
+        result = client.create_version(model_id, notes, is_major)
+        click.echo(f"Version created successfully: {result}")
+    except Exception as e:
+        click.echo(f"Error creating version: {str(e)}")
+
+@cli.command()
+@click.argument('model_id', type=str)
+@click.argument('inference_mode', type=click.Choice(InferenceModes.keys()), default="VANILLA")
+@click.argument('input_data', type=Dict, required=False)
+@click.option('--input_file',
+              type=click.Path(exists=True, file_okay=True, dir_okay=False, readable=True, path_type=Path),
+              help="Optional file input for model inference -- must be JSON") 
+@click.pass_context
+def infer(ctx, model_id, inference_mode, input_data, input_file):
+    """Run inference on a model"""
+    client = ctx.obj
+    try:
+        if not input_data and not input_file:
+            click.echo("Must specify either input_data or input_file")
+            ctx.exit(1)
+            return
+        
+        if input_data and input_file:
+            click.echo("Cannot have both input_data and input_file")
+            ctx.exit(1)
+            return
+        
+        if input_data:
+            model_input = input_data
+
+        if input_file:
+            with input_file.open('r') as file:
+                model_input = json.load(file)
+            
+        # Parse input data from string to dict
+        click.echo(f"Running {inference_mode} inference for {model_id}...")
+        tx_hash, model_output = client.infer(model_cid=model_id, inference_mode=InferenceModes[inference_mode], model_input=model_input)
+        click.secho("Success!", fg="green")
+        click.echo(f"\nTransaction Hash: \n{tx_hash}")
+        click.echo(f"\nInference result: \n{model_output}")
+    except json.JSONDecodeError as e:
+        click.echo(f"Error decoding JSON: {e}", err=True)
+        click.echo(f"Error occurred on line {e.lineno}, column {e.colno}", err=True)
+    except Exception as e:
+        click.echo(f"Error running inference: {str(e)}")
+
+if __name__ == '__main__':
+    cli()

opengradient/client.py

@@ -32,7 +32,7 @@ class Client:
             rpc_url (str): The RPC URL for the Ethereum node.
             contract_address (str): The contract address for the smart contract.
             email (str, optional): Email for authentication. Defaults to "test@test.com".
-            password (str, optional): Password for authentication. Defaults to "Test123".
+            password (str, optional): Password for authentication. Defaults to "Test-123".
         """
         self.private_key = private_key
         self.rpc_url = rpc_url

{opengradient-0.1.8.dist-info → opengradient-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opengradient
-Version: 0.1.8
+Version: 0.2.0
 Summary: A Python SDK for OpenGradient inference services
 Author-email: OpenGradient <oliver@opengradient.ai>
 License: MIT License
@@ -45,6 +45,7 @@ Requires-Dist: web3
 Requires-Dist: pyarrow
 Requires-Dist: firebase-rest-api
 Requires-Dist: fastparquet
+Requires-Dist: pathlib
 
 # OpenGradient Python SDK
 

opengradient-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+opengradient/__init__.py,sha256=Kukk6uFmngLgIaYDmdoLjZaNO3ue51-bPIqkD62rNf4,1653
+opengradient/cli.py,sha256=pj1iU2AdL1R4MtQHehdQMacAXWw5pP5vJRF6CusP7jg,7243
+opengradient/client.py,sha256=UUIryYtXNi1VAqi7WAZZiF6mhc4i1ueeL6cnKMMFYpk,18020
+opengradient/exceptions.py,sha256=v4VmUGTvvtjhCZAhR24Ga42z3q-DzR1Y5zSqP_yn2Xk,3366
+opengradient/types.py,sha256=NTWQ0HvglQA7d8y6OQDkymToSdCq4NnrVtwQwm_NMMU,1857
+opengradient/utils.py,sha256=95i5RVn-32MRsn00M21io8QHLtmEAoRbgueMhDh0TVk,5079
+opengradient/abi/inference.abi,sha256=HH2SmCJ_D4O0I-CFsln0vFHd2PU-A-fxgCnUtHg0ZQg,2373
+opengradient-0.2.0.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
+opengradient-0.2.0.dist-info/METADATA,sha256=u6_Ku-gTu_PEmexIVEGBTgKFCfFHxfbSBTyB5eIK78M,3000
+opengradient-0.2.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+opengradient-0.2.0.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
+opengradient-0.2.0.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
+opengradient-0.2.0.dist-info/RECORD,,

opengradient-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+opengradient = opengradient.cli:cli

opengradient-0.1.8.dist-info/RECORD

@@ -1,11 +0,0 @@
-opengradient/__init__.py,sha256=L7fIQzQMFI-NajLWqcTyYwvXmoQhNBn3Zv4vUl-4-zY,1653
-opengradient/client.py,sha256=HenTm4UUi0Xf1YJpEm3QXGwPnf6ZUzzwjWwZYtxbQ28,18019
-opengradient/exceptions.py,sha256=v4VmUGTvvtjhCZAhR24Ga42z3q-DzR1Y5zSqP_yn2Xk,3366
-opengradient/types.py,sha256=NTWQ0HvglQA7d8y6OQDkymToSdCq4NnrVtwQwm_NMMU,1857
-opengradient/utils.py,sha256=95i5RVn-32MRsn00M21io8QHLtmEAoRbgueMhDh0TVk,5079
-opengradient/abi/inference.abi,sha256=HH2SmCJ_D4O0I-CFsln0vFHd2PU-A-fxgCnUtHg0ZQg,2373
-opengradient-0.1.8.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
-opengradient-0.1.8.dist-info/METADATA,sha256=7FoFCwvqHyfOsCwu9BZKtfMrFsxwpuhxsurl18SOw6Y,2977
-opengradient-0.1.8.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-opengradient-0.1.8.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
-opengradient-0.1.8.dist-info/RECORD,,