opengradient 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

opengradient/__init__.py

@@ -2,13 +2,13 @@ from .client import Client
 from .defaults import *
 from .types import InferenceMode
 from typing import List, Dict
-__version__ = "0.3.0"
+__version__ = "0.3.2"
 
 _client = None
 
 def init(email: str,
          password: str,
-         private_key=DEFAULT_PRIVATE_KEY,
+         private_key: str,
          rpc_url=DEFAULT_RPC_URL,
          contract_address=DEFAULT_INFERENCE_CONTRACT_ADDRESS):
     global _client
@@ -42,6 +42,15 @@ def infer(model_cid, inference_mode, model_input):
         raise RuntimeError("OpenGradient client not initialized. Call og.init() first.")
     return _client.infer(model_cid, inference_mode, model_input)
 
+def infer_llm(model_cid: str, 
+              prompt: str, 
+              max_tokens: int = 100, 
+              stop_sequence: Optional[List[str]] = None, 
+              temperature: float = 0.0) -> Tuple[str, str]:
+    if _client is None:
+        raise RuntimeError("OpenGradient client not initialized. Call og.init() first.")
+    return _client.infer_llm(model_cid, prompt, max_tokens, stop_sequence, temperature)
+
 def login(email: str, password: str):
     if _client is None:
         raise RuntimeError("OpenGradient client not initialized. Call og.init() first.")

opengradient/cli.py

@@ -5,6 +5,7 @@ import ast
 from pathlib import Path
 import logging
 from pprint import pformat
+from typing import List
 import webbrowser
 import sys
 
@@ -97,7 +98,13 @@ def initialize_config(ctx):
 @click.group()
 @click.pass_context
 def cli(ctx):
-    """CLI for OpenGradient SDK. Visit https://docs.opengradient.ai/developers/python_sdk/ for more documentation."""
+    """
+    CLI for OpenGradient SDK. 
+
+    Run 'opengradient config show' to make sure you have configs set up.
+    
+    Visit https://docs.opengradient.ai/developers/python_sdk/ for more documentation.
+    """
     # Load existing config 
     ctx.obj = load_og_config()
 
@@ -149,7 +156,7 @@ def show(ctx):
     click.echo("Current config:")
     for key, value in ctx.obj.items():
         if key != 'client':  # Don't display the client object
-            if key == 'password' and value is not None:
+            if (key == 'password' or key == 'private_key') and value is not None:
                 click.echo(f"{key}: {'*' * len(value)}")  # Mask the password
             elif value is None:
                 click.echo(f"{key}: Not set")
@@ -294,7 +301,6 @@ def infer(ctx, model_cid: str, inference_mode: str, input_data, input_file: Path
             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 \"{model_cid}\"\n")
         tx_hash, model_output = client.infer(model_cid=model_cid, inference_mode=InferenceModes[inference_mode], model_input=model_input)
 
