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

opengradient/defaults.py

@@ -3,6 +3,7 @@ DEFAULT_RPC_URL = "http://18.188.176.119:8545"
 DEFAULT_OG_FAUCET_URL = "https://faucet.opengradient.ai/?address="
 DEFAULT_HUB_SIGNUP_URL = "https://hub.opengradient.ai/signup"
 DEFAULT_INFERENCE_CONTRACT_ADDRESS = "0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE"
+DEFAULT_SCHEDULER_ADDRESS = "0x7179724De4e7FF9271FA40C0337c7f90C0508eF6"
 DEFAULT_BLOCKCHAIN_EXPLORER = "https://explorer.opengradient.ai/tx/"
 DEFAULT_IMAGE_GEN_HOST = "18.217.25.69"
 DEFAULT_IMAGE_GEN_PORT = 5125

opengradient/llm/__init__.py

@@ -10,7 +10,7 @@ from .og_langchain import *
 from .og_openai import *
 
 
-def langchain_adapter(private_key: str, model_cid: str, max_tokens: int = 300) -> OpenGradientChatModel:
+def langchain_adapter(private_key: str, model_cid: LLM, max_tokens: int = 300) -> OpenGradientChatModel:
     """
     Returns an OpenGradient LLM that implements LangChain's LLM interface
     and can be plugged into LangChain agents.

opengradient/llm/og_langchain.py

@@ -1,5 +1,6 @@
 import json
-from typing import Any, Dict, List, Optional, Sequence, Union
+from typing import Any, Dict, List, Optional, Sequence, Union, Callable
+from typing_extensions import override
 
 from langchain.chat_models.base import BaseChatModel
 from langchain.schema import (
@@ -14,37 +15,45 @@ from langchain_core.callbacks.manager import CallbackManagerForLLMRun
 from langchain_core.messages import ToolCall
 from langchain_core.messages.tool import ToolMessage
 from langchain_core.tools import BaseTool
+from langchain_core.runnables import Runnable
+from langchain_core.language_models.base import LanguageModelInput
 
-from opengradient import Client, LlmInferenceMode
+from opengradient import Client, LlmInferenceMode, LLM
 from opengradient.defaults import DEFAULT_INFERENCE_CONTRACT_ADDRESS, DEFAULT_RPC_URL
 
 
 class OpenGradientChatModel(BaseChatModel):
     """OpenGradient adapter class for LangChain chat model"""
 
-    client: Client = None
-    model_cid: str = None
-    max_tokens: int = None
-    tools: List[Dict] = []
+    _client: Client
+    _model_cid: LLM
+    _max_tokens: int
+    _tools: List[Dict] = []
 
-    def __init__(self, private_key: str, model_cid: str, max_tokens: int = 300):
+    def __init__(self, private_key: str, model_cid: LLM, max_tokens: int = 300):
         super().__init__()
-        self.client = Client(
+
+        self._client = Client(
             private_key=private_key, rpc_url=DEFAULT_RPC_URL, contract_address=DEFAULT_INFERENCE_CONTRACT_ADDRESS, email=None, password=None
         )
-        self.model_cid = model_cid
-        self.max_tokens = max_tokens
+        self._model_cid = model_cid
+        self._max_tokens = max_tokens
 
     @property
     def _llm_type(self) -> str:
         return "opengradient"
 
+    @override
     def bind_tools(
         self,
-        tools: Sequence[Union[BaseTool, Dict]],
-    ) -> "OpenGradientChatModel":
+        tools: Sequence[
+            Union[Dict[str, Any], type, Callable, BaseTool]  # noqa: UP006
+        ],
+        **kwargs: Any,
+    ) -> Runnable[LanguageModelInput, BaseMessage]:
         """Bind tools to the model."""
-        tool_dicts = []
+        tool_dicts: List[Dict] = []
+
         for tool in tools:
             if isinstance(tool, BaseTool):
                 tool_dicts.append(
@@ -53,16 +62,20 @@ class OpenGradientChatModel(BaseChatModel):
                         "function": {
                             "name": tool.name,
                             "description": tool.description,
-                            "parameters": tool.args_schema.schema() if hasattr(tool, "args_schema") else {},
+                            "parameters": (
+                                tool.args_schema.schema() if hasattr(tool, "args_schema") and tool.args_schema is not None else {}
+                            ),
                         },
                     }
                 )
             else:
                 tool_dicts.append(tool)
 
-        self.tools = tool_dicts
+        self._tools = tool_dicts
+
         return self
 
+    @override
     def _generate(
         self,
         messages: List[BaseMessage],
@@ -91,16 +104,17 @@ class OpenGradientChatModel(BaseChatModel):
             else:
                 raise ValueError(f"Unexpected message type: {message}")
 
-        chat_output = self.client.llm_chat(
-            model_cid=self.model_cid,
+        chat_output = self._client.llm_chat(
+            model_cid=self._model_cid,
             messages=sdk_messages,
             stop_sequence=stop,
-            max_tokens=self.max_tokens,
-            tools=self.tools,
+            max_tokens=self._max_tokens,
+            tools=self._tools,
             inference_mode=LlmInferenceMode.VANILLA,
         )
-        finish_reason = chat_output.finish_reason
-        chat_response = chat_output.chat_output
+
+        finish_reason = chat_output.finish_reason or ""
+        chat_response = chat_output.chat_output or {}
 
         if "tool_calls" in chat_response and chat_response["tool_calls"]:
             tool_calls = []
@@ -116,5 +130,5 @@ class OpenGradientChatModel(BaseChatModel):
     @property
     def _identifying_params(self) -> Dict[str, Any]:
         return {
-            "model_name": self.model_cid,
+            "model_name": self._model_cid,
         }

opengradient/llm/og_openai.py

@@ -16,7 +16,7 @@ class OGCompletions(object):
 
     def create(
         self,
-        model: str,
+        model: og.LLM,
         messages: List[object],
         tools: List[object],
         tool_choice: str,

opengradient/types.py

@@ -15,6 +15,7 @@ class CandleType(IntEnum):
     LOW = 1
     OPEN = 2
     CLOSE = 3
+    VOLUME = 4
 
 
 @dataclass
@@ -37,20 +38,6 @@ class HistoricalInputQuery:
             [int(ct) for ct in self.candle_types],
         )
 
-    @classmethod
-    def from_dict(cls, data: dict) -> "HistoricalInputQuery":
-        """Create HistoricalInputQuery from dictionary format"""
-        order = CandleOrder[data["order"].upper()]
-        candle_types = [CandleType[ct.upper()] for ct in data["candle_types"]]
-        return cls(
-            base=data["base"],
-            quote=data["quote"],
-            total_candles=int(data["total_candles"]),
-            candle_duration_in_mins=int(data["candle_duration_in_mins"]),
-            order=order,
-            candle_types=candle_types,
-        )
-
 
 @dataclass
 class Number:
@@ -76,13 +63,13 @@ class ModelInput:
     strings: List[StringTensor]
 
 
-class InferenceMode:
+class InferenceMode(Enum):
     VANILLA = 0
     ZKML = 1
     TEE = 2
 
 
-class LlmInferenceMode:
+class LlmInferenceMode(Enum):
     VANILLA = 0
     TEE = 1
 
@@ -98,21 +85,36 @@ class ModelOutput:
     jsons: Dict[str, np.ndarray]  # Converts to JSON dictionary
     is_simulation_result: bool
 
+
+@dataclass
+class InferenceResult:
+    """
+    Output for ML inference requests
+    """
+
+    transaction_hash: str
+    """Blockchain hash for the transaction."""
+
+    model_output: Dict[str, np.ndarray]
+    """Output of ONNX model"""
+
+
 @dataclass
 class TextGenerationOutput:
     """
     Output structure for text generation requests.
     """
+
     transaction_hash: str
     """Blockchain hash for the transaction."""
 
-    finish_reason: str | None = ""
+    finish_reason: Optional[str] = None
     """Reason for completion (e.g., 'tool_call', 'stop', 'error'). Empty string if not applicable."""
-    
-    chat_output: Dict | None = DefaultDict
+
+    chat_output: Optional[Dict] = None
     """Dictionary of chat response containing role, message content, tool call parameters, etc.. Empty dict if not applicable."""
 
-    completion_output: str | None = ""
+    completion_output: Optional[str] = None
     """Raw text output from completion-style generation. Empty string if not applicable."""
 
 
@@ -182,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/utils.py

@@ -1,3 +1,5 @@
+# type: ignore
+
 import json
 import logging
 from decimal import Decimal

opengradient-0.4.8.dist-info/METADATA

@@ -0,0 +1,159 @@
+Metadata-Version: 2.2
+Name: opengradient
+Version: 0.4.8
+Summary: Python SDK for OpenGradient decentralized model management & inference services
+Author-email: OpenGradient <oliver@opengradient.ai>
+License: MIT License
+        
+        Copyright (c) 2024 OpenGradient
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://opengradient.ai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: eth-account>=0.13.4
+Requires-Dist: web3>=7.3.0
+Requires-Dist: click>=8.1.7
+Requires-Dist: firebase-rest-api>=1.11.0
+Requires-Dist: grpcio>=1.66.2
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: requests>=2.32.3
+Requires-Dist: langchain>=0.3.7
+Requires-Dist: openai>=1.58.1
+Requires-Dist: pydantic>=2.9.2
+
+# OpenGradient Python SDK
+
+A Python SDK for decentralized model management and inference services on the OpenGradient platform. The SDK enables programmatic access to our model repository and decentralized AI infrastructure.
+
+## Key Features
+
+- Model management and versioning
+- Decentralized model inference
+- Support for LLM inference with various models
+- End-to-end verified AI execution
+- Command-line interface (CLI) for direct access
+
+## Model Hub
+
+Browse and discover AI models on our [Model Hub](https://hub.opengradient.ai/). The Hub provides:
+- Registry of models and LLMs
+- Easy model discovery and deployment
+- Direct integration with the SDK
+
+## Installation
+
+```bash
+pip install opengradient
+```
+
+Note: Windows users should temporarily enable WSL when installing `opengradient` (fix in progress).
+
+## Getting Started
+
+### 1. Account Setup
+
+You'll need two accounts to use the SDK:
+- **Model Hub account**: Create one at [Hub Sign Up](https://hub.opengradient.ai/signup)
+- **OpenGradient account**: Use an existing Ethereum-compatible wallet or create a new one via SDK
+
+The easiest way to set up your accounts is through our configuration wizard:
+
+```bash
+opengradient config init
+```
+
+This wizard will:
+- Guide you through account creation
+- Help you set up credentials
+- Direct you to our Test Faucet for devnet tokens
+
+### 2. Initialize the SDK
+
+```python
+import opengradient as og
+og.init(private_key="<private_key>", email="<email>", password="<password>")
+```
+
+### 3. Basic Usage
+
+Browse available models on our [Model Hub](https://hub.opengradient.ai/) or create and upload your own:
+
+
+```python
+# Create and upload a model
+og.create_model(
+    model_name="my-model",
+    model_desc="Model description",
+    model_path="/path/to/model"
+)
+
+# Run inference
+inference_mode = og.InferenceMode.VANILLA
+result = og.infer(
+    model_cid="your-model-cid",
+    model_inputs={"input": "value"},
+    inference_mode=inference_mode
+)
+```
+
+### 4. Examples
+
+See code examples under [examples](./examples).
+
+## CLI Usage
+
+The SDK includes a command-line interface for quick operations. First, verify your configuration:
+
+```bash
+opengradient config show
+```
+
+Run a test inference:
+
+```bash
+opengradient infer -m QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ \
+    --input '{"num_input1":[1.0, 2.0, 3.0], "num_input2":10}'
+```
+
+## Use Cases
+
+1. **Off-chain Applications**: Use OpenGradient as a decentralized alternative to centralized AI providers like HuggingFace and OpenAI.
+
+2. **Model Development**: Manage models on the Model Hub and integrate directly into your development workflow.
+
+## Documentation
+
+For comprehensive documentation, API reference, and examples, visit:
+- [OpenGradient Documentation](https://docs.opengradient.ai/)
+- [API Reference](https://docs.opengradient.ai/api_reference/python_sdk/)
+
+## Support
+
+- Run `opengradient --help` for CLI command reference
+- Visit our [documentation](https://docs.opengradient.ai/) for detailed guides
+- Join our [community](https://.opengradient.ai/) for support

opengradient-0.4.8.dist-info/RECORD

@@ -0,0 +1,29 @@
+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=q6Md6uleBl8h2Vkz1tjYrovFrg7_Lm0CWDMhymZmPzE,43773
+opengradient/defaults.py,sha256=Dqc64Qv7RdLv7ZBjXzvxRRqBDc1HhyVbbdImpmzyrzU,490
+opengradient/exceptions.py,sha256=88tfegboGtlehQcwhxsl6ZzhLJWZWlkf_bkHTiCtXpo,3391
+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
+opengradient/abi/inference.abi,sha256=MR5u9npZ-Yx2EqRW17_M-UnGgFF3mMEMepOwaZ-Bkgc,7040
+opengradient/alphasense/__init__.py,sha256=Ah6IpoPTb6UkY7ImOWLJs3tjlxDJx6vZVR7p5IwP_Ks,292
+opengradient/alphasense/read_workflow_tool.py,sha256=ojCf-eMO6e0ib77nqjgEJtXxTxdLZmc_-MvyRemYFY0,3216
+opengradient/alphasense/run_model_tool.py,sha256=_Yh143Cq6zVlNMhBot30GwCR3Zbi6G1PK1nViU50lfA,5002
+opengradient/alphasense/types.py,sha256=uxk4JQKbaS2cM3ZiKpdHQb234OJ5ylprNR5vi01QFzA,220
+opengradient/bin/PriceHistoryInference.bin,sha256=nU2FZpGHIKBZ7NSK9Sr-p9lr-nXja_40ISPN9yckDq8,41276
+opengradient/llm/__init__.py,sha256=eYFBrOf1GZr0VGbIw-gSFr8hM3Rbw74ye8l-pnBPNuA,1104
+opengradient/llm/og_langchain.py,sha256=Dn17DtsKnlJ1h7Q_2jx3MR9QJ6nzRnvrDisVBV_OvH4,4816
+opengradient/llm/og_openai.py,sha256=26W_NDnLaICIaWbi9aou40v5ZJXLlmLdztDrdFoDGAU,3789
+opengradient/proto/__init__.py,sha256=AhaSmrqV0TXGzCKaoPV8-XUvqs2fGAJBM2aOmDpkNbE,55
+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.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.6.dist-info → opengradient-0.4.8.dist-info}/WHEEL

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

opengradient/abi/ModelExecutorHistorical.abi

@@ -1 +0,0 @@
-[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"caller","type":"address"},{"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[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"value","type":"string"}],"internalType":"struct TensorLib.JsonScalar[]","name":"jsons","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"indexed":false,"internalType":"struct ModelOutput","name":"result","type":"tuple"}],"name":"InferenceResultEmitted","type":"event"},{"inputs":[],"name":"getInferenceResult","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[]"},{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"value","type":"string"}],"internalType":"struct TensorLib.JsonScalar[]","name":"jsons","type":"tuple[]"},{"internalType":"bool","name":"is_simulation_result","type":"bool"}],"internalType":"struct ModelOutput","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"historicalContract","outputs":[{"internalType":"contract OGHistorical","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"run","outputs":[],"stateMutability":"nonpayable","type":"function"}]

opengradient-0.4.6.dist-info/METADATA

@@ -1,189 +0,0 @@
-Metadata-Version: 2.2
-Name: opengradient
-Version: 0.4.6
-Summary: Python SDK for OpenGradient decentralized model management & inference services
-Author-email: OpenGradient <oliver@opengradient.ai>
-License: MIT License
-        
-        Copyright (c) 2024 OpenGradient
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://opengradient.ai
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: eth-account>=0.13.4
-Requires-Dist: web3>=7.3.0
-Requires-Dist: click>=8.1.7
-Requires-Dist: firebase-rest-api>=1.11.0
-Requires-Dist: grpcio>=1.66.2
-Requires-Dist: numpy>=1.26.4
-Requires-Dist: requests>=2.32.3
-Requires-Dist: langchain>=0.3.7
-Requires-Dist: openai>=1.58.1
-Requires-Dist: pydantic>=2.9.2
-
-# 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(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>")
-```
-
-### Create a Model (with file upload)
-```python
-og.create_model(model_name="<model_name>", model_desc="<model_description>", model_path="<model_path>")
-```
-
-### Create a Version of a Model
-```python
-og.create_version(model_name="<model_name>", notes="<model_notes>")
-```
-
-### Upload Files to a Model
-```python
-og.upload(model_path="<model_path>", model_name="<model_name>", version="<version>")
-```
-
-### List Files of a Model Version
-```python
-og.list_files(model_name="<model_name>", version="<version>")
-```
-
-### Run Inference
-```python
-inference_mode = og.InferenceMode.VANILLA
-og.infer(model_cid, model_inputs, inference_mode)
-```
- - inference mode can be `VANILLA`, `ZKML`, or `TEE`
-
-### LLM Inference
-#### LLM Completion
-```python
-tx_hash, response = og.llm_completion(
-    model_cid='meta-llama/Meta-Llama-3-8B-Instruct',
-    prompt="Translate the following English text to French: 'Hello, how are you?'",
-    max_tokens=50,
-    temperature=0.0
-)
-``` 
-
-#### LLM Chat
-```python
-# create messages history
-messages = [
-    {
-        "role": "system",
-        "content": "You are a helpful AI assistant.",
-        "name": "HAL"
-    },
-    {
-        "role": "user",
-        "content": "Hello! How are you doing? Can you repeat my name?",
-    }]
-
-# run LLM inference
-tx_hash, finish_reason, message = og.llm_chat(
-  model_cid=og.LLM.MISTRAL_7B_INSTRUCT_V3,
-  messages=messages
-)
-```
-
-
-
-## Using the CLI
-
-```bash
-export OPENGRADIENT_EMAIL="<email>"
-export OPENGRADIENT_PASSWORD="<password>"
-```
-
-#### Creating a Model Repo
-```bash
-opengradient create_model_repo "<model_name>" "<description>" 
-```
-- creating a model automatically initializes version `v0.01`
-
-#### Creating a Version
-```bash
-opengradient create_model_repo "<model_name>" "<description>" 
-```
-
-#### Upload a File
-```bash
-opengradient upload "<model_path>" "<model_name>" "<version>" 
-```
-
-#### List Files of a Model Version
-```bash
-opengradient list_files "<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
-```
-
-#### Run LLM Inference
-We also have explicit support for using LLMs through the completion and chat commands in the CLI.
-
-For example, you can run a competion inference with Llama-3 using the following command:
-
-``` bash
-opengradient completion --model "meta-llama/Meta-Llama-3-8B-Instruct" --prompt "hello who are you?" --max-tokens 50
-```
-
-Or you can use files instead of text input in order to simplify your command:
-
-```bash
-opengradient chat --model "mistralai/Mistral-7B-Instruct-v0.3" --messages-file messages.json --tools-file tools.json --max-tokens 200
-```
-
-For more information read the OpenGradient [documentation](https://docs.opengradient.ai/).