opengradient 0.3.18__py3-none-any.whl → 0.3.21__py3-none-any.whl

opengradient/__init__.py

@@ -7,9 +7,9 @@ from typing import Dict, List, Optional, Tuple
 from .client import Client
 from .defaults import DEFAULT_INFERENCE_CONTRACT_ADDRESS, DEFAULT_RPC_URL
 from .types import InferenceMode, LlmInferenceMode, LLM, TEE_LLM
-from . import llm
 
-__version__ = "0.3.18"
+from . import llm
+from . import mltools
 
 _client = None
 
@@ -241,7 +241,7 @@ def generate_image(model: str, prompt: str, height: Optional[int] = None, width:
 
 __all__ = [
     'generate_image',
-    'list_files'
+    'list_files',
     'login',
     'llm_chat',
     'llm_completion',
@@ -261,6 +261,7 @@ __pdoc__ = {
     'defaults': False,
     'exceptions': False,
     'llm': True,
+    'mltools': True,
     'proto': False,
     'types': False,
     'utils': False

opengradient/llm/og_langchain.py

@@ -17,7 +17,7 @@ from langchain_core.callbacks.manager import CallbackManagerForLLMRun
 from langchain_core.tools import BaseTool
 from langchain_core.messages import ToolCall
 
-from opengradient import Client
+from opengradient import Client, LlmInferenceMode
 from opengradient.defaults import DEFAULT_RPC_URL, DEFAULT_INFERENCE_CONTRACT_ADDRESS
 
 
@@ -99,7 +99,8 @@ class OpenGradientChatModel(BaseChatModel):
             messages=sdk_messages,
             stop_sequence=stop,
             max_tokens=self.max_tokens,
-            tools=self.tools
+            tools=self.tools,
+            inference_mode=LlmInferenceMode.VANILLA
         )
 
         if "tool_calls" in chat_response and chat_response["tool_calls"]:

opengradient/llm/og_openai.py

@@ -4,7 +4,6 @@ from opengradient.defaults import DEFAULT_RPC_URL, DEFAULT_INFERENCE_CONTRACT_AD
 
 from typing import List
 import time
-import json
 import uuid
 
 class OGCompletions(object):

opengradient/mltools/__init__.py

@@ -0,0 +1,14 @@
+"""
+OpenGradient AlphaSense Tools
+"""
+
+from .model_tool import *
+
+__all__ = [
+    'create_og_model_tool',
+    'ToolType'
+]
+
+__pdoc__ = {
+    'model_tool': False
+}

opengradient/mltools/model_tool.py

@@ -0,0 +1,129 @@
+from enum import Enum
+from typing import Callable, Dict, Any, Type
+
+from pydantic import BaseModel
+from langchain_core.tools import BaseTool, StructuredTool
+import opengradient as og
+
+class ToolType(str, Enum):
+    """Indicates the framework the tool is compatible with."""
+
+    LANGCHAIN = "langchain"
+    SWARM = "swarm"
+    
+    def __str__(self) -> str:
+        return self.value
+
+def create_og_model_tool(
+    tool_type: ToolType,
+    model_cid: str, 
+    tool_name: str,
+    input_getter: Callable,
+    output_formatter: Callable[..., str],
+    input_schema: Type[BaseModel] = None,
+    tool_description: str = "Executes the given ML model", 
+    inference_mode: og.InferenceMode= og.InferenceMode.VANILLA) -> BaseTool:
+    """
+    Creates a tool that wraps an OpenGradient model for inference.
+
+    This function generates a tool that can be integrated into either a LangChain pipeline
+    or a Swarm system, allowing the model to be executed as part of a chain of operations.
+    The tool uses the provided input_getter function to obtain the necessary input data and
+    runs inference using the specified OpenGradient model.
+
+    Args:
+        tool_type (ToolType): Specifies the framework to create the tool for. Use 
+            ToolType.LANGCHAIN for LangChain integration or ToolType.SWARM for Swarm
+            integration. 
+        model_cid (str): The CID of the OpenGradient model to be executed.
+        tool_name (str): The name to assign to the created tool. This will be used to identify
+            and invoke the tool within the agent.
+        input_getter (Callable): A function that returns the input data required by the model.
+            The function should return data in a format compatible with the model's expectations.
+        output_formatter (Callable[..., str]): A function that takes the model output and 
+            formats it into a string. This is required to ensure the output is compatible
+            with the tool framework.
+        input_schema (Type[BaseModel], optional): A Pydantic BaseModel class defining the
+            input schema. This will be used directly for LangChain tools and converted
+            to appropriate annotations for Swarm tools. Default is None.
+        tool_description (str, optional): A description of what the tool does. Defaults to
+            "Executes the given ML model".
+        inference_mode (og.InferenceMode, optional): The inference mode to use when running
+            the model. Defaults to VANILLA.
+
+    Returns:
+        BaseTool: For ToolType.LANGCHAIN, returns a LangChain StructuredTool.
+        Callable: For ToolType.SWARM, returns a decorated function with appropriate metadata.
+
+    Raises:
+        ValueError: If an invalid tool_type is provided.
+
+    Examples:
+        >>> from pydantic import BaseModel, Field
+        >>> class ClassifierInput(BaseModel):
+        ...     query: str = Field(description="User query to analyze")
+        ...     parameters: dict = Field(description="Additional parameters")
+        >>> def get_input():
+        ...     return {"text": "Sample input text"}
+        >>> def format_output(output):
+        ...     return str(output.get("class", "Unknown"))
+        >>> # Create a LangChain tool
+        >>> langchain_tool = create_og_model_tool(
+        ...     tool_type=ToolType.LANGCHAIN,
+        ...     model_cid="Qm...",
+        ...     tool_name="text_classifier",
+        ...     input_getter=get_input,
+        ...     output_formatter=format_output,
+        ...     input_schema=ClassifierInput
+        ...     tool_description="Classifies text into categories"
+        ... )
+    """
+    # define runnable
+    def model_executor(**llm_input):
+        # Combine LLM input with input provided by code
+        combined_input = {
+            **llm_input,
+            **input_getter()
+        }
+
+        _, output = og.infer(
+            model_cid=model_cid,
+            inference_mode=inference_mode,
+            model_input=combined_input
+        )
+
+        return output_formatter(output)
+
+    if tool_type == ToolType.LANGCHAIN:
+        return StructuredTool.from_function(
+            func=model_executor,
+            name=tool_name,
+            description=tool_description,
+            args_schema=input_schema
+        )
+    elif tool_type == ToolType.SWARM:
+        model_executor.__name__ = tool_name
+        model_executor.__doc__ = tool_description
+        # Convert Pydantic model to Swarm annotations if provided
+        if input_schema:
+            model_executor.__annotations__ = _convert_pydantic_to_annotations(input_schema)
+        return model_executor
+    else:
+        raise ValueError(f"Invalid tooltype: {tool_type}")
+
+def _convert_pydantic_to_annotations(model: Type[BaseModel]) -> Dict[str, Any]:
+    """
+    Convert a Pydantic model to function annotations format used by Swarm.
+    
+    Args:
+        model: A Pydantic BaseModel class
+        
+    Returns:
+        Dict mapping field names to (type, description) tuples
+    """
+    annotations = {}
+    for field_name, field in model.model_fields.items():
+        field_type = field.annotation
+        description = field.description or ""
+        annotations[field_name] = (field_type, description)
+    return annotations

{opengradient-0.3.18.dist-info → opengradient-0.3.21.dist-info}/METADATA

@@ -1,8 +1,7 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.2
 Name: opengradient
-Version: 0.3.18
+Version: 0.3.21
 Summary: Python SDK for OpenGradient decentralized model management & inference services
-Project-URL: Homepage, https://opengradient.ai
 Author-email: OpenGradient <oliver@opengradient.ai>
 License: MIT License
         
@@ -25,7 +24,8 @@ License: MIT License
         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.
-License-File: LICENSE
+        
+Project-URL: Homepage, https://opengradient.ai
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -33,104 +33,105 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
-Requires-Dist: aiohappyeyeballs==2.4.3
-Requires-Dist: aiohttp==3.10.8
-Requires-Dist: aiosignal==1.3.1
-Requires-Dist: annotated-types==0.7.0
-Requires-Dist: attrs==24.2.0
-Requires-Dist: bitarray==2.9.2
-Requires-Dist: cachecontrol==0.14.0
-Requires-Dist: cachetools==5.5.0
-Requires-Dist: certifi==2024.8.30
-Requires-Dist: cffi==1.17.1
-Requires-Dist: charset-normalizer==3.3.2
-Requires-Dist: ckzg==2.0.1
-Requires-Dist: cleo==2.1.0
-Requires-Dist: click==8.1.7
-Requires-Dist: cramjam==2.8.4
-Requires-Dist: crashtest==0.4.1
-Requires-Dist: cryptography==43.0.1
-Requires-Dist: cytoolz==0.12.3
-Requires-Dist: distlib==0.3.8
-Requires-Dist: dulwich==0.21.7
-Requires-Dist: eth-abi==5.1.0
-Requires-Dist: eth-account==0.13.4
-Requires-Dist: eth-hash==0.7.0
-Requires-Dist: eth-keyfile==0.8.1
-Requires-Dist: eth-keys==0.5.1
-Requires-Dist: eth-rlp==2.1.0
-Requires-Dist: eth-typing==5.0.0
-Requires-Dist: eth-utils==5.0.0
-Requires-Dist: fastjsonschema==2.20.0
-Requires-Dist: fastparquet==2024.5.0
-Requires-Dist: filelock==3.16.1
-Requires-Dist: firebase-rest-api==1.11.0
-Requires-Dist: frozenlist==1.4.1
-Requires-Dist: fsspec==2024.9.0
-Requires-Dist: google-api-core==2.20.0
-Requires-Dist: google-auth==2.35.0
-Requires-Dist: google-cloud-core==2.4.1
-Requires-Dist: google-cloud-firestore==2.19.0
-Requires-Dist: google-cloud-storage==2.18.2
-Requires-Dist: google-crc32c==1.6.0
-Requires-Dist: google-resumable-media==2.7.2
-Requires-Dist: googleapis-common-protos==1.65.0
-Requires-Dist: grpcio-tools==1.66.2
-Requires-Dist: grpcio==1.66.2
-Requires-Dist: hexbytes==1.2.1
-Requires-Dist: idna==3.10
-Requires-Dist: jaraco-classes==3.4.0
-Requires-Dist: jwcrypto==1.5.6
-Requires-Dist: keyring==24.3.1
-Requires-Dist: langchain==0.3.7
-Requires-Dist: more-itertools==10.5.0
-Requires-Dist: msgpack==1.1.0
-Requires-Dist: multidict==6.1.0
-Requires-Dist: openai==1.58.1
-Requires-Dist: packaging==24.1
-Requires-Dist: pandas==2.2.3
-Requires-Dist: parsimonious==0.10.0
-Requires-Dist: pathlib==1.0.1
-Requires-Dist: pexpect==4.9.0
-Requires-Dist: pkce==1.0.3
-Requires-Dist: pkginfo==1.11.1
-Requires-Dist: platformdirs==4.3.6
-Requires-Dist: proto-plus==1.24.0
-Requires-Dist: protobuf==5.28.2
-Requires-Dist: protobuf>=4.24.0
-Requires-Dist: ptyprocess==0.7.0
-Requires-Dist: pyarrow==17.0.0
-Requires-Dist: pyasn1-modules==0.4.1
-Requires-Dist: pyasn1==0.6.1
-Requires-Dist: pycparser==2.22
-Requires-Dist: pycryptodome==3.21.0
-Requires-Dist: pydantic-core==2.23.4
-Requires-Dist: pydantic==2.9.2
-Requires-Dist: pyproject-hooks==1.2.0
-Requires-Dist: python-dateutil==2.9.0.post0
-Requires-Dist: python-jwt==4.1.0
-Requires-Dist: pytz==2024.2
-Requires-Dist: pyunormalize==16.0.0
-Requires-Dist: rapidfuzz==3.10.0
-Requires-Dist: regex==2024.9.11
-Requires-Dist: requests-toolbelt==1.0.0
-Requires-Dist: requests==2.32.3
-Requires-Dist: rlp==4.0.1
-Requires-Dist: rsa==4.9
-Requires-Dist: shellingham==1.5.4
-Requires-Dist: six==1.16.0
-Requires-Dist: tomlkit==0.13.2
-Requires-Dist: toolz==0.12.1
-Requires-Dist: trove-classifiers==2024.9.12
-Requires-Dist: types-requests==2.32.0.20240914
-Requires-Dist: typing-extensions==4.12.2
-Requires-Dist: tzdata==2024.2
-Requires-Dist: urllib3==2.2.3
-Requires-Dist: web3==7.3.0
-Requires-Dist: websockets==13.1
-Requires-Dist: xattr==1.1.0
-Requires-Dist: yarl==1.13.1
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohappyeyeballs>=2.4.3
+Requires-Dist: aiohttp>=3.10.8
+Requires-Dist: aiosignal>=1.3.1
+Requires-Dist: annotated-types>=0.7.0
+Requires-Dist: attrs>=24.2.0
+Requires-Dist: bitarray>=2.9.2
+Requires-Dist: CacheControl>=0.14.0
+Requires-Dist: cachetools>=5.5.0
+Requires-Dist: certifi>=2024.8.30
+Requires-Dist: cffi>=1.17.1
+Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: ckzg>=2.0.1
+Requires-Dist: cleo>=2.1.0
+Requires-Dist: click>=8.1.7
+Requires-Dist: cramjam>=2.8.4
+Requires-Dist: crashtest>=0.4.1
+Requires-Dist: cryptography>=43.0.1
+Requires-Dist: cytoolz>=0.12.3
+Requires-Dist: distlib>=0.3.8
+Requires-Dist: dulwich>=0.21.7
+Requires-Dist: eth-account>=0.13.4
+Requires-Dist: eth-hash>=0.7.0
+Requires-Dist: eth-keyfile>=0.8.1
+Requires-Dist: eth-keys>=0.5.1
+Requires-Dist: eth-rlp>=2.1.0
+Requires-Dist: eth-typing>=5.0.0
+Requires-Dist: eth-utils>=5.0.0
+Requires-Dist: eth_abi>=5.1.0
+Requires-Dist: fastjsonschema>=2.20.0
+Requires-Dist: fastparquet>=2024.5.0
+Requires-Dist: filelock>=3.16.1
+Requires-Dist: firebase-rest-api>=1.11.0
+Requires-Dist: frozenlist>=1.4.1
+Requires-Dist: fsspec>=2024.9.0
+Requires-Dist: google-api-core>=2.20.0
+Requires-Dist: google-auth>=2.35.0
+Requires-Dist: google-cloud-core>=2.4.1
+Requires-Dist: google-cloud-firestore>=2.19.0
+Requires-Dist: google-cloud-storage>=2.18.2
+Requires-Dist: google-crc32c>=1.6.0
+Requires-Dist: google-resumable-media>=2.7.2
+Requires-Dist: googleapis-common-protos>=1.65.0
+Requires-Dist: grpcio>=1.66.2
+Requires-Dist: grpcio-tools>=1.66.2
+Requires-Dist: protobuf>=4.24.0
+Requires-Dist: hexbytes>=1.2.1
+Requires-Dist: idna>=3.10
+Requires-Dist: jaraco.classes>=3.4.0
+Requires-Dist: jwcrypto>=1.5.6
+Requires-Dist: keyring>=24.3.1
+Requires-Dist: langchain>=0.3.7
+Requires-Dist: more-itertools>=10.5.0
+Requires-Dist: msgpack>=1.1.0
+Requires-Dist: multidict>=6.1.0
+Requires-Dist: openai>=1.58.1
+Requires-Dist: packaging>=24.1
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: parsimonious>=0.10.0
+Requires-Dist: pathlib>=1.0.1
+Requires-Dist: pexpect>=4.9.0
+Requires-Dist: pkce>=1.0.3
+Requires-Dist: pkginfo>=1.11.1
+Requires-Dist: platformdirs>=4.3.6
+Requires-Dist: proto-plus>=1.24.0
+Requires-Dist: protobuf>=5.28.2
+Requires-Dist: ptyprocess>=0.7.0
+Requires-Dist: pyarrow>=17.0.0
+Requires-Dist: pyasn1>=0.6.1
+Requires-Dist: pyasn1_modules>=0.4.1
+Requires-Dist: pycparser>=2.22
+Requires-Dist: pycryptodome>=3.21.0
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: pydantic_core>=2.23.4
+Requires-Dist: pyproject_hooks>=1.2.0
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: python-jwt>=4.1.0
+Requires-Dist: pytz>=2024.2
+Requires-Dist: pyunormalize>=16.0.0
+Requires-Dist: RapidFuzz>=3.10.0
+Requires-Dist: regex>=2024.9.11
+Requires-Dist: requests>=2.32.3
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: rlp>=4.0.1
+Requires-Dist: rsa>=4.9
+Requires-Dist: shellingham>=1.5.4
+Requires-Dist: six>=1.16.0
+Requires-Dist: tomlkit>=0.13.2
+Requires-Dist: toolz>=0.12.1
+Requires-Dist: trove-classifiers>=2024.9.12
+Requires-Dist: types-requests>=2.32.0.20240914
+Requires-Dist: typing_extensions>=4.12.2
+Requires-Dist: tzdata>=2024.2
+Requires-Dist: urllib3>=2.2.3
+Requires-Dist: web3>=7.3.0
+Requires-Dist: websockets>=13.1
+Requires-Dist: xattr>=1.1.0
+Requires-Dist: yarl>=1.13.1
 
 # 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. 
@@ -272,4 +273,4 @@ Or you can use files instead of text input in order to simplify your command:
 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/).
+For more information read the OpenGradient [documentation](https://docs.opengradient.ai/).

{opengradient-0.3.18.dist-info → opengradient-0.3.21.dist-info}/RECORD

@@ -1,4 +1,4 @@
-opengradient/__init__.py,sha256=CRII5thG_vRVtEqyhc48IWgYwjif2S4kOBbBf6MgH8I,9262
+opengradient/__init__.py,sha256=rwR7EMpzimOALAPP5dQa_aNQNAntefJeGal7jCQ3Iqc,9283
 opengradient/account.py,sha256=2B7rtCXQDX-yF4U69h8B9-OUreJU4IqoGXG_1Hn9nWs,1150
 opengradient/cli.py,sha256=niN8tlLaiVEpdtkdWEUbxidG75nxrlb6mMUfUAIjiVw,26400
 opengradient/client.py,sha256=axMbfqAQ6OWq3sM_D4bGVWrpAd-15Ru-bOHJ6R6GruA,35197
@@ -8,14 +8,17 @@ opengradient/types.py,sha256=-lGWv_yfXMN48bbvARKIFrj1L0AotIwr2c7GOv1JBcI,2464
 opengradient/utils.py,sha256=lUDPmyPqLwpZI-owyN6Rm3QvUjOn5pLN5G1QyriVm-E,6994
 opengradient/abi/inference.abi,sha256=MR5u9npZ-Yx2EqRW17_M-UnGgFF3mMEMepOwaZ-Bkgc,7040
 opengradient/llm/__init__.py,sha256=J1W_AKPntqlDqLeflhn2x7A0i-dkMT-ol3jlEdFgMWU,1135
-opengradient/llm/og_langchain.py,sha256=F32yN1o8EvRbzZSJkUwI0-FmSVAWMuMTI9ho7wgW5hk,4470
-opengradient/llm/og_openai.py,sha256=GilEkIVDac5Cacennb7YNXD6BKwUj69mfnMkvxkiW5Y,3865
+opengradient/llm/og_langchain.py,sha256=-QBGFdQJ1cdSCTUUerajHXNvV5Xi9yaVpa3BeAqKZbQ,4541
+opengradient/llm/og_openai.py,sha256=3oaQOQnA7RzQ-LcFw-AQRn2RON8tsprSa9bGtyD88OE,3853
+opengradient/mltools/__init__.py,sha256=cfzf6lZmqLNN1efa5K_pCa7k1D5PnRkB6LNyJ9UeJvk,162
+opengradient/mltools/model_tool.py,sha256=q1k3Zq7jmRe-8HqP_-ia-p7ocDRcSn18T4gbNM9xlD0,5237
 opengradient/proto/__init__.py,sha256=AhaSmrqV0TXGzCKaoPV8-XUvqs2fGAJBM2aOmDpkNbE,55
 opengradient/proto/infer.proto,sha256=13eaEMcppxkBF8yChptsX9HooWFwJKze7oLZNl-LEb8,1217
 opengradient/proto/infer_pb2.py,sha256=wg2vjLQCNv6HRhYuIqgj9xivi3nO4IPz6E5wh2dhDqY,3446
 opengradient/proto/infer_pb2_grpc.py,sha256=y5GYwD1EdNs892xx58jdfyA0fO5QC7k3uZOtImTHMiE,6891
-opengradient-0.3.18.dist-info/METADATA,sha256=eH1-0CRuheW8Ho8mMbiivn2WIrgAKZf37c4zlFMloes,8744
-opengradient-0.3.18.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-opengradient-0.3.18.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
-opengradient-0.3.18.dist-info/licenses/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
-opengradient-0.3.18.dist-info/RECORD,,
+opengradient-0.3.21.dist-info/LICENSE,sha256=xEcvQ3AxZOtDkrqkys2Mm6Y9diEnaSeQRKvxi-JGnNA,1069
+opengradient-0.3.21.dist-info/METADATA,sha256=YWusI2vSVVDeXxCp7NBwqEWlEfsPI4Y93sHs1ISKWs4,8754
+opengradient-0.3.21.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+opengradient-0.3.21.dist-info/entry_points.txt,sha256=yUKTaJx8RXnybkob0J62wVBiCp_1agVbgw9uzsmaeJc,54
+opengradient-0.3.21.dist-info/top_level.txt,sha256=oC1zimVLa2Yi1LQz8c7x-0IQm92milb5ax8gHBHwDqU,13
+opengradient-0.3.21.dist-info/RECORD,,

{opengradient-0.3.18.dist-info → opengradient-0.3.21.dist-info}/WHEEL

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

opengradient-0.3.21.dist-info/top_level.txt

@@ -0,0 +1 @@
+opengradient