@@ -307,6 +313,41 @@ def infer(ctx, model_cid: str, inference_mode: str, input_data, input_file: Path
     except Exception as e:
         click.echo(f"Error running inference: {str(e)}")
 
+@cli.command()
+@click.option('--model', '-m', 'model_cid', required=True, help='CID of the LLM model to run inference on')
+@click.option('--prompt', '-p', required=True, help='Input prompt for the LLM')
+@click.option('--max-tokens', type=int, default=100, help='Maximum number of tokens for LLM output')
+@click.option('--stop-sequence', multiple=True, help='Stop sequences for LLM')
+@click.option('--temperature', type=float, default=0.0, help='Temperature for LLM inference (0.0 to 1.0)')
+@click.pass_context
+def llm(ctx, model_cid: str, prompt: str, max_tokens: int, stop_sequence: List[str], temperature: float):
+    """
+    Run inference on an LLM model.
+
+    This command runs inference on the specified LLM model using the provided prompt and parameters.
+
+    Example usage:
+
+    \b
+    opengradient llm --model Qm... --prompt "Hello, how are you?" --max-tokens 50 --temperature 0.7
+    opengradient llm -m Qm... -p "Translate to French: Hello world" --stop-sequence "." --stop-sequence "\n"
+    """
+    client: Client = ctx.obj['client']
+    try:
+        click.echo(f"Running LLM inference for model \"{model_cid}\"\n")
+        tx_hash, llm_output = client.infer_llm(
+            model_cid=model_cid,
+            prompt=prompt,
+            max_tokens=max_tokens,
+            stop_sequence=list(stop_sequence),
+            temperature=temperature
+        )
+
+        click.secho("Success!", fg="green")
+        click.echo(f"Transaction hash: {tx_hash}")
+        click.echo(f"LLM output:\n{llm_output}")
+    except Exception as e:
+        click.echo(f"Error running LLM inference: {str(e)}")
 
 @cli.command()
 def create_account():

opengradient/client.py

@@ -7,7 +7,7 @@ from opengradient.types import InferenceMode
 from opengradient import utils
 import numpy as np
 import logging
-from typing import Dict, Tuple, Union, List
+from typing import Dict, Optional, Tuple, Union, List
 from web3.exceptions import ContractLogicError
 import firebase
 
@@ -32,6 +32,8 @@ class Client:
             email (str, optional): Email for authentication. Defaults to "test@test.com".
             password (str, optional): Password for authentication. Defaults to "Test-123".
         """
+        self.email = email
+        self.password = password
         self.private_key = private_key
         self.rpc_url = rpc_url
         self.contract_address = contract_address
@@ -41,8 +43,6 @@ class Client:
         self.firebase_app = firebase.initialize_app(self.FIREBASE_CONFIG)
         self.auth = self.firebase_app.auth()
         self.user = None
-        self.email = email
-        self.password = password
         
         logging.debug("Initialized client with parameters:\n"
                       "private key: %s\n"
@@ -58,6 +58,14 @@ class Client:
         if email is not None:
             self.login(email, password)
 
+    def login(self, email, password):
+        try:
+            self.user = self.auth.sign_in_with_email_and_password(email, password)
+            return self.user
+        except Exception as e:
+            logging.error(f"Authentication failed: {str(e)}")
+            raise
+
     def _initialize_web3(self):
         """
         Initialize the Web3 instance if it is not already initialized.
@@ -402,13 +410,97 @@ class Client:
             logging.error(f"Error in infer method: {str(e)}", exc_info=True)
             raise OpenGradientError(f"Inference failed: {str(e)}")
         
-    def login(self, email, password):
+    def infer_llm(self, 
+                  model_cid: str, 
+                  prompt: str, 
+                  max_tokens: int = 100, 
+                  stop_sequence: Optional[List[str]] = None, 
+                  temperature: float = 0.0) -> Tuple[str, str]:
+        """
+        Perform inference on an LLM model using completions.
+
+        Args:
+            model_cid (str): The unique content identifier for the model.
+            prompt (str): The input prompt for the LLM.
+            max_tokens (int): Maximum number of tokens for LLM output. Default is 100.
+            stop_sequence (List[str], optional): List of stop sequences for LLM. Default is None.
+            temperature (float): Temperature for LLM inference, between 0 and 1. Default is 0.0.
+
+        Returns:
+            Tuple[str, str]: The transaction hash and the LLM output.
+
+        Raises:
+            OpenGradientError: If the inference fails.
+        """
         try:
-            self.user = self.auth.sign_in_with_email_and_password(email, password)
-            return self.user
+            self._initialize_web3()
+            
+            abi_path = os.path.join(os.path.dirname(__file__), 'abi', 'llm.abi')
+            with open(abi_path, 'r') as abi_file:
+                llm_abi = json.load(abi_file)
+            contract = self._w3.eth.contract(address=self.contract_address, abi=llm_abi)
+
+            # Prepare LLM input
+            llm_request = {
+                "mode": InferenceMode.VANILLA,
+                "modelCID": model_cid,
+                "prompt": prompt,
+                "max_tokens": max_tokens,
+                "stop_sequence": stop_sequence or [],
+                "temperature": int(temperature * 100)  # Scale to 0-100 range
+            }
+            logging.debug(f"Prepared LLM request: {llm_request}")
+
+            # Prepare run function
+            run_function = contract.functions.runLLM(llm_request)
+
+            # Build transaction
+            nonce = self._w3.eth.get_transaction_count(self.wallet_address)
+            estimated_gas = run_function.estimate_gas({'from': self.wallet_address})
+            gas_limit = int(estimated_gas * 1.2)
+
+            transaction = run_function.build_transaction({
+                'from': self.wallet_address,
+                'nonce': nonce,
+                'gas': gas_limit,
+                'gasPrice': self._w3.eth.gas_price,
+            })
+
+            # Sign and send transaction
+            signed_tx = self._w3.eth.account.sign_transaction(transaction, self.private_key)
+            tx_hash = self._w3.eth.send_raw_transaction(signed_tx.raw_transaction)
+            logging.debug(f"Transaction sent. Hash: {tx_hash.hex()}")
+
+            # Wait for transaction receipt
+            tx_receipt = self._w3.eth.wait_for_transaction_receipt(tx_hash)
+
+            if tx_receipt['status'] == 0:
+                raise ContractLogicError(f"Transaction failed. Receipt: {tx_receipt}")
+
+            # Process the LLMResult event
+            llm_result = None
+            for log in tx_receipt['logs']:
+                try:
+                    decoded_log = contract.events.LLMResult().process_log(log)
+                    llm_result = decoded_log['args']['response']['answer']
+                    break
+                except:
+                    continue
+
+            if llm_result is None:
+                raise OpenGradientError("LLMResult event not found in transaction logs")
+
+            logging.debug(f"LLM output: {llm_result}")
+
+            return tx_hash.hex(), llm_result
+
+        except ContractLogicError as e:
+            logging.error(f"Contract logic error: {str(e)}", exc_info=True)
+            raise OpenGradientError(f"LLM inference failed due to contract logic error: {str(e)}")
         except Exception as e:
-            logging.error(f"Authentication failed: {str(e)}")
-            raise
+            logging.error(f"Error in infer_llm method: {str(e)}", exc_info=True)
+            raise OpenGradientError(f"LLM inference failed: {str(e)}")
+
 
     def list_files(self, model_name: str, version: str) -> List[Dict]:
         """

opengradient/defaults.py

@@ -1,7 +1,6 @@
 
 # Default variables
-DEFAULT_PRIVATE_KEY="cd09980ef6e280afc3900d2d6801f9e9c5d858a5deaeeab74a65643f5ff1a4c1"
 DEFAULT_RPC_URL="http://18.218.115.248:8545"
 DEFAULT_OG_FAUCET_URL="http://18.218.115.248:8080/?address="
 DEFAULT_HUB_SIGNUP_URL="https://hub.opengradient.ai/signup"
-DEFAULT_INFERENCE_CONTRACT_ADDRESS="0x75D0266DAb643417e9FFD828A1A31C1E039a966c"
+DEFAULT_INFERENCE_CONTRACT_ADDRESS="0x350E0A430b2B1563481833a99523Cfd17a530e4e"

{opengradient-0.3.0.dist-info → opengradient-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opengradient
-Version: 0.3.0
+Version: 0.3.2
 Summary: Python SDK for OpenGradient decentralized model management & inference services
 Author-email: OpenGradient <oliver@opengradient.ai>
 License: MIT License
@@ -135,21 +135,27 @@ Requires-Dist: websockets==13.1
 Requires-Dist: xattr==1.1.0
 Requires-Dist: yarl==1.13.1
 
-# OpenGradient SDK
-
-Python SDK for OpenGradient decentralized model management & inference services.
+# OpenGradient Python SDK
+Python SDK for the OpenGradient platform provides decentralized model management & inference services. Python SDK allows programmatic access to our model repository and decentralized AI infrastructure. 
 
 ## Installation
+
+To install Python SDK and CLI, run the following command:
 ```python
 pip install opengradient
 ```
 
 ## Quick Start
+
+To get started, run:
+
 ```python
 import opengradient as og
-og.init(email="<email>", password="<password>")
+og.init(private_key="<private_key>", email="<email>", password="<password>")
 ```
 
+The following commands show how to use Python SDK.
+
 ### Create a Model
 ```python
 og.create_model(model_name="<model_name>", model_desc="<model_description>")
@@ -180,6 +186,8 @@ og.list_files(model_name="<model_name>", version="<version>")
 inference_mode = og.InferenceMode.VANILLA
 og.infer(model_cid, model_inputs, inference_mode)
 ```
+ - inference mode can be `VANILLA`, `ZKML`, or `TEE`
+
 
 ## Using the CLI
 
@@ -188,15 +196,15 @@ export OPENGRADIENT_EMAIL="<email>"
 export OPENGRADIENT_PASSWORD="<password>"
 ```
 
-#### Creating a Model
+#### Creating a Model Repo
 ```bash
-opengradient create_model "<model_name>" "<description>" 
+opengradient create_model_repo "<model_name>" "<description>" 
 ```
 - creating a model automatically initializes version `v0.01`
 
 #### Creating a Version
 ```bash
-opengradient create_model "<model_name>" "<description>" 
+opengradient create_model_repo "<model_name>" "<description>" 
 ```
 
 #### Upload a File
@@ -218,3 +226,5 @@ opengradient infer QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ VANILLA '{"num
 ```bash
 opengradient infer QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ VANILLA --input_file input.json
 ```
+
+For more information read the OpenGradient [documentation](https://docs.opengradient.ai/).

opengradient-0.3.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+opengradient/__init__.py,sha256=f1f7RSil3XAhjeTtcLuKuVyovgw7uIal1Xm3SyFrceA,2430
+opengradient/account.py,sha256=s1C4hAtc8vcHObWjwxwlYJA041S6DTbr7-rK6qiWPsQ,1149
+opengradient/cli.py,sha256=T59Z2S3AsMVS6TLgsSgxW9esssvYP5ZmVJrYE6p4oW4,16105
+opengradient/client.py,sha256=DCDp2EWPF62ZQnx2_cM0wPghRxgn213VnR65R8yZBVY,23964
+opengradient/defaults.py,sha256=pDfsmPoUzdLG55n-hwh0CMBFxKR2rdNcjqCcwTWc6iw,267
+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/abi/llm.abi,sha256=zhiPFyBT09EI3QU5DVoKHo7e8T9PFcfIQ3RHDYetm4M,3609
+opengradient-0.3.2.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
+opengradient-0.3.2.dist-info/METADATA,sha256=x0ItAXOKTD_3D6cTscWUBDloysJNgZCCZ2YruhjJwDE,7620
+opengradient-0.3.2.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+opengradient-0.3.2.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
+opengradient-0.3.2.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
+opengradient-0.3.2.dist-info/RECORD,,

opengradient-0.3.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-opengradient/__init__.py,sha256=JtRa1lL5qn5slM2egGm76gVuft-qEHc9gtU6tbOPRG8,2028
-opengradient/account.py,sha256=s1C4hAtc8vcHObWjwxwlYJA041S6DTbr7-rK6qiWPsQ,1149
-opengradient/cli.py,sha256=YKctHMZhT_Y1fANWDnGo68QpIVLXqz5ifH5kQXIxD8A,14412
-opengradient/client.py,sha256=__KtU-i6EQqZNj8xX-yKoqb_V8Cdzgr9zHBY0m02Xfw,20141
-opengradient/defaults.py,sha256=5JNcTNfOmoP3DymEvBqZPQHUYCIslvxvLRtJLon0MkM,354
-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/abi/llm.abi,sha256=zhiPFyBT09EI3QU5DVoKHo7e8T9PFcfIQ3RHDYetm4M,3609
-opengradient-0.3.0.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
-opengradient-0.3.0.dist-info/METADATA,sha256=A6qo4CPFnnCw1N_PK5yfxKS9hCxFUbpvKEiBWma8byw,7168
-opengradient-0.3.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-opengradient-0.3.0.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
-opengradient-0.3.0.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
-opengradient-0.3.0.dist-info/RECORD,